VintaSoft Imaging .NET SDK 14.0: Документация для Веб разработчика
В этом разделе
    Добавление веб редактора электронных таблиц в "React + ASP.NET Core" приложение.
    В этом разделе
    В этом руководстве показано, как создать пустое "React + ASP.NET Core" приложение в Visual Studio .NET 2022 и добавить редактор электронных таблиц (с возможностью открывать, редактировать и сохранять документы электронных таблиц (XLSX)) в "React + ASP.NET Core" приложение.

    Вот шаги, которые необходимо выполнить:

    1. Создайте пустое "React + ASP.NET Core" приложение.

      • Откройте Visual Studio .NET 2022 и создайте новое приложение типа "React + ASP.NET Core":

      • Настройте приложение для использования .NET 8.0:

    2. Серверная часть: Добавьте ссылки на .NET-сборки Vintasoft в проект "ReactApp1.Server".

      Скопируйте файлы Vintasoft.Shared.dll, Vintasoft.Imaging.dll, Vintasoft.Imaging.Office.OpenXml, Vintasoft.Shared.Web.dll, Vintasoft.Imaging.Web.Services.dll, Vintasoft.Imaging.Office.Web.Services.dll, Vintasoft.Imaging.AspNetCore.ApiControllers.dll и Vintasoft.Imaging.Office.AspNetCore.ApiControllers.dll из папки "<SdkInstallPath>\VintaSoft Imaging .NET 14.0\Bin\DotNet8\AnyCPU\" в папку "Bin" проекта "ReactApp1.Server" и добавьте ссылки на .NET-сборки в проект "ReactApp1.Server".



    3. Серверная сторона: Укажите движок рисования, который должен использоваться VintaSoft Imaging .NET SDK для рисования 2D-графики.

      Если проект "ReactApp1.Server" необходимо использовать в Windows или Linux, следует использовать движок рисования SkiaSharp.
      Если проект "ReactApp1.Server" необходимо использовать только в Windows, следует использовать движок рисования System.Drawing или SkiaSharp.

      Вот шаги, которые необходимо выполнить для использования движка SkiaSharp:
      • Добавьте ссылку на .NET-сборку Vintasoft.Imaging.Drawing.SkiaSharp.dll.
      • Добавьте ссылку на nuget-пакет SkiaSharp версии 2.88.9.
      • Откройте файл "Program.cs" в проекте "ReactApp1.Server", добавьте строку кода "Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();" в начало файла - добавленный код указывает, что VintaSoft Imaging .NET SDK должен использовать библиотеку SkiaSharp для рисования 2D-графики.

      Вот шаги, которые необходимо выполнить для использования движка System.Drawing:
      • Добавьте ссылку на .NET-сборку Vintasoft.Imaging.Gdi.dll.
      • Откройте "Program.cs" в проекте "ReactApp1.Server", добавьте строку кода "Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();" в начало файла - добавленный код указывает, что VintaSoft Imaging .NET SDK должен использовать System.Drawing библиотека для рисования 2D-графики

    4. Серверная сторона: Создайте веб сервисы, позволяющие загружать/скачивать файлы и редактировать документы XLSX.

      • Создайте веб сервис, позволяющий загружать/скачивать файл

        • Нажмите правую кнопку мыши на папке "Controllers" и выберите меню "Add => Controller..." из контекстного меню
        • Выберите шаблон "Empty API controller", установите имя контроллера "MyVintasoftFileApiController" и нажмите кнопку "Add".
        • Укажите, что класс MyVintasoftFileApiController является производным от класса Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftFileApiController

          Вот исходные коды класса MyVintasoftFileApiController: 
          namespace ReactApp1.Server.Controllers
{
    public class MyVintasoftFileApiController : Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftFileApiController
    {

