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.
Definition
Namespace:Telerik.ReportViewer.Mvc
Assembly:Telerik.ReportViewer.Mvc.dll
Syntax:
public interface IClientEventsBuilderMethods
Attaches an event handler that will be called when an error occurs.
IClientEventsBuilder Error(string onError)The name of the JavaScript handler function (without parentheses) that handles error events.
Returns:The current IClientEventsBuilder instance for method chaining.
The error event is triggered when any error occurs during report processing, rendering, or viewer operations.
Attaches an event handler that will be called prior to starting the report export command.
IClientEventsBuilder ExportBegin(string onExportBegin)The name of the JavaScript handler function (without parentheses) that handles the export begin event.
Returns:The current IClientEventsBuilder instance for method chaining.
The export begin event is triggered before the report viewer starts generating the export document.
Attaches an event handler that will be called when the exported document is ready for download, but prior to the actual downloading.
IClientEventsBuilder ExportEnd(string onExportEnd)The name of the JavaScript handler function (without parentheses) that handles the export end event.
Returns:The current IClientEventsBuilder instance for method chaining.
The export end event is triggered when the export document is ready but before the download starts.
Attaches an event handler that will be called when the mouse cursor enters the action's report item area.
IClientEventsBuilder InteractiveActionEnter(string onInteractiveActionEnter)The name of the JavaScript handler function (without parentheses) that handles the interactive action enter event.
Returns:The current IClientEventsBuilder instance for method chaining.
The interactive action enter event is triggered when the mouse hovers over interactive report elements.
Attaches an event handler that will be called when an interactive action is executed.
IClientEventsBuilder InteractiveActionExecuting(string onInteractiveActionExecuting)The name of the JavaScript handler function (without parentheses) that handles the interactive action executing event.
Returns:The current IClientEventsBuilder instance for method chaining.
The interactive action executing event is triggered when user clicks on interactive elements like drill-through links or toggle buttons.
Attaches an event handler that will be called when the mouse cursor leaves the action's report item area.
IClientEventsBuilder InteractiveActionLeave(string onInteractiveActionLeave)The name of the JavaScript handler function (without parentheses) that handles the interactive action leave event.
Returns:The current IClientEventsBuilder instance for method chaining.
The interactive action leave event is triggered when the mouse cursor moves away from interactive report elements.
Attaches an event handler that will be called every time a page from the report is rendered and ready for display.
IClientEventsBuilder PageReady(string onPageReady)The name of the JavaScript handler function (without parentheses) that handles the page ready event.
Returns:The current IClientEventsBuilder instance for method chaining.
The page ready event is triggered when each individual report page completes rendering and is ready for display.
Attaches an event handler that will be called prior to starting the print report command.
IClientEventsBuilder PrintBegin(string onPrintBegin)The name of the JavaScript handler function (without parentheses) that handles the print begin event.
Returns:The current IClientEventsBuilder instance for method chaining.
The print begin event is triggered before the report viewer starts generating the print document.
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.
IClientEventsBuilder PrintEnd(string onPrintEnd)The name of the JavaScript handler function (without parentheses) that handles the print end event.
Returns:The current IClientEventsBuilder instance for method chaining.
The print end event is triggered when the PDF print document is ready but before actual printing occurs.
Attaches an event handler that will be called when the report viewer template is loaded.
IClientEventsBuilder Ready(string onReady)The name of the JavaScript handler function (without parentheses) that handles the ready event.
Returns:The current IClientEventsBuilder instance for method chaining.
The ready event is triggered when the report viewer template and UI components are fully loaded and initialized.
Attaches an event handler that will be called when the rendering of the report begins.
IClientEventsBuilder RenderingBegin(string onRenderingBegin)The name of the JavaScript handler function (without parentheses) that handles the rendering begin event.
Returns:The current IClientEventsBuilder instance for method chaining.
The rendering begin event is triggered when the report viewer starts processing and rendering the report content.
Attaches an event handler that will be called when the rendering of the report ends.
IClientEventsBuilder RenderingEnd(string onRenderingEnd)The name of the JavaScript handler function (without parentheses) that handles the rendering end event.
Returns:The current IClientEventsBuilder instance for method chaining.
The rendering end event is triggered when the report viewer completes processing and rendering the report content.
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.
IClientEventsBuilder UpdateUi(string onUpdateUi)The name of the JavaScript handler function (without parentheses) that handles the UI update event.
Returns:The current IClientEventsBuilder instance for method chaining.
The UI update event is triggered whenever the report viewer interface needs to refresh during user interactions.
Attaches an event handler that will be called when a tooltip is being opened.
IClientEventsBuilder ViewerToolTipOpening(string onViewerToolTipOpening)The name of the JavaScript handler function (without parentheses) that handles the tooltip opening event.
Returns:The current IClientEventsBuilder instance for method chaining.
The tooltip opening event is triggered when tooltips are about to be displayed for report elements or viewer controls.