VintaSoft Imaging .NET SDK 15.0: Documentation for Web developer
In This Topic
    Add web DICOM viewer to an "ASP.NET Core Web App (Model-View-Controller)" application
    In This Topic
    This tutorial shows how to create a blank "ASP.NET Core Web App (Model-View-Controller)" application in Visual Studio .NET 2026 and add DICOM viewer to ASP.NET Core application.

    Here are steps, which must be done:
    1. Create a blank "ASP.NET Core Web App (Model-View-Controller)" application.

      Open Visual Studio .NET 2026 and create a new project, of "ASP.NET Core Web App (Model-View-Controller)" application type:

      Configure the project to use .NET 10.0:

    2. Server side: Add references to the Vintasoft nuget-packages to the ASP.NET Core application.

      Add references to the nuget-packages "Vintasoft.Imaging.Dicom.AspNetCore.ApiControllers" and "Vintasoft.Imaging.Jpeg2000Codec" to the ASP.NET Core application. Other necessary nuget-packages will be added automatically.



    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" nuget-package. Reference to the "SkiaSharp" nuget-package version 3.119.0 will be added automatically.
      • Open "Program.cs" file, add code line "Vintasoft.Imaging.Drawing.SkiaSharp.SkiaSharpDrawingFactory.SetAsDefault();" at the beginning of file - 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" nuget-package.
      • Open "Program.cs" file, add code line "Vintasoft.Imaging.Drawing.Gdi.GdiGraphicsFactory.SetAsDefault();" at the beginning of file - 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.

      • 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 "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

          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 work with DICOM images

        • Press the right mouse button on the "Controllers" folder and select the "Add => Controller..." menu from context menu
        • Select "Empty API controller" template, set the controller name to the "MyVintasoftDicomApiController" and press the "Add" button
        • Specify that MyVintasoftDicomApiController class is derived from Vintasoft.Imaging.Dicom.AspNetCore.ApiControllers.VintasoftDicomApiController class

          Here are source codes of MyVintasoftDicomApiController class:
          using Microsoft.AspNetCore.Hosting;
          using Vintasoft.Imaging.Dicom.AspNetCore.ApiControllers;
          
          namespace WebApplication1.Controllers
          {
              /// <summary>
              /// A Web API controller that handles HTTP requests from clients and
              /// allows to work with DICOM images.
              /// </summary>
              public class MyVintasoftDicomApiController : VintasoftDicomApiController
              {
          
                  /// <summary>
                  /// Initializes a new instance of the <see cref="MyVintasoftDicomApiController"/> class.
                  /// </summary>
                  public MyVintasoftDicomApiController(IWebHostEnvironment hostingEnvironment)
                      : base(hostingEnvironment)
                  {
                  }
          
              }
          }
          
    5. Client side: Add JavaScript libraries to the project.

      • Add the "wwwroot\lib\Vintasoft\" folder to ASP.NET Core application if folder does not exist.

      • Copy Vintasoft.Shared.js, Vintasoft.Imaging.js, Vintasoft.Imaging.css, Vintasoft.Imaging.Dicom.js, Vintasoft.Imaging.Dicom.css files from "<InstallPath>\VintaSoft Imaging .NET 15.0\Bin\JavaScript\" folder into "wwwroot\lib\Vintasoft\" folder.
      • Specify, which "standard" dialogs (show DICOM metadata, etc) should be used by web DICOM viewer
        • If web DICOM 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.Dicom.Dialogs.Bootstrap.js files from "<InstallPath>\VintaSoft Imaging .NET 15.0\Bin\JavaScript\" folder into "wwwroot\lib\Vintasoft\" folder.
        • If web DICOM 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.Dicom.Dialogs.jQueryUI.js files from "<InstallPath>\VintaSoft Imaging .NET 15.0\Bin\JavaScript\" folder into "wwwroot\lib\Vintasoft\" 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 that allows to display DICOM images.

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

      • Open file "Views\Home\Index.cshtml".



        Add references to used JavaScript libraries:
        • If Bootstrap dialogs are used, add references to the Bootstrap files and Vintasoft JavaScript files.
          Here is HTML code that adds references to the Bootstrap and Vintasoft JavaScript files:
          <link rel="stylesheet" type="text/css" href="~/lib/bootstrap/dist/css/bootstrap.css">
          <link rel="stylesheet" type="text/css" href="~/lib/Vintasoft/Vintasoft.Imaging.css">
          <link rel="stylesheet" type="text/css" href="~/lib/Vintasoft/Vintasoft.Imaging.Dicom.css">
          
          <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.js" type="text/javascript"></script>
          
          <script src="~/lib/Vintasoft/Vintasoft.Shared.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.Dialogs.Bootstrap.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.Dicom.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.Dicom.Dialogs.Bootstrap.js" type="text/javascript"></script>
          
          

        • If jQuery UI dialogs are used, add references to the jQuery files and Vintasoft JavaScript files.
          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="~/lib/Vintasoft/Vintasoft.Imaging.css">
          <link rel="stylesheet" type="text/css" href="~/lib/Vintasoft/Vintasoft.Imaging.Dicom.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="~/lib/Vintasoft/Vintasoft.Shared.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.Dialogs.jQueryUI.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/Vintasoft.Imaging.Dicom.js" type="text/javascript"></script>
          <script src="~/lib/Vintasoft/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:
        <div class="text-center">
            <h1>VintaSoft DICOM Viewer Demo (ASP.NET Core)</h1>
        
            <div id="dicomControlContainer" class="dicomControlContainer"></div>
        </div>
        
        

      • Open "wwwroot\css\site.css" file, add CSS-style for "dicomControlContainer" to the "site.css" file:
        html {
          font-size: 14px;
        }
        
        @media (min-width: 768px) {
          html {
            font-size: 16px;
          }
        }
        
        .btn:focus, .btn:active:focus, .btn-link.nav-link:focus, .form-control:focus, .form-check-input:focus {
          box-shadow: 0 0 0 0.1rem white, 0 0 0 0.25rem #258cfb;
        }
        
        html {
          position: relative;
          min-height: 100%;
        }
        
        body {
          margin-bottom: 60px;
        }
        
        .form-floating > .form-control-plaintext::placeholder, .form-floating > .form-control::placeholder {
          color: var(--bs-secondary-color);
          text-align: end;
        }
        
        .form-floating > .form-control-plaintext:focus::placeholder, .form-floating > .form-control:focus::placeholder {
          text-align: start;
        }
        
        .dicomControlContainer {
            height: 800px;
        }
        
        


      • Open file "wwwroot\js\site.js", add JavaScript code that initializes and creates DICOM viewer:

        Here is JavaScript code that initializes and displays DICOM viewer:
        // 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.WebServiceControllerJS("vintasoft/api/MyVintasoftFileApi");
        Vintasoft.Shared.WebServiceJS.defaultDicomService =
            new Vintasoft.Shared.WebServiceControllerJS("vintasoft/api/MyVintasoftDicomApi");
        
        // 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"]);
        
        
    7. Run the ASP.NET Core application and see the result.