        public MyVintasoftFileApiController(IWebHostEnvironment hostingEnvironment)
            : base(hostingEnvironment)
        {
        }

    }
}

      • Создать веб сервис, позволяющий редактировать XLSX документ.

        • Нажмите правую кнопку мыши на папке "Controllers" и выберите меню "Add => Controller..." из контекстного меню
        • Выберите шаблон "Empty API controller", установите имя контроллера "MyVintasoftOfficeApiController" и нажмите кнопку "Add"
        • Укажите, что класс MyVintasoftOfficeApiController является производным от класса Vintasoft.Imaging.Office.AspNetCore.ApiControllers.VintasoftOfficeApiController

          Вот исходные коды класса MyVintasoftOfficeApiController: 
          namespace ReactApp1.Server.Controllers
{
    public class MyVintasoftOfficeApiController : Vintasoft.Imaging.Office.AspNetCore.ApiControllers.VintasoftOfficeApiController
    {
        public MyVintasoftOfficeApiController(IWebHostEnvironment hostingEnvironment)
            : base(hostingEnvironment)
        {
        }
    }
}

    5. Серверная сторона: Создайте CORS-политику, позволяющую получать доступ к веб сервисам из клиентского приложения.

      • Откройте файл "Program.cs" в проекте "ReactApp1.Server" и добавьте код, который:
        • Создает CORS-политику, которая позволяет получать доступ к веб сервисам с веб сервера "localhost"
        • Включает использование CORS в проекте "ReactApp1.Server"

        Вот исходные коды файла "Program.cs" после обновления: 
        Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();

builder.Services.AddCors(options =>
{
    options.AddPolicy(name: "CorsPolicy1", policy =>
    {
        policy.SetIsOriginAllowed(origin => new Uri(origin).Host == "localhost").AllowAnyHeader().AllowAnyMethod();
    });
});

var app = builder.Build();

app.UseDefaultFiles();
app.UseStaticFiles();

// Configure the HTTP request pipeline.

app.UseHttpsRedirection();

app.UseAuthorization();

app.UseCors("CorsPolicy1");

app.MapControllers();

app.MapFallbackToFile("/index.html");

