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

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

      Open Visual Studio .NET 2022 and create a new project, of ASP.NET Core Web application type:
      Open Visual Studio .NET 2022 and create a new project, of ASP.NET Core Web Application type
      Configure the project to use .NET 7.0:
      Configure the ASP.NET Core project
    2. Server side: Add references to the Vintasoft assemblies to your ASP.NET Core Web application.

      Copy Vintasoft.Shared.dll, Vintasoft.Imaging.dll, Vintasoft.Imaging.Pdf.dll, Vintasoft.Imaging.Annotation.dll, Vintasoft.Imaging.Annotation.Pdf.dll, Vintasoft.Imaging.Office.OpenXml, Vintasoft.Shared.Web.dll, Vintasoft.Imaging.Web.Services.dll, Vintasoft.Imaging.Annotation.Web.Services.dll, Vintasoft.Imaging.AspNetCore.ApiControllers.dll and Vintasoft.Imaging.Annotation.AspNetCore.ApiControllers.dll assemblies from "<SdkInstallPath>\VintaSoft Imaging .NET v12.4\Bin\DotNet7\AnyCPU\" directory to the "Bin" directory of ASP.NET Core Web application and add references to assemblies in ASP.NET Core Web 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.

      If ASP.NET application must be used in Windows or Linux, SkiaSharp drawing engine should be used.
      If ASP.NET application must be used in Windows only, System.Drawing or SkiaSharp drawing engine should be used.

      Here are steps, which should be made for using SkiaSharp engine:
      • Add reference to the Vintasoft.Imaging.Drawing.SkiaSharp.dll assembly.
      • Add reference to the SkiaSharp nuget-package version 2.88.6.
      • Open "Startup.cs" file, add code line "Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();" at the beginning of ConfigureServices method - added code specifies that VintaSoft Imaging .NET SDK should use SkiaSharp library for drawing of 2D graphics.

      Here are steps, which should be made for using System.Drawing engine:
      • Add reference to the Vintasoft.Imaging.Gdi.dll assembly.
      • Open "Startup.cs" file, add code line "Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();" at the beginning of ConfigureServices 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.

      • Add the "Controllers" folder to the project.
      • 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.AspNetCore.ApiControllers.VintasoftFileApiController class
          Source codes of Vintasoft File API controller
          Here are source codes of MyVintasoftFileApiController class:
          using Microsoft.AspNetCore.Hosting;
          
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftFileApiController : Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftFileApiController
              {
          
                  public MyVintasoftFileApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
          
              }
          }
          
          
      • 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.AspNetCore.ApiControllers.VintasoftImageCollectionApiController class
          Source codes of Vintasoft Image Collection API controller
          Here are source codes of MyVintasoftImageCollectionApiController class:
          using Microsoft.AspNetCore.Hosting;
          
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftImageCollectionApiController : Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftImageCollectionApiController
              {
          
                  public MyVintasoftImageCollectionApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
          
              }
          }
          
          
      • 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.AspNetCore.ApiControllers.VintasoftImageApiController class
          Source codes of Vintasoft Image API controller
          Here are source codes of MyVintasoftImageApiController class:
          using Microsoft.AspNetCore.Hosting;
          
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftImageApiController : Vintasoft.Imaging.AspNetCore.ApiControllers.VintasoftImageApiController
              {
          
                  public MyVintasoftImageApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
          
              }
          }
          
          
      • 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.AspNetCore.ApiControllers.VintasoftAnnotationCollectionApiController class
          Source codes of Vintasoft Annotation Collection API controller
          Here are source codes of MyVintasoftAnnotationCollectionApiController class:
          using Microsoft.AspNetCore.Hosting;
          
          namespace WebApplication1.Controllers
          {
              public class MyVintasoftAnnotationCollectionApiController :
                  Vintasoft.Imaging.Annotation.AspNetCore.ApiControllers.VintasoftAnnotationCollectionApiController
              {
          
                  public MyVintasoftAnnotationCollectionApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
              }
          }
          
          
    5. Server side: Add Newtonsoft JSON for deserialization of annotations.

      • Add reference to the Microsoft.AspNetCore.Mvc.NewtonsoftJson nuget-package:
        Add reference to the Microsoft.AspNetCore.Mvc.NewtonsoftJson nuget-package
    6. Server side: Create MVC 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
        Select 'Add => Controller' context menu for 'Controllers' folder
      • Select "MVC Controller - Empty" template, set the controller name to the "DefaultController" and press the "Add" button
        ASP.NET Core controller settings
      • Open "Startup.cs" file, add controllers with views to the services of ASP.NET Core application:
        Controllers in Startup.cs file

        Add created MVC controller to the endpoints of ASP.NET Core application:
        Endpoints in Startup.cs file

        Enable static file serving for the current request path of ASP.NET Core application:
        Endpoints in Startup.cs file

        Here are C# source codes of Startup.cs file:
        using Microsoft.AspNetCore.Builder;
        using Microsoft.AspNetCore.Hosting;
        using Microsoft.Extensions.Configuration;
        using Microsoft.Extensions.DependencyInjection;
        using Microsoft.Extensions.Hosting;
        
        namespace WebApplication1
        {
            public class Startup
            {
                public Startup(IConfiguration configuration)
                {
                    Configuration = configuration;
                }
        
                public IConfiguration Configuration { get; }
        
                // This method gets called by the runtime. Use this method to add services to the container.
                public void ConfigureServices(IServiceCollection services)
                {
                    // specify that VintaSoft Imaging .NET SDK should use SkiaSharp library for drawing of 2D graphics
                    Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();
        
                    // add Newtonsoft JSON for deserialization of JSON annotations
                    services.AddControllersWithViews().AddNewtonsoftJson();
        
                    services.AddRazorPages();
                }
        
                // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
                public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                {
                    if (env.IsDevelopment())
                    {
                        app.UseDeveloperExceptionPage();
                    }
                    else
                    {
                        app.UseExceptionHandler("/Error");
                        // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
                        app.UseHsts();
                    }
        
                    app.UseHttpsRedirection();
                    app.UseStaticFiles();
        
                    app.UseRouting();
        
                    app.UseAuthorization();
        
                    app.UseEndpoints(endpoints =>
                    {
                        endpoints.MapControllerRoute("default", "{controller=Default}/{action=Index}/{id?}");
                    });
                }
            }
        }
        
        
    7. Client side: Add JavaScript libraries to the project.

      • Add the "wwwroot\js\" folder to ASP.NET Core 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 "wwwroot\js\" 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" Bootstrap dialogs:
          • Add Bootstrap and jQuery libraries to the project.
          • Copy Vintasoft.Imaging.Dialogs.Bootstrap.js and Vintasoft.Imaging.DocumentViewer.Dialogs.Bootstrap.js files from "<InstallPath>\VintaSoft Imaging .NET v12.4\Bin\JavaScript\" folder into "wwwroot\js\" folder.
        • If web document viewer should use ready-to-use "standard" jQuery UI dialogs:
          • Add jQuery and jQuery UI libraries to the project.
          • 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 "wwwroot\js\" folder.
        • If web document viewer should use custom "standard" dialogs, please read how to create custom "standard" dialogs here.

    8. Client side: Add JavaScript code that allows to display document, search and extract text from document, annotate document.

      • Create folder "wwwroot\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 used JavaScript libraries:
        • If jQuery UI dialogs are used, add references to the jQuery files and Vintasoft JavaScript files:
          References to Vintasoft JavaScript files, jQuery UI dialogs
          Here is HTML code that adds references to the jQuery and Vintasoft JavaScript files:
          <link rel="stylesheet" type="text/css" href="~/js/jquery-ui-css/jquery-ui.min.css">
          <link rel="stylesheet" type="text/css" href="~/js/Vintasoft.Imaging.DocumentViewer.css">
          
          <script src="~/js/jquery-3.3.1.min.js" type="text/javascript"></script>
          <script src="~/js/jquery-ui.min.js" type="text/javascript"></script>
          
          <script src="~/js/Vintasoft.Shared.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.Annotation.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.DocumentViewer.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.DocumentViewer.Dialogs.jQueryUI.js" type="text/javascript"></script>
          

        • If simple JavaScript dialogs are used, add references to the Vintasoft JavaScript files:
          References to Vintasoft JavaScript files, simple JS dialogs
          Here is HTML code that adds references to the Vintasoft JavaScript files:
          <link rel="stylesheet" type="text/css" href="~/js/Vintasoft.Imaging.DocumentViewer.css">
          
          <script src="~/js/Vintasoft.Shared.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.Annotation.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.DocumentViewer.js" type="text/javascript"></script>
          <script src="~/js/Vintasoft.Imaging.DocumentViewer.Dialogs.Bootstrap.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)</h1>
        
        <div id="documentViewerContainer" style="height:800px"></div>
        
      • Add JavaScript code that initializes and created document viewer:
        JavaScript code that initializes and displays document viewer
        Here is JavaScript code that initializes and displays document viewer:
        <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
            var 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
                var 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>
        
        
    9. Run the ASP.NET Core Web application and see the result.

      Document viewer in ASP.NET Core Web application