Interface IClientEventsBuilder

Represents a builder that provides a fluent API for configuring client-side event handlers of the MVC Report Viewer. Used to attach JavaScript functions that respond to various report viewer events during report rendering, printing, exporting, and user interaction.

Namespace: Telerik.ReportViewer.Mvc

Assembly: Telerik.ReportViewer.Mvc.dll

Syntax

public interface IClientEventsBuilder

Remarks

All event handler functions are executed in the client-side JavaScript context of the MVC Report Viewer.

Methods

Error(String)

Attaches an event handler that will be called when an error occurs.

Declaration

IClientEventsBuilder Error(string onError)

Parameters

System.String onError The name of the JavaScript handler function (without parentheses) that handles error events.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The error event is triggered when any error occurs during report processing, rendering, or viewer operations.

ExportBegin(String)

Attaches an event handler that will be called prior to starting the report export command.

Declaration

IClientEventsBuilder ExportBegin(string onExportBegin)

Parameters

System.String onExportBegin The name of the JavaScript handler function (without parentheses) that handles the export begin event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The export begin event is triggered before the report viewer starts generating the export document.

ExportEnd(String)

Attaches an event handler that will be called when the exported document is ready for download, but prior to the actual downloading.

Declaration

IClientEventsBuilder ExportEnd(string onExportEnd)

Parameters

System.String onExportEnd The name of the JavaScript handler function (without parentheses) that handles the export end event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The export end event is triggered when the export document is ready but before the download starts.

InteractiveActionEnter(String)

Attaches an event handler that will be called when the mouse cursor enters the action's report item area.

Declaration

IClientEventsBuilder InteractiveActionEnter(string onInteractiveActionEnter)

Parameters

System.String onInteractiveActionEnter The name of the JavaScript handler function (without parentheses) that handles the interactive action enter event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The interactive action enter event is triggered when the mouse hovers over interactive report elements.

InteractiveActionExecuting(String)

Attaches an event handler that will be called when an interactive action is executed.

Declaration

IClientEventsBuilder InteractiveActionExecuting(string onInteractiveActionExecuting)

Parameters

System.String onInteractiveActionExecuting The name of the JavaScript handler function (without parentheses) that handles the interactive action executing event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The interactive action executing event is triggered when user clicks on interactive elements like drill-through links or toggle buttons.

InteractiveActionLeave(String)

Attaches an event handler that will be called when the mouse cursor leaves the action's report item area.

Declaration

IClientEventsBuilder InteractiveActionLeave(string onInteractiveActionLeave)

Parameters

System.String onInteractiveActionLeave The name of the JavaScript handler function (without parentheses) that handles the interactive action leave event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The interactive action leave event is triggered when the mouse cursor moves away from interactive report elements.

PageReady(String)

Attaches an event handler that will be called every time a page from the report is rendered and ready for display.

Declaration

IClientEventsBuilder PageReady(string onPageReady)

Parameters

System.String onPageReady The name of the JavaScript handler function (without parentheses) that handles the page ready event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The page ready event is triggered when each individual report page completes rendering and is ready for display.

PrintBegin(String)

Attaches an event handler that will be called prior to starting the print report command.

Declaration

IClientEventsBuilder PrintBegin(string onPrintBegin)

Parameters

System.String onPrintBegin The name of the JavaScript handler function (without parentheses) that handles the print begin event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The print begin event is triggered before the report viewer starts generating the print document.

PrintEnd(String)

Attaches an event handler that will be called when the print document (Adobe PDF) is ready for download, but prior to being sent to the printer.

Declaration

IClientEventsBuilder PrintEnd(string onPrintEnd)

Parameters

System.String onPrintEnd The name of the JavaScript handler function (without parentheses) that handles the print end event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The print end event is triggered when the PDF print document is ready but before actual printing occurs.

Ready(String)

Attaches an event handler that will be called when the report viewer template is loaded.

Declaration

IClientEventsBuilder Ready(string onReady)

Parameters

System.String onReady The name of the JavaScript handler function (without parentheses) that handles the ready event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The ready event is triggered when the report viewer template and UI components are fully loaded and initialized.

RenderingBegin(String)

Attaches an event handler that will be called when the rendering of the report begins.

Declaration

IClientEventsBuilder RenderingBegin(string onRenderingBegin)

Parameters

System.String onRenderingBegin The name of the JavaScript handler function (without parentheses) that handles the rendering begin event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The rendering begin event is triggered when the report viewer starts processing and rendering the report content.

RenderingEnd(String)

Attaches an event handler that will be called when the rendering of the report ends.

Declaration

IClientEventsBuilder RenderingEnd(string onRenderingEnd)

Parameters

System.String onRenderingEnd The name of the JavaScript handler function (without parentheses) that handles the rendering end event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The rendering end event is triggered when the report viewer completes processing and rendering the report content.

UpdateUi(String)

Attaches an event handler that will be called every time the UI needs an update; can be used for changing the UI of the report viewer while interacting with reports.

Declaration

IClientEventsBuilder UpdateUi(string onUpdateUi)

Parameters

System.String onUpdateUi The name of the JavaScript handler function (without parentheses) that handles the UI update event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The UI update event is triggered whenever the report viewer interface needs to refresh during user interactions.

ViewerToolTipOpening(String)

Attaches an event handler that will be called when a tooltip is being opened.

Declaration

IClientEventsBuilder ViewerToolTipOpening(string onViewerToolTipOpening)

Parameters

System.String onViewerToolTipOpening The name of the JavaScript handler function (without parentheses) that handles the tooltip opening event.

Returns

IClientEventsBuilder The current IClientEventsBuilder instance for method chaining.

Remarks

The tooltip opening event is triggered when tooltips are about to be displayed for report elements or viewer controls.