The requested page is not available for the requested platform. You are viewing the content for Default platform.

Report Designer's Client-Side Events

  • 3 min to read

The Web Report Designer control provides an advanced client-side API in addition to the comprehensive server-side object model. This enables web applications based on this control to function more efficiently by combining server-side and client-side processing.

Report Designer's Events

The ReportDesignerClientSideEventsBuilder class exposes methods that allow you to pass client-side events' handlers. To access this class instance, use the ReportDesignerBuilder.ClientSideEvents method.

    var designer = Html.DevExpress().ReportDesigner("reportDesigner1")
        .ClientSideEvents(configure => { configure.CustomizeMenuActions("customizeMenuActions"); });

The Report Designer's client-side events allow you to perform the following actions:

Document Viewer's Events

You can also handle client-side events for the Report Designer's integrated Document Viewer.

The ReportDesignerPreviewClientSideEventsBuilder class exposes methods that allow you to pass these handlers. To access this class instance, use the ReportDesignerClientSideEventsBuilder object's Preview method. This object is available in the ReportDesignerBuilder.ClientSideEvents method.

        .ClientSideEvents(configure => {
            configure.Preview(c => { c.CustomizeElements("previewCustomizeElements"); });

The events listed below allow you to customize the built-in Document Viewer and respond to user actions.

Event Description
PreviewClick Occurs when a report document is clicked.
CustomizeElements Enables you to customize UI elements.
CustomizeMenuActions Allows you to customize toolbar actions.
CustomizeExportOptions Allows you to customize export formats and corresponding export options.
DocumentReady Occurs after a report has been switched to Print Preview.
EditingFieldChanged Occurs each time an editing field's value changes.
ParametersReset Occurs after report parameter values are reset to their default values.
ParametersSubmitted Occurs after report parameter values are submitted.