All docs
V21.1
21.2 (EAP/Beta)
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

DxReportDesignerCallbacks.PreviewDocumentReady Property

Specifies the JavaScript function that handles the Web Report Designer’s PreviewDocumentReady client-side event.

Namespace: DevExpress.Blazor.Reporting

Assembly: DevExpress.Blazor.Reporting.v21.1.JSBasedControls.dll

Declaration

[Parameter]
public string PreviewDocumentReady { get; set; }

Property Value

Type Description
String

The name of a JavaScript function used to handle the PreviewParametersSubmitted event.

Remarks

The DocumentReady event occurs before the Report Designer Preview loads a document.

The handler function receives two parameters - the first parameter is the client-side Preview (the event sender) and the second parameter is an object with the following properties and methods:

  • ReportId
    The report ID.

  • DocumentId
    The ID of the document that is ready to be displayed in the Report Designer Preview.

  • PageCount
    The total number of pages in a document.

The following code causes the Preview to flip through document pages:

window.ReportingDesignerCustomization = {
    onPreviewDocumentReady: function (s, e) {
        var previewModel = s.GetPreviewModel();
        var goToNextPage = function () {
            var pageIndex = previewModel.GetCurrentPageIndex();
            if (e.PageCount <= pageIndex)
                return;
            previewModel.GoToPage(pageIndex + 1);
            setTimeout(function () { goToNextPage(); }, 3000);
        }
        goToNextPage();
    }
}
See Also