Document Viewer Requirements and Limitations

  • 4 minutes to read

Document Viewer Requirements

Required Libraries

The Web Document Viewer requires the following libraries:

To include these script libraries in a client application, do one of the following:

  • Automatic Integration

    Add the resources section to the application's Web.config file to include client-side libraries on the web page:

    <devExpress>
        <!-- ... -->
        <resources>
            <add type="ThirdParty" />
            <add type="DevExtreme" />
        </resources>
    </devExpress>
    
    NOTE

    The DevExpress Analytics Components library is attached automatically.

  • Manual Integration

    You can prevent a control from loading libraries automatically (e.g., when libraries are already referenced on the web page).

    • Declare an empty resources section in the Web.config file.

      <resources>
      </resources>
      
    • Attach the following scripts and stylesheets to the <head> section of the page:

      <html>
      <head>
          <script src="Scripts/jquery-3.5.1.js" type="text/javascript"></script>
          <script src="Scripts/jquery-ui-1.12.1.custom.min.js" type="text/javascript"></script>
          <script src="Scripts/knockout-3.5.0.js" type="text/javascript"></script>
      
          <link href="Content/themes/base/jquery-ui.css" type="text/css" rel="Stylesheet" />
          ...
      </head>
      ...
      </html>
      
      TIP

      You can use the following links to download scripts from npm:

    NOTE

    If you remove the DevExpress resources section from the Web.config file, only DevExtreme libraries are loaded. For more information, review the following help topic: Embed Third-Party Libraries.

For a list of supported web browsers, refer to the following help topic: Supported Browsers.

Register HTTP Handlers

Register ASPxHttpHandlerModule (DXXRDV.axd) in the web.config file as a module to process resources and as a handler to process data.

The ASPxHttpHandlerModule is automatically registered in this file in the following cases:

If you create the Document Viewer in code, you should register ASPxHttpHandlerModule explicitly. Insert the declarations in the system.web/httpModules and system.webServer/modules configuration sections, and add the handler registration to the system.web/httpHandlers and system.webServer/handlers sections.

<system.web>
...
  <httpHandlers>
    ...
    <add type="DevExpress.Web.ASPxHttpHandlerModule, DevExpress.Web.v20.1, Version=20.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" 
         verb="GET,POST" path="DXXRDV.axd" validate="false" />
  </httpHandlers>  
  <httpModules>
    <add type="DevExpress.Web.ASPxHttpHandlerModule, DevExpress.Web.v20.1, Version=20.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" name="ASPxHttpHandlerModule" />
  </httpModules>
</system.web>
<system.webServer>
  <handlers>
    ...
    <add type="DevExpress.Web.ASPxHttpHandlerModule, DevExpress.Web.v20.1, Version=20.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" 
         verb="GET,POST" path="DXXRDV.axd" name="ASPxWebDocumentViewerHandlerModule" preCondition="integratedMode" />
  </handlers>
  <modules runAllManagedModulesForAllRequests="true">
    <add type="DevExpress.Web.ASPxHttpHandlerModule, DevExpress.Web.v20.1, Version=20.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" name="ASPxHttpHandlerModule" />
  </modules>
</system.webServer>

The Document Viewer validates the configuration and displays the following error message if the handler is not registered.

"The DXXRDV.axd handler is not registered in the web.config (section: system.webServer/handlers). To disable web.config validation, use the DevExpress.Web.Mvc.WebDocumentViewerSettings.DisableHttpHandlerValidation property."

Do not use handlers and/or validate their registration in the following cases:

  • You use custom HTTP handlers or MVC controllers to process requests.
  • Handlers are registered in the <location> section, and automatic validation fails.

To disable automatic handler validation, set the WebDocumentViewerSettings.DisableHttpHandlerValidation option to true:

@Html.DevExpress().WebDocumentViewer(settings => {
    settings.Name = "WebDocumentViewer";
    settings.DisableHttpHandlerValidation = true;
}).Bind(Model.Report).GetHtml();

Document Viewer Limitations

  • The following document formats do not support export to multiple files:

    You can export a report to any of these formats as a single file or as a single file page-by-page (one file that contains multiple pages).

  • The Document Viewer prints a report by converting it to PDF and printing the PDF. This approach requires browser support for PDF.

  • The Web Document Viewer is not fully compliant with web accessibility guidelines. For more information on web accessibility in DevExpress controls, refer to the following help topic: Accessibility Support.