Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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.v24.2.JSBasedControls.Common.dll

NuGet Package: DevExpress.Blazor.Reporting.JSBasedControls.Common

#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