app.Run();

    6. Серверная сторона: Обновите стартовый URL-адрес приложения в файле "launchSettings.json".

      • Откройте файл "Properties\launchSettings.json" в "ReactApp1.Server" и очистите стартовый URL-адрес приложения:

    7. Серверная сторона: Скопируйте XLSX-документы на серверную сторону.

      • Создайте папку "UploadedImageFiles\SessionID" в проекте "ReactApp1.Server" и скопируйте тестовый XLSX документ "<SdkInstallPath>\VintaSoft\Imaging .NET 14.0\Examples\ASP.NET Core\CSharp\AspNetCoreSpreadsheetEditorDemo\wwwroot\UploadedImageFiles\SalesReport.xlsx" в папку "UploadedImageFiles\SessionID". Этот документ будет отображен в веб редакторе электронных таблиц.

      • Создайте папку "Resources" в проекте "ReactApp1.Server" и скопируйте XLSX-документ "<SdkInstallPath>\VintaSoft\Imaging .NET 14.0\Examples\ASP.NET Core\CSharp\AspNetCoreSpreadsheetEditorDemo\wwwroot\Resources\ChartSource.xlsx" в папку "Resources". Этот документ будет использоваться в качестве источника для "стандартных" диаграмм при добавлении диаграммы в документ электронных таблиц с помощью UI-диалога "Add chart".

    8. Скомпилируйте проект для восстановления зависимостей с помощью 'npm'

    9. Удалите файлы, которые не нужны в этом руководстве.

      • Удалите файлы "WeatherForecast.cs" и "Controllers\WeatherForecastController.cs" в проекте "ReactApp1.Server" - ASP.NET Core Web API контроллер WeatherForecast не требуется в этом руководстве.

      • Удалите файлы "src\App.css" и "src\App.jsx" - этот React-компонент не требуется в этом руководстве.

    10. Клиентская сторона: Добавьте JavaScript-файлы в проект "reactapp1.client".

      • Скопируйте файлы Vintasoft.Shared.js, Vintasoft.Imaging.js и Vintasoft.Imaging.Office.js из папки "<SdkInstallPath>\VintaSoft Imaging .NET 14.0\Bin\JavaScript" в папку "public".

      • Укажите, какие "стандартные" UI-диалоги (UI-диалог переименования рабочего листа, UI-диалог поиска текста и т. д.) должны использоваться веб редактором электронных таблиц.
        • Если веб редактор электронных таблиц должен использовать готовые к использованию "стандартные" UI-диалоги Bootstrap:
          • Добавьте Node-модуль "bootstrap" в файл "package.json". Пересоберите проект для обновления Node-модулей.
            Вот исходные коды файла "package.json" после обновления: 
            {
  "name": "reactapp1.client",
  "private": true,
  "version": "0.0.0",
  "type": "module",
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
    "preview": "vite preview"
  },
  "dependencies": {
    "react": "^18.2.0",
    "react-dom": "^18.2.0",
    "bootstrap": "5.3.3"
  },
  "devDependencies": {
    "@types/react": "^18.2.66",
    "@types/react-dom": "^18.2.22",
    "@vitejs/plugin-react": "^4.2.1",
    "eslint": "^8.57.0",
    "eslint-plugin-react": "^7.34.1",
    "eslint-plugin-react-hooks": "^4.6.0",
    "eslint-plugin-react-refresh": "^0.4.6",
    "vite": "^5.2.0"
  }
}
          • Скопируйте файлы Vintasoft.Imaging.Dialogs.Bootstrap.js и Vintasoft.Imaging.Office.Dialogs.Bootstrap.js из "<SdkInstallPath>\VintaSoft Imaging .NET 14.0\Bin\JavaScript\" папку в папку "public\".

        • Если веб редактор электронных таблиц должен использовать готовые к использованию "стандартные" UI-диалоги jQuery UI:
          • Добавьте Node-модуль "jquery-ui-dist" в файл "package.json". Пересоберите проект для обновления Node-модулей.
          • Скопируйте файлы Vintasoft.Imaging.Dialogs.jQueryUI.js, Vintasoft.Imaging.Dialogs.jQueryUI.d.ts, Vintasoft.Imaging.Office.Dialogs.jQueryUI.js и Vintasoft.Imaging.Office.Dialogs.jQueryUI.d.ts из папки "<SdkInstallPath>\VintaSoft Imaging .NET 14.0\Bin\JavaScript\" в папку "src\app\assets\".

        • Если веб редактор электронных таблиц должен использовать пользовательские "стандартные" UI-диалоги, прочтите, как создавать пользовательские "стандартные" UI-диалоги здесь .

      • Скопируйте файлы Vintasoft.Imaging.css и Vintasoft.Imaging.Office.css из папки "<SdkInstallPath>\VintaSoft\Imaging .NET 14.0\Bin\JavaScript" в папку "public\".

      • Добавьте ссылки на Bootstrap CSS-файл и Vintasoft CSS-файлы в файл "index.html", добавбте ссылки на Vintasoft JavaScript-файлы в заголовок файла "index.html":


        Вот исходные коды файла "index.html": 
        <!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8" />
    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Vite + React</title>

    <link rel="stylesheet" type="text/css" href="node_modules/bootstrap/dist/css/bootstrap.css" />
    <link rel="stylesheet" type="text/css" href="public/Vintasoft.Imaging.css">
    <link rel="stylesheet" type="text/css" href="public/Vintasoft.Imaging.Office.css">
    <link rel="stylesheet" type="text/css" href="src/SpreadsheetDocumentEditorDemo.css">

    <script src="public/Vintasoft.Shared.js" type="text/javascript"></script>
    <script src="public/Vintasoft.Imaging.js" type="text/javascript"></script>
    <script src="public/Vintasoft.Imaging.Office.js" type="text/javascript"></script>
    <script src="public/Vintasoft.Imaging.Dialogs.Bootstrap.js" type="text/javascript"></script>
    <script src="public/Vintasoft.Imaging.Office.Dialogs.Bootstrap.js" type="text/javascript"></script>
</head>
  <body>
    <div id="root"></div>
    <script type="module" src="/src/main.jsx"></script>
  </body>
</html>

      • Добавьте CSS-стиль "spreadsheetDocumentEditorContainer", который определяет высоту контейнера веб редактора электронных таблиц, в файл "src\SpreadsheetDocumentEditorDemo.css":


        Вот исходные коды файла "SpreadsheetDocumentEditorDemo.css": 
        h1 {
    text-align: center;
}

