Creating a Server Side for the Web Document Viewer

• Dec 28, 2021
• 2 minutes to read

This document describes how to create and configure an ASP.NET MVC application as a server-side solution for using the HTML5 Document Viewer in JavaScript:

1. Create a new ASP.NET MVC project using the Template Gallery and enable the Report Suite to include all the required resources automatically. Refer to Adding a New Report to an ASP.NET MVC Application for a step-by-step tutorial.

   You can provide reporting functionality to an existing MVC application by registering the required extensions as described in Manual Integration of ASP.NET MVC Reporting Extensions Into an Existing Project.

2. Implement your custom MVC controller by inheriting it from the WebDocumentViewerApiController class. Override the DevExpress.Web.Mvc.Controllers.WebDocumentViewerApiController.Invoke action to allow cross-domain requests:

   C#

   using System.Web.Mvc;
   using DevExpress.Web.Mvc.Controllers;
   //...
   
   public class WebDocumentViewerController : WebDocumentViewerApiController {
       //...
       public override ActionResult Invoke() {
           var result = base.Invoke();
           Response.AppendHeader("Access-Control-Allow-Origin", "*");
           return result;
       }
   }
   

   VB.NET

   Imports System.Web.Mvc
   Imports DevExpress.Web.Mvc.Controllers
   '...
   
   Public Class WebDocumentViewerController
       '...
       Inherits WebDocumentViewerApiController
       Public Overrides Function Invoke() As ActionResult
           Dim result = MyBase.Invoke()
           Response.AppendHeader("Access-Control-Allow-Origin", "*")
           Return result
       End Function
   End Class
   

   Additionally, override the DevExpress.Web.Mvc.Controllers.WebDocumentViewerApiController.GetLocalization action in the same way if you need to customize localization strings.

3. Provide a server-side report storage by inheriting from the ReportStorageWebExtension class and overriding its methods.

   C#

   using DevExpress.XtraReports.Web.Extensions;
   
   public class MyReportStorage : ReportStorageWebExtension {
      // ...
   }
   

   VB.NET

   Imports DevExpress.XtraReports.Web.Extensions
   
   Public Class MyReportStorage
       Inherits ReportStorageWebExtension
       ' ...
   End Class
   

   Register the custom web report storage using the static ReportStorageWebExtension.RegisterExtensionGlobal method on the application’s startup.

   C#

   using DevExpress.XtraReports.Web.Extensions;
   
   protected void Application_Start() {
       // ...
       ReportStorageWebExtension.RegisterExtensionGlobal(new MyReportStorage());
   }
   

   VB.NET

   Imports DevExpress.XtraReports.Web.Extensions
   
   Protected Sub Application_Start()
       ' ...
       ReportStorageWebExtension.RegisterExtensionGlobal(New MyReportStorage())
   End Sub