Skip to main content

WebDocumentViewerClientSideEventsBuilder.DocumentReady(String) Method

Sets the name of the JavaScript function or the entire code that will handle the Web Document Viewer’s DocumentReady client-side event.

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

Assembly: DevExpress.AspNetCore.Reporting.v22.1.dll

NuGet Package: DevExpress.AspNetCore.Reporting


public WebDocumentViewerClientSideEventsBuilder DocumentReady(
    string callback


Name Type Description
callback String

The name of a JavaScript function or the entire JavaScript function code used to handle the DocumentReady event.


Type Description

A WebDocumentViewerClientSideEventsBuilder object that can be used to further configure the Document Viewer client side events.


The DocumentReady event enables you to respond to loading a report to the Document Viewer. When implementing a handler function, use the objects passed as parameters. The first parameter passes the event sender that is the ClientDocumentViewer object. The second one is an object with the following structure.

  • ReportId
    The report ID.

  • DocumentId
    The ID of the document that is ready to be shown in the Web Document Viewer.

  • PageCount
    The total number of pages in a report document.

Example: Page Navigation

The code sample below demonstrates how to navigate through pages of a document when it is created.

<script type="text/javascript" id="script"> 
    function documentReady(s, e) {
        var previewModel = s.GetPreviewModel();
        var goToNextPage = function () {
            var pageIndex = previewModel.GetCurrentPageIndex();
            if (e.PageCount <= pageIndex)
            previewModel.GoToPage(pageIndex + 1);
            setTimeout(function () { goToNextPage(); }, 3000);

    var documentViewer = Html.DevExpress().WebDocumentViewer("webDocumentViewer1")
        .ClientSideEvents(configure => { configure.DocumentReady("documentReady"); });;

Example: Show the Document Map Panel Automatically

The following code sample shows the Document Map Panel when the Document Viewer has loaded a report and the document has been built:

    var viewerRender = Html.DevExpress().WebDocumentViewer("DocumentViewer")
        .ClientSideEvents(configure =>
            configure.DocumentReady(@"function(s, e) {
                var preview = s.GetPreviewModel();
                if (preview)
See Also