.spreadsheetDocumentEditorContainer {
    height: 800px;
}

    11. Client сторона: Создайте React-компонент, позволяющий редактировать документ электронных таблиц (XLSX).

      • Создать файл "SpreadsheetEditorDemo.jsx", который будет содержать исходные коды React-компонента (класс SpreadsheetEditorDemo):
        • Выберите контекстное меню "Add => New Item..." для папкb "src\" => Появится UI-диалог "Add new item"
        • Выберите тип "JSX-файл" для нового элемента
        • Установите "SpreadsheetEditorDemo.jsx" в качестве имени элемента
        • Нажмите кнопку "Add" => UI-диалог закроется и файл " SpreadsheetEditorDemo.jsx" будет добавлен в папку "src\"

        Добавьте объявление класса SpreadsheetEditorDemo с функцией 'render' (отображает заголовок приложения и div-элемент, который будет отображать веб редактор электронных таблиц) в файл "SpreadsheetEditorDemo.jsx":


        Добавьте функцию 'componentDidMount' (содержит JavaScript-код, который инициализирует и создает веб редактор электронных таблиц) в класс SpreadsheetEditorDemo:


        Вот JavaScript-код файла "SpreadsheetEditorDemo.jsx": 
        import { Component } from 'react';

export class SpreadsheetDocumentEditorDemo extends Component {
    static displayName = SpreadsheetDocumentEditorDemo.name;
    static _isInitialized = false;

    render() {
        return (
            <div>
                <h1>VintaSoft Spreadsheet Document Editor (React + ASP.NET Core)</h1>

                <div id="spreadsheetDocumentEditorContainer" className="spreadsheetDocumentEditorContainer"></div>
            </div>
        );
    }

    componentDidMount() {
        if (this._isInitialized)
            return;
        this._isInitialized = true;

        var Vintasoft = window.Vintasoft;

        // set the session identifier
        Vintasoft.Shared.WebImagingEnviromentJS.set_SessionId("SessionId");

        // specify web services, which should be used in this demo
        Vintasoft.Shared.WebServiceJS.defaultFileService = new Vintasoft.Shared.WebServiceControllerJS("https://localhost:7167/vintasoft/api/MyVintasoftFileApi");
        Vintasoft.Shared.WebServiceJS.defaultOfficeService = new Vintasoft.Shared.WebServiceControllerJS("https://localhost:7167/vintasoft/api/MyVintasoftOfficeApi");

        // create the spreadsheet document editor control settings
        var spreadsheetDocumentEditorControlSettings = new Vintasoft.Imaging.Office.UI.WebSpreadsheetDocumentEditorControlSettingsJS("spreadsheetDocumentEditorContainer", "");

        // create the spreadsheet document editor control
        var spreadsheetDocumentEditorControl = new Vintasoft.Imaging.Office.UI.WebSpreadsheetDocumentEditorControlJS(spreadsheetDocumentEditorControlSettings);

        // subscribe to the "warningOccured" event of spreadsheet document editor control
        Vintasoft.Shared.subscribeToEvent(spreadsheetDocumentEditorControl, "warningOccured", this.__spreadsheetDocumentEditorControl_warningOccured);

        var fileId = "SalesReport.xlsx";
        // copy the file from global folder to the session folder
        spreadsheetDocumentEditorControl.openDocument(fileId);
    }

    __spreadsheetDocumentEditorControl_warningOccured(event, eventArgs) {
        // show the error message
        alert(eventArgs.message);
    }

}

      • Добавьте созданный React-компонент в код React-приложения - "src\main .jsx-файл.


        Вот исходные коды файла "main.jsx" после обновления: 
        import React from 'react'
import ReactDOM from 'react-dom/client'
import { SpreadsheetDocumentEditorDemo } from './SpreadsheetDocumentEditorDemo.jsx'
import './index.css'

ReactDOM.createRoot(document.getElementById('root')).render(
    <React.StrictMode>
        <SpreadsheetDocumentEditorDemo />
    </React.StrictMode>,
)

    12. Запустите "React + ASP.NET Core" приложение и посмотрите результат.



     

     

    Копирайт © 2007-2025 ООО "ВинтаСофт". Все права защищены.

    Отправить отзыв