ASPxWebDocumentViewer.StaticInitialize() Method

Explicitly starts the Web Document Viewer initialization.

Namespace: DevExpress.XtraReports.Web

Assembly: DevExpress.XtraReports.v18.2.Web.WebForms.dll

Declaration

C#

public static void StaticInitialize()

VB.NET

Public Shared Sub StaticInitialize

Remarks

The ASPxWebDocumentViewer is automatically initialized when rendering on your application’s Web page, but in specific cases, you need to trigger its initialization explicitly (for instance, when an AppPool is recycled).

The StaticInitialize method does the following:

• Calls the static ASPxWebDocumentViewer constructor;
• Registers HttpHandlers required for the Web Document Viewer;
• Initializes all services for processing requests to the corresponding handler.

Use the StaticInitialize method at the application startup in the Global.asax file.

Note

To make the Document Viewer’s handlers work correctly, you should call this method after specifying the session state and registering additional services.

C#

protected void Application_Start(Object sender, EventArgs e) {
    // ...  
   DevExpress.XtraReports.Web.WebDocumentViewer.Native.WebDocumentViewerBootstrapper.SessionState = 
        System.Web.SessionState.SessionStateBehavior.Required;
    // ...  
    DevExpress.XtraReports.Web.ASPxWebDocumentViewer.StaticInitialize();
}

VB.NET

Protected Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    ' ...  
    DevExpress.XtraReports.Web.WebDocumentViewer.Native.WebDocumentViewerBootstrapper.SessionState = 
        System.Web.SessionState.SessionStateBehavior.Required
    ' ...  
    DevExpress.XtraReports.Web.ASPxWebDocumentViewer.StaticInitialize
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the StaticInitialize() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_web-document-viewer-how-to-send-a-report-via-email-from-the-client-side-t566760/CS/CustomDocumentOperationService/Global.asax.cs#L21

DefaultWebDocumentViewerContainer.Register<DocumentOperationService, CustomDocumentOperationService>();
MVCxWebDocumentViewer.StaticInitialize();
AreaRegistration.RegisterAllAreas();

Reporting_How-to-store-and-use-custom-document-data-in-the-Web-Document-Viewer/CS/CustomCachedDocumentSourceSerialization/Global.asax.cs#L12

DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/App_Data/PreviewedDocuments/"));
ASPxWebDocumentViewer.StaticInitialize();

Reporting_How-to-export-documents-with-token-based-authentication-in-the-web-document-viewer/CS/DocumentExportWithTokenBasedAuthentication/Global.asax.cs#L27

    DevExpress.Web.Mvc.MVCxWebDocumentViewer.StaticInitialize();
}

how-to-sync-pivotgrid-and-xrpivotgrid-t438415/CS/DXWebApplication3/Global.asax.cs#L32

    DefaultWebDocumentViewerContainer.Register<IWebDocumentViewerReportResolver, CustomWebDocumentViewerReportResolver>();
    MVCxWebDocumentViewer.StaticInitialize();
}

Reporting_how-to-fit-the-xrpivotgrid-onto-a-page-e4466/CS/WebSite/Global.asax.cs#L13

    DevExpress.XtraReports.Web.ASPxWebDocumentViewer.StaticInitialize();
}

VB.NET

Reporting_web-document-viewer-how-to-send-a-report-via-email-from-the-client-side-t566760/VB/CustomDocumentOperationService/Global.asax.vb#L22

DefaultWebDocumentViewerContainer.Register(Of DocumentOperationService, CustomDocumentOperationService)()
MVCxWebDocumentViewer.StaticInitialize()
AreaRegistration.RegisterAllAreas()

Reporting_How-to-store-and-use-custom-document-data-in-the-Web-Document-Viewer/VB/CustomCachedDocumentSourceSerialization/Global.asax.vb#L14

DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/App_Data/PreviewedDocuments/"))
ASPxWebDocumentViewer.StaticInitialize()

Reporting_How-to-export-documents-with-token-based-authentication-in-the-web-document-viewer/VB/DocumentExportWithTokenBasedAuthentication/Global.asax.vb#L26

    DevExpress.Web.Mvc.MVCxWebDocumentViewer.StaticInitialize()
End Sub

how-to-sync-pivotgrid-and-xrpivotgrid-t438415/VB/DXWebApplication3/Global.asax.vb#L32

    DefaultWebDocumentViewerContainer.Register(Of IWebDocumentViewerReportResolver, CustomWebDocumentViewerReportResolver)()
    MVCxWebDocumentViewer.StaticInitialize()
End Sub

Reporting_how-to-fit-the-xrpivotgrid-onto-a-page-e4466/VB/WebSite/Global.asax.vb#L14

    DevExpress.XtraReports.Web.ASPxWebDocumentViewer.StaticInitialize()
End Sub