Class ClientEvents
Represents a configuration class that provides properties for initializing client-side event handlers of the HTML5 WebForms ReportViewer control. Used to specify JavaScript function names that will be executed in response to various report viewer events during report rendering, printing, exporting, and user interaction.
Inheritance
Namespace: Telerik.ReportViewer.Html5.WebForms
Assembly: Telerik.ReportViewer.Html5.WebForms.dll
Syntax
public class ClientEventsRemarks
All event handler properties should contain JavaScript function names (without parentheses) that will be called when the corresponding events occur in the HTML5 ReportViewer.
Constructors
ClientEvents()
Declaration
public ClientEvents()Properties
Error
Gets or sets the name of the JavaScript function that will be called when an error occurs.
Declaration
public string Error { get; set; }Property Value
|
System.String
|
Remarks
The error event is triggered when any error occurs during report processing, rendering, or viewer operations in the HTML5 ReportViewer.
ExportBegin
Gets or sets the name of the JavaScript function that will be called prior to starting the report export command.
Declaration
public string ExportBegin { get; set; }Property Value
|
System.String
|
Remarks
The export begin event is triggered before the HTML5 ReportViewer starts generating the export document.
ExportEnd
Gets or sets the name of the JavaScript function that will be called when the exported document is ready for download, but prior to the actual downloading.
Declaration
public string ExportEnd { get; set; }Property Value
|
System.String
|
Remarks
The export end event is triggered when the export document is ready but before the download starts.
InteractiveActionEnter
Gets or sets the name of the JavaScript function that will be called when the mouse cursor enters the area of a report item's action.
Declaration
public string InteractiveActionEnter { get; set; }Property Value
|
System.String
|
Remarks
The interactive action enter event is triggered when the mouse hovers over interactive report elements in the HTML5 viewer.
InteractiveActionExecuting
Gets or sets the name of the JavaScript function that will be called when an interactive action is being executed.
Declaration
public string InteractiveActionExecuting { get; set; }Property Value
|
System.String
|
Remarks
The interactive action executing event is triggered when user clicks on interactive elements like drill-through links or toggle buttons in the HTML5 viewer.
InteractiveActionLeave
Gets or sets the name of the JavaScript function that will be called when the mouse cursor leaves the area of a report item's action.
Declaration
public string InteractiveActionLeave { get; set; }Property Value
|
System.String
|
Remarks
The interactive action leave event is triggered when the mouse cursor moves away from interactive report elements in the HTML5 viewer.
PageReady
Gets or sets the name of the JavaScript function that will be called every time a page from the report is rendered and ready for display.
Declaration
public string PageReady { get; set; }Property Value
|
System.String
|
Remarks
The page ready event is triggered when each individual report page completes rendering and is ready for display in the HTML5 viewer.
PrintBegin
Gets or sets the name of the JavaScript function that will be called prior to starting the print report command.
Declaration
public string PrintBegin { get; set; }Property Value
|
System.String
|
Remarks
The print begin event is triggered before the HTML5 ReportViewer starts generating the print document.
PrintEnd
Gets or sets the name of the JavaScript function that will be called when the print document (Adobe PDF) is ready for download, but prior to being sent to the printer.
Declaration
public string PrintEnd { get; set; }Property Value
|
System.String
|
Remarks
The print end event is triggered when the PDF print document is ready but before actual printing occurs.
Ready
Gets or sets the name of the JavaScript function that will be called when the report viewer template is loaded.
Declaration
public string Ready { get; set; }Property Value
|
System.String
|
Remarks
The ready event is triggered when the HTML5 ReportViewer template and UI components are fully loaded and initialized.
RenderingBegin
Gets or sets the name of the JavaScript function that will be called when the rendering of the report begins.
Declaration
public string RenderingBegin { get; set; }Property Value
|
System.String
|
Remarks
The rendering begin event is triggered when the HTML5 ReportViewer starts processing and rendering the report content.
RenderingEnd
Gets or sets the name of the JavaScript function that will be called when the rendering of the report ends.
Declaration
public string RenderingEnd { get; set; }Property Value
|
System.String
|
Remarks
The rendering end event is triggered when the HTML5 ReportViewer completes processing and rendering the report content.
UpdateUi
Gets or sets the name of the JavaScript function 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
public string UpdateUi { get; set; }Property Value
|
System.String
|
Remarks
The UI update event is triggered whenever the HTML5 ReportViewer interface needs to refresh during user interactions.
ViewerToolTipOpening
Gets or sets the name of the JavaScript function that will be called when a tooltip is being opened.
Declaration
public string ViewerToolTipOpening { get; set; }Property Value
|
System.String
|
Remarks
The tooltip opening event is triggered when tooltips are about to be displayed for report elements or viewer controls in the HTML5 viewer.