VintaSoft Imaging .NET SDK 12.4: Documentation for Web developer
In This Topic
    Add web document viewer to an ASP.NET MVC5 application
    In This Topic
    This tutorial shows how to create a blank ASP.NET Core Web application in Visual Studio .NET 2019 and
    add document viewer (with ability to open images and documents (PDF, DOCX, XLSX), extract/search text, annotate documents) to ASP.NET MVC5 application.

    Here are steps, which must be done:
    1. Create a blank ASP.NET MVC5 application.

      Open Visual Studio .NET 2019 and create a new project, of ASP.NET Web application type, and configure the project to use .NET Framework 4.7.2:
      Open Visual Studio .NET 2019 and create a new project, of ASP.NET Web Application type, and configure the project to use .NET Framework 4.7.2
      Select the "Empty" template for ASP.NET Web application and configure the project to use MVC and Web API:
      Select the Empty template for ASP.NET Web Application and configure to use Web API
    2. Server side: Add references to the Vintasoft assemblies to ASP.NET MVC5 application.

      Add references to the Vintasoft.Shared.dll, Vintasoft.Imaging.dll, Vintasoft.Imaging.Annotation.dll, Vintasoft.Imaging.Pdf.dll, Vintasoft.Imaging.Office.OpenXml.dll, Vintasoft.Shared.Web.dll, Vintasoft.Imaging.Web.Services.dll, Vintasoft.Imaging.Annotation.Web.Services.dll, Vintasoft.Imaging.Web.Api2Controllers.dll and Vintasoft.Imaging.Annotation.Web.Api2Controllers.dll assemblies from "<SdkInstallPath>\VintaSoft Imaging .NET v12.4\Bin\DotNet4\AnyCPU\" folder in ASP.NET MVC5 application.

      Add references to the Vintasoft assemblies

    3. Server side: Specify drawing engine, which should be used by VintaSoft Imaging .NET SDK for drawing of 2D graphics.

      ASP.NET MVC5 application should use System.Drawing library as drawing engine because ASP.NET MVC5 application can be used in Windows only.

      Here are steps, which should be made for using System.Drawing engine:
      • Add reference to the Vintasoft.Imaging.Gdi.dll assembly.
      • Open "Global.asax.cs" file, add code line "Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();" at the beginning of Application_Start method - added code specifies that VintaSoft Imaging .NET SDK should use System.Drawing library for drawing of 2D graphics.

    4. Server side: Create web services, which allow to upload/download file, manage image collection, get information about images, get thumbnails, render image tiles, extract/search text and annotate document.

      • Create web service that allows to upload/download file

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
          Select 'Add => Controller' context menu for 'Controllers' folder
        • Select Empty API controller template, set the controller name to the "MyVintasoftFileApiController" and press the "Add" button
          Select Empty API controller template, set the controller name to the MyVintasoftFileApiController and press the Add button
        • Specify that MyVintasoftFileApiController class is derived from Vintasoft.Imaging.Web.Api2Controllers.VintasoftFileApi2Controller class
          Source codes of Vintasoft File API controller
          Here are source codes of MyVintasoftFileApiController class:
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftFileApiController : Vintasoft.Imaging.Web.Api2Controllers.VintasoftFileApi2Controller
              {
          
                  public MyVintasoftFileApiController()
                      : base()
                  {
                  }
          
              }
          }
          
          

      • Create web service that allows to manage image collection

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
          Select 'Add => Controller' context menu for 'Controllers' folder
        • Select Empty API controller template, set the controller name to the "MyVintasoftImageCollectionApiController" and press the "Add" button
          Select Empty API controller template, set the controller name to the MyVintasoftImageCollectionApiController and press the Add button
        • Specify that MyVintasoftImageCollectionApiController class is derived from Vintasoft.Imaging.Web.Api2Controllers.VintasoftImageCollectionApi2Controller class
          Source codes of Vintasoft Image Collection API controller
          Here are source codes of MyVintasoftImageCollectionApiController class:
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftImageCollectionApiController :
                  Vintasoft.Imaging.Web.Api2Controllers.VintasoftImageCollectionApi2Controller
              {
          
                  public MyVintasoftImageCollectionApiController()
                      : base()
                  {
                  }
          
              }
          }
          
          

      • Create web service that allows to get information about images, get thumbnails, render image tiles, extract/search text

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
          Select 'Add => Controller' context menu for 'Controllers' folder
        • Select Empty API controller template, set the controller name to the "MyVintasoftImageApiController" and press the "Add" button
          Select Empty API controller template, set the controller name to the MyVintasoftImageApiController and press the Add button
        • Specify that MyVintasoftImageApiController class is derived from Vintasoft.Imaging.Web.Api2Controllers.VintasoftImageApi2Controller class
          Source codes of Vintasoft Image API controller
          Here are source codes of MyVintasoftImageApiController class:
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftImageApiController : Vintasoft.Imaging.Web.Api2Controllers.VintasoftImageApi2Controller
              {
          
                  public MyVintasoftImageApiController()
                      : base()
                  {
                  }
          
              }
          }
          
          

      • Create web service that allows to annotate images and documents

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
          Select 'Add => Controller' context menu for 'Controllers' folder
        • Select Empty API controller template, set the controller name to the "MyVintasoftAnnotationCollectionApiController" and press the "Add" button
          Select Empty API controller template, set the controller name to the MyVintasoftAnnotationCollectionApiController and press the Add button
        • Specify that MyVintasoftAnnotationCollectionApiController class is derived from Vintasoft.Imaging.Annotation.Web.Api2Controllers.VintasoftAnnotationCollectionApi2Controller class
          Source codes of Vintasoft Annotation Collection API controller
          Here are source codes of MyVintasoftAnnotationCollectionApiController class:
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftAnnotationCollectionApiController :
                  Vintasoft.Imaging.Annotation.Web.Api2Controllers.VintasoftAnnotationCollectionApi2Controller
              {
          
                  public MyVintasoftAnnotationCollectionApiController()
                      : base()
                  {
                  }
          
              }
          }
          
          

      • Open "App_Start\WebApiConfig.cs" file and check that ASP.NET MVC application correctly registers route for Web API controller.
        C# source codes of WebApiConfig.cs file
        Here are C# source codes of WebApiConfig.cs file:
        using System.Web.Http;
        
        namespace WebApplication1
        {
            public static class WebApiConfig
            {
                public static void Register(HttpConfiguration config)
                {
                    config.Routes.MapHttpRoute(
                        name: "DemoAPI",
                        routeTemplate: "vintasoft/api/{controller}/{action}"
                    );
                }
            }
        }
        
        
    5. Server side: Create ASP.NET MVC 5 controller for web view that will display document viewer.

      • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
        'Add => Controller...' context menu

      • Select "MVC 5 Controller - Empty" template, set the controller name to the "DefaultController" and press the "Add" button
        ASP.NET MVC5 controller settings

      • Open "App_Start\RouteConfig.cs" file and check that ASP.NET MVC application correctly registers route for MVC controller.
        C# source codes of RouteConfig.cs file
        Here are C# source codes of RouteConfig.cs file:
        using System.Web.Mvc;
        using System.Web.Routing;
        
        namespace WebApplication1
        {
            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. Server side: Check global configuration of ASP.NET MVC5 application.

      Open "Global.asax.cs" file and check that "Application_Start" method registers all areas in ASP.NET MVC application, configures global HTTP configuration for ASP.NET application, registers routes for ASP.NET MVC application.
      C# source codes of Global.asax.cs file
      Here are C# source codes of Global.asax.cs file:
      using System.Web.Http;
      using System.Web.Mvc;
      using System.Web.Routing;
      
      namespace WebApplication1
      {
          public class WebApiApplication : System.Web.HttpApplication
          {
              protected void Application_Start()
              {
                  AreaRegistration.RegisterAllAreas();
                  GlobalConfiguration.Configure(WebApiConfig.Register);
                  RouteConfig.RegisterRoutes(RouteTable.Routes);
              }
          }
      }
      
      
    7. Client side: Create web view for displaying document viewer.

      • Open "DefaultController.cs" file, press the right mouse button on the "Index" method of DefaultController class and select the "Add View..." menu from context menu
        'Add view...' context menu
      • Select "MVC 5 View" template, click "Add" button, set view name to "Index", uncheck "Use a layout page" checkbox and press the "Add" button => "Views\Default\Index.cshtml" file will be created
        Web view settings
    8. Client side: Add JavaScript libraries to the project.

      • Add the "Scripts\" folder to ASP.NET MVC application if folder does not exist.

      • Copy Vintasoft.Shared.js, Vintasoft.Imaging.js, Vintasoft.Imaging.Annotation.js, Vintasoft.Imaging.DocumentViewer.js and Vintasoft.Imaging.DocumentViewer.css files from "<InstallPath>\VintaSoft Imaging .NET v12.4\Bin\JavaScript\" folder into "Scripts\" folder.

      • Specify, which "standard" dialogs (password dialog, print dialog, etc) should be used by web document viewer
        • If web document viewer should use ready-to-use "standard" jQuery UI dialogs (modern dialogs with ability to move dialog):
          • Copy jQuery file into "Scripts\" folder.
            You can use "jquery-3.3.1.min.js" file from "<InstallPath>\VintaSoft Imaging .NET v12.4\Examples\ASP.NET MVC\CSharp\AspNetMvcImagingDemo\Scripts\External\" folder or jQuery file from any other source.
          • Copy jQuery UI files and folders into "Scripts\" folder.
            You can use "jquery-ui.min.js" file and "jquery-ui-css" folder from "<InstallPath>\VintaSoft Imaging .NET v12.4\Examples\ASP.NET MVC\CSharp\AspNetMvcImagingDemo\Scripts\External\" folder or jQuery UI files and folders from any other source.
          • Copy Vintasoft.Imaging.Dialogs.jQueryUI.js and Vintasoft.Imaging.DocumentViewer.Dialogs.jQueryUI.js files from "<InstallPath>\VintaSoft Imaging .NET v12.4\Bin\JavaScript\" folder into "Scripts\" folder.

        • If web document viewer should use custom "standard" dialogs, please read how to create custom "standard" dialogs here.
    9. Client side: Add JavaScript code that allows to display document, search and extract text from document, annotate document.

      • Create folder "UploadedImageFiles\SessionID" and copy test PDF document "<SdkInstallPath>\VintaSoft\Imaging .NET v12.4\Images\VintasoftImagingDemo.pdf" to the folder. This document will be displayed in document viewer.

      • Open web view - file "Views\Default\Index.cshtml".
        Default web view

      • Add references to Vintasoft JavaScript files:
        References to Vintasoft JavaScript files
        Here is HTML code that adds references to jQuery and Vintasoft JavaScript files:
        <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.DocumentViewer.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.Annotation.js" type="text/javascript"></script>
        <script src="~/Scripts/Vintasoft.Imaging.DocumentViewer.js" type="text/javascript"></script>
        <script src="~/Scripts/Vintasoft.Imaging.DocumentViewer.Dialogs.jQueryUI.js" type="text/javascript"></script>
        


      • Add HTML markup (a div element that will display document viewer) to the web view:
        HTML markup (a div element that will display document viewer)
        Here is HTML markup code:
        <h1 style="text-align: center">VintaSoft Document Viewer Demo (ASP.NET Core MVC5)</h1>
        
        <div id="documentViewerContainer" style="height: 800px"></div>
        
        


      • Add JavaScript code that initializes and creates document viewer:
        JavaScript code that initializes and creates document viewer
        Here is JavaScript code that initializes and creates document viewer:
        @{
            Layout = null;
        }
        
        <!DOCTYPE html>
        
        <html>
        <head>
            <meta name="viewport" content="width=device-width" />
            <title>VintaSoft Document Viewer Demo (ASP.NET MVC5)</title>
        
            <style>
                * {
                    -webkit-box-sizing: border-box;
                    box-sizing: border-box;
                    border-collapse: collapse;
                }
            </style>
        
            <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.DocumentViewer.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.Annotation.js" type="text/javascript"></script>
            <script src="~/Scripts/Vintasoft.Imaging.DocumentViewer.js" type="text/javascript"></script>
            <script src="~/Scripts/Vintasoft.Imaging.DocumentViewer.Dialogs.jQueryUI.js" type="text/javascript"></script>
        </head>
        <body>
            <h1 style="text-align: center">VintaSoft Document Viewer Demo (ASP.NET Core MVC5)</h1>
        
            <div id="documentViewerContainer" style="height: 800px"></div>
        
            <script type="text/javascript">
                // set the session identifier
                Vintasoft.Shared.WebImagingEnviromentJS.set_SessionId("SessionID");
        
                // specify web services, which should be used by Vintasoft Web Document Viewer
                Vintasoft.Shared.WebServiceJS.defaultFileService =
                    new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftFileApi");
                Vintasoft.Shared.WebServiceJS.defaultImageCollectionService =
                    new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftImageCollectionApi");
                Vintasoft.Shared.WebServiceJS.defaultImageService =
                    new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftImageApi");
                Vintasoft.Shared.WebServiceJS.defaultAnnotationService =
                    new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftAnnotationCollectionApi");
        
                // create settings for document viewer with annotation support
                let docViewerSettings =
                    new Vintasoft.Imaging.DocumentViewer.WebDocumentViewerSettingsJS("documentViewerContainer", { annotations: true });
        
                // get items of document viewer
                var items = docViewerSettings.get_Items();
        
                // get the main menu of document viewer
                var mainMenu = items.getItemByRegisteredId("mainMenu");
                // if main menu is found
                if (mainMenu != null) {
                    // get items of main menu
                    let mainMenuItems = mainMenu.get_Items();
        
                    // add "Annotation" menu panel to the main menu
                    mainMenuItems.addItem("annotationsMenuPanel");
                }
        
                // get side panel of document viewer
                var sidePanel = items.getItemByRegisteredId("sidePanel");
                // if side panel is found
                if (sidePanel != null) {
                    // get items of side panel
                    var sidePanelItems = sidePanel.get_PanelsCollection();
        
                    // add "Annotations" panel to the side panel
                    sidePanelItems.addItem("annotationsPanel");
        
                    // add "Text selection" panel to the side panel
                    sidePanelItems.addItem("textSelectionPanel");
        
                    // add "Text searh" panel to the side panel
                    sidePanelItems.addItem("textSearchPanel");
                }
        
                // create the document viewer
                var docViewer = new Vintasoft.Imaging.DocumentViewer.WebDocumentViewerJS(docViewerSettings);
        
                // create visual tool that allows to work with annotations, navigate document and select text
                var annotationNavigationTextSelectionTool =
                    docViewer.getVisualToolById("AnnotationVisualTool,DocumentNavigationTool,TextSelectionTool");
                // specify visual tool as mandatory visual tool of document viewer
                docViewer.set_MandatoryVisualTool(annotationNavigationTextSelectionTool);
                // specify visual tool as current visual tool of document viewer
                docViewer.set_CurrentVisualTool(annotationNavigationTextSelectionTool);
        
                // get image viewer of document viewer
                var imageViewer = docViewer.get_ImageViewer();
                // open file from session folder and add images from file to the image viewer
                imageViewer.get_Images().openFile("VintasoftImagingDemo.pdf");
            </script>
        </body>
        </html>
        
        
    10. Run the ASP.NET MVC5 application and see the result.

      Document viewer in ASP.NET MVC5 application