VintaSoft Imaging .NET SDK 12.5: Documentation for Web developer
In This Topic
    Add web DICOM viewer to an ASP.NET WebForms application
    In This Topic
    This tutorial shows how to create a blank ASP.NET Web application in Visual Studio .NET 2019 and add DICOM viewer to ASP.NET WebForms application.


    Here are steps, which must be done:
    1. Create a blank ASP.NET WebForms 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:

      Select the "Empty" template for ASP.NET Web application and configure the project to use WebForms:

    2. Server side: Add references to the Vintasoft assemblies to ASP.NET WebForms application.

      Add references to the Vintasoft.Shared.dll, Vintasoft.Imaging.dll, Vintasoft.Imaging.Dicom.dll, Vintasoft.Shared.Web.dll, Vintasoft.Imaging.Web.Services.dll, Vintasoft.Imaging.Dicom.Web.Services.dll, Vintasoft.Imaging.Web.Handlers.dll and Vintasoft.Imaging.Dicom.Web.Handlers.dll assemblies from "<SdkInstallPath>\VintaSoft Imaging .NET v12.5\Bin\DotNet4\AnyCPU\" folder in ASP.NET WebForms application.



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

      ASP.NET WebForms application should use System.Drawing library as drawing engine because ASP.NET WebForms 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 "Default.aspx.cs" file, add code line "Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();" at the beginning of Page_Load 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 and view DICOM images.

      • Add the "Handlers" folder to ASP.NET WebForms application.
      • Create web service that allows to upload/download file

        • Press the right mouse button on the "Handlers" folder and select the "Add => Generic handler" menu from context menu
        • Specify the handler name "MyVintasoftFileHandler" and press the "Ok" button
        • Specify that MyVintasoftFileHandler class is derived from VintasoftImaging.Web.HttpHandlers.VintasoftFileHandler class

          Here are C# source codes of MyVintasoftFileHandler class:
          namespace WebApplication1.Handlers
          {
              public class MyVintasoftFileHandler : Vintasoft.Imaging.Web.HttpHandlers.VintasoftFileHandler
              {
              }
          }
          
          
      • Create web service that allows to work with DICOM images

        • Press the right mouse button on the "Handlers" folder and select the "Add => Generic handler" menu from context menu
        • Specify the handler name "MyVintasoftDicomHandler" and press the "Ok" button
        • Specify that MyVintasoftDicomHandler class is derived from VintasoftImaging.Dicom.Web.HttpHandlers.VintasoftDicomHandler class

          Here are C# source codes of MyVintasoftDicomHandler class:
          using Vintasoft.Imaging.Dicom.Web.HttpHandlers;
          
          namespace WebApplication1.Handlers
          {
              /// <summary>
              /// ASP.NET HTTP handler that handles HTTP requests from clients and allows to work with DICOM images on a server.
              /// </summary>
              public class MyVintasoftDicomHandler : VintasoftDicomHandler
              {
          
                  /// <summary>
                  /// Initializes a new instance of the <see cref="MyVintasoftDicomHandler"/> class.
                  /// </summary>
                  public MyVintasoftDicomHandler()
                      : base()
                  {
                  }
          
              }
          }
          
    5. Client side: Add JavaScript libraries to the project.

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

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

      • Specify, which "standard" dialogs (password dialog, print dialog, etc) should be used by web DICOM viewer
        • If web DICOM 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.5\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.5\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.Dicom.Dialogs.jQueryUI.js files from "<InstallPath>\VintaSoft Imaging .NET v12.5\Bin\JavaScript\" folder into "Scripts\" folder.

        • If web DICOM viewer should use custom "standard" dialogs,please read how to create custom "standard" dialogs here.
    6. Client side: Add JavaScript code, which initializes and dispalys DICOM viewer, to the Default web form.

      • Create folder "UploadedImageFiles\SessionID" and copy DICOM file "<SdkInstallPath>\VintaSoft\Imaging .NET v12.5\Examples\ASP.NET Core\CSharp\AspNetCoreImagingDemo\wwwroot\UploadedImageFiles\LossyJpeg_Monochrome2_000.0000.dcm" to the folder. This file will be displayed in DICOM viewer.

      • Create the Default web form - file "Default.aspx".
        • Press the right mouse button on the project and select the "Add => WebForm" menu from context menu:


        • Specify "Default" as web form name => created web form will be opened:

      • Add references to the 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.css">
        <link rel="stylesheet" type="text/css" href="Scripts/Vintasoft.Imaging.Dicom.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.Dicom.js" type="text/javascript"></script>
        <script src="Scripts/Vintasoft.Imaging.Dialogs.jQueryUI.js" type="text/javascript"></script>
        <script src="Scripts/Vintasoft.Imaging.Dicom.Dialogs.jQueryUI.js" type="text/javascript"></script>
        


      • Add HTML markup (a div-element that will display DICOM viewer) to the web view:

        Here is HTML markup code:
        <form id="form1" runat="server">
            <h1 style="text-align: center">VintaSoft DICOM Viewer Demo (ASP.NET WebForms)</h1>
            <div id="dicomControlContainer" style="height: 800px"></div>
        </form>
        


      • Add JavaScript code that displays DICOM viewer:

        Here is JavaScript code (with page markup) that displays DICOM viewer:
        <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="WebApplication1.Default" %>
        
        <!DOCTYPE html>
        
        <html xmlns="http://www.w3.org/1999/xhtml">
        <head runat="server">
            <title>VintaSoft DICOM Viewer Demo (ASP.NET WebForms)</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.css">
            <link rel="stylesheet" type="text/css" href="Scripts/Vintasoft.Imaging.Dicom.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.Dicom.js" type="text/javascript"></script>
            <script src="Scripts/Vintasoft.Imaging.Dialogs.jQueryUI.js" type="text/javascript"></script>
            <script src="Scripts/Vintasoft.Imaging.Dicom.Dialogs.jQueryUI.js" type="text/javascript"></script>
        </head>
        <body>
            <form id="form1" runat="server">
                <h1 style="text-align: center">VintaSoft DICOM Viewer Demo (ASP.NET WebForms)</h1>
                <div id="dicomControlContainer" style="height: 800px"></div>
            </form>
        
            <script type="text/javascript">
                // set the session identifier
                Vintasoft.Shared.WebImagingEnviromentJS.set_SessionId("SessionID");
        
                // specify web services, which should be used by Vintasoft Web DICOM Viewer
                Vintasoft.Shared.WebServiceJS.defaultFileService =
                    new Vintasoft.Shared.WebServiceHandlerJS("/Handlers/MyVintasoftFileHandler.ashx");
                Vintasoft.Shared.WebServiceJS.defaultDicomService =
                    new Vintasoft.Shared.WebServiceHandlerJS("/Handlers/MyVintasoftDicomHandler.ashx");
        
                // create DICOM control settings
                var dicomControlSettings = new Vintasoft.Imaging.Dicom.WebDicomControlSettingsJS("dicomControlContainer", "dicomControl");
                // create DICOM control
                var dicomControl = new Vintasoft.Imaging.Dicom.WebDicomControlJS(dicomControlSettings);
        
                // subscribe to the "warningOccured" event of DICOM control
                Vintasoft.Shared.subscribeToEvent(dicomControl, "warningOccured", function (event, eventArgs) { alert(eventArgs.message); });
        
                // add DICOM file "LossyJpeg_Monochrome2_000.0000.dcm" to the DICOM control
                dicomControl.addFiles(["LossyJpeg_Monochrome2_000.0000.dcm"]);
            </script>
        </body>
        </html>
        
        
    7. Run the ASP.NET WebForms application and see the result.