VintaSoft Imaging .NET SDK 15.1: Документация для Веб разработчика
В этом разделе
Добавление веб редактора документа в ASP.NET MVC5 приложение
В этом разделе
В этом руководстве показано, как создать пустое веб-приложение ASP.NET в Visual Studio .NET 2019 и добавить веб редактор документа (с возможностью открытия, редактирования и сохранения документов DOCX) в веб-приложение ASP.NET MVC5.

Вот шаги, которые необходимо выполнить:
  1. Создайте пустое ASP.NET MVC5 приложение.

    Откройте Visual Studio .NET 2019, создайте новый проект типа "ASP.NET Web Application" и настройте его для использования .NET Framework 4.7.2:

    Выберите шаблон "Empty" для ASP.NET веб-приложения и настройте новый проект для использования Web API:

  2. Серверная сторона: Добавьте ссылки на .NET-сборки Vintasoft в ASP.NET MVC5 приложение.

    Добавьте ссылки на сборки Vintasoft.Shared.dll, Vintasoft.Imaging.dll, Vintasoft.Imaging.Pdf.dll, Vintasoft.Imaging.Office.OpenXml.dll, Vintasoft.Shared.Web.dll, Vintasoft.Imaging.Web.Services.dll, Vintasoft.Imaging.Office.Web.Services.dll, Vintasoft.Imaging.Web.Api2Controllers.dll, Vintasoft.Imaging.Office.Web.Api2Controllers.dll из папки "<SdkInstallPath>\VintaSoft Imaging .NET 15.1\Bin\DotNet4\AnyCPU\" в ASP.NET MVC5 приложение.



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

    ASP.NET MVC5 приложение должно использовать библиотеку System.Drawing в качестве графического движка, поскольку ASP.NET MVC5 приложение может использоваться только в Windows.

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

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

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

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

        Вот исходные коды класса MyVintasoftFileApiController:
        namespace WebApplication4.Controllers
        {
            public class MyVintasoftFileApiController : Vintasoft.Imaging.Web.Api2Controllers.VintasoftFileApi2Controller
            {
        
                public MyVintasoftFileApiController()
                    : base()
                {
                }
        
        
        
                public override bool IsEmptySessionSupported
                {
                    get { return true; }
                }
        
            }
        }
        
        

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

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

        Вот исходные коды класса MyVintasoftOfficeApiController:
        namespace WebApplication4.Controllers
        {
            public class MyVintasoftOfficeApiController : Vintasoft.Imaging.Office.Web.Api2Controllers.VintasoftOfficeApi2Controller
            {
        
                public MyVintasoftOfficeApiController()
                    : base()
                {
                }
        
        
        
                public override bool IsEmptySessionSupported
                {
                    get { return true; }
                }
        
            }
        }
        
        

    • Откройте файл "App_Start\WebApiConfig.cs" и проверьте, правильно ли ASP.NET MVC приложение регистрирует маршрут для Web API контроллера.

      Вот C# код файла WebApiConfig.cs:
      using System.Web.Http;
      
      namespace WebApplication4
      {
          public static class WebApiConfig
          {
              public static void Register(HttpConfiguration config)
              {
                  config.Routes.MapHttpRoute(
                      name: "DemoApi",
                      routeTemplate: "vintasoft/api/{controller}/{action}"
                  );
              }
          }
      }
      
      
  5. Серверная часть: Создайте контроллер ASP.NET MVC 5 для веб-представления, которое будет отображать веб редактор документа.

    • Установите nuget-пакет Microsoft.AspNet.Mvc 5.2.7:


    • Нажмите правую кнопку мыши на папке "Controllers" и выберите меню "Add => Controller..." из контекстного меню


    • Выберите шаблон "MVC 5 Controller - Empty", укажите имя контроллера "DefaultController" и нажмите кнопку "Add".


    • Откройте файл "App_Start/RouteConfig.cs" и проверьте, правильно ли ASP.NET MVC приложение регистрирует маршрут для контроллера MVC.

      Вот C# код файла RouteConfig.cs:
      using System.Web.Mvc;
      using System.Web.Routing;
      
      namespace WebApplication4
      {
          public class RouteConfig
          {
              public static void RegisterRoutes(RouteCollection routes)
              {
                  routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
      
                  routes.MapRoute(
                      name: "Default",
                      url: "{controller}/{action}",
                      defaults: new { controller = "Default", action = "Index" }
                  );
              }
          }
      }
      
      
      
  6. Серверная сторона: Проверьте глобальную конфигурацию ASP.NET MVC 5 приложения.

    Откройте файл "Global.asax.cs" и убедитесь, что метод "Application_Start" регистрирует все области в ASP.NET MVC приложении, настраивает глобальную HTTP-конфигурацию для ASP.NET приложения и регистрирует маршруты для ASP.NET MVC приложения.

    Вот C# код файла Global.asax.cs:
    using System.Web.Http;
    using System.Web.Mvc;
    using System.Web.Routing;
    
    namespace WebApplication4
    {
        public class WebApiApplication : System.Web.HttpApplication
        {
            protected void Application_Start()
            {
                Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();
    
                AreaRegistration.RegisterAllAreas();
                GlobalConfiguration.Configure(WebApiConfig.Register);
                RouteConfig.RegisterRoutes(RouteTable.Routes);
            }
        }
    }
    
    
  7. Клиентская часть: Создайте веб-представление для отображения веб редактора документа.

    • Откройте файл "DefaultController.cs", щёлкните правой кнопкой мыши по методу "Index" класса DefaultController и выберите в контекстном меню пункт "Add View...".
    • Выберите шаблон "MVC 5 View", нажмите кнопку "Add", укажите "Index" в качестве имени представления, снимите флажок "Use a layout page" и нажмите кнопку "Add" => будет создан файл "Views\Default\Index.cshtml".
  8. Клиентская сторона: Добавьте JavaScript-библиотеки в проект.

    • Добавьте папку "Scripts\" в ASP.NET MVC приложение (если папка отсутствует).

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

    • Укажите, какие "стандартные" UI-диалоги пользовательского интерфейса (диалог переименования листа, диалог поиска текста и т. д.) должны использоваться веб редактором документа.
      • Если веб редактор документа должен использовать готовые к использованию "стандартные" UI-диалоги jQuery UI:
        • Скопируйте файл jQuery в папку "Scripts\".
          Вы можете использовать файл "jquery-3.3.1.min.js" из папки "<InstallPath>\VintaSoft Imaging .NET 15.1\Examples\ASP.NET MVC\CSharp\AspNetMvcDocumentEditorDemo\Scripts\External\" или файл jQuery из любого другого источника.
        • Скопируйте файлы и папки jQuery UI в папку "Scripts\".
          Вы можете использовать файл "jquery-ui.min.js" и папку "jquery-ui-css" из папки "<InstallPath>\VintaSoft Imaging .NET 15.1\Examples\ASP.NET MVC\CSharp\AspNetMvcDocumentEditorDemo\Scripts\External\" или файлы и папки jQuery UI из любого другого источника.
        • Скопируйте файлы Vintasoft.Imaging.Dialogs.jQueryUI.js и Vintasoft.Imaging.Office.Dialogs.jQueryUI.js из папки "<InstallPath>\VintaSoft Imaging .NET 15.1\Bin\JavaScript\" в папку "Scripts\".

      • Если веб редактор документа должен использовать пользовательские "стандартные" диалоги, пожалуйста, ознакомьтесь с инструкцией по созданию пользовательских "стандартных" диалогов. здесь .
  9. Клиентская сторона: Добавьте JavaScript код, который позволяет отображать табличные документы.

    • Создайте папку "wwwroot\UploadedImageFiles" и скопируйте в нее тестовый DOCX документ. Этот документ будет отображаться в веб редакторе документа.

    • Откройте веб-представление - файл "Views\Default\Index.cshtml".


    • Добавьте ссылки на JavaScript-файлы Vintasoft:

      Вот HTML-код, который добавляет ссылки на файлы jQuery и JavaScript-файлы Vintasoft:
      <link rel="stylesheet" type="text/css" href="~/Scripts/jquery-ui-css/jquery-ui.min.css">
      <link rel="stylesheet" type="text/css" href="~/Scripts/Vintasoft.Imaging.css">
      <link rel="stylesheet" type="text/css" href="~/Scripts/Vintasoft.Imaging.Office.css">
      
      <script src="~/Scripts/jquery-3.3.1.min.js" type="text/javascript"></script>
      <script src="~/Scripts/jquery-ui.min.js" type="text/javascript"></script>
      
      <script src="~/Scripts/Vintasoft.Shared.js" type="text/javascript"></script>
      <script src="~/Scripts/Vintasoft.Imaging.js" type="text/javascript"></script>
      <script src="~/Scripts/Vintasoft.Imaging.Dialogs.jQueryUI.js" type="text/javascript"></script>
      <script src="~/Scripts/Vintasoft.Imaging.Office.js" type="text/javascript"></script>
      <script src="~/Scripts/Vintasoft.Imaging.Office.Dialogs.jQueryUI.js" type="text/javascript"></script>
      
      


    • Добавьте HTML-разметку (элемент div, который будет отображать веб-редактор документов) в веб-представление:

      Вот код HTML-разметки:
      <h1 style="text-align: center">VintaSoft Document Editor Demo (ASP.NET MVC5)</h1>
      
      <div id="documentEditorContainer" style="width: 100%; height: 800px;"></div>
      


    • Добавьте JavaScript-код, который инициализирует и создает веб редактор документа:

      Вот JavaScript-код, который инициализирует и создает веб редактор документа:
      <script type="text/javascript">
          // specify web services, which should be used in this demo
          Vintasoft.Shared.WebServiceJS.defaultFileService = new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftFileApi");
          Vintasoft.Shared.WebServiceJS.defaultOfficeService = new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftOfficeApi");
      
          // create web document editor settings
          var documentEditorSettings = new Vintasoft.Imaging.Office.UI.WebDocumentEditorSettingsJS("documentEditorContainer");
      
          // create web document editor
          _documentEditor = new Vintasoft.Imaging.Office.UI.WebDocumentEditorJS(documentEditorSettings);
      
          // open DOCX document in web document editor
          _documentEditor.openDocument("DocxTestDocument.docx");
      </script>
      
      
  10. Запустите ASP.NET MVC5 приложение и посмотрите результат.