New to Telerik Reporting? Start a free 30-day trial

ClientEvents

Class

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.

Definition

Namespace:Telerik.ReportViewer.Html5.WebForms

Assembly:Telerik.ReportViewer.Html5.WebForms.dll

Syntax:

[TypeConverter(typeof(ClientEventsConverter))]
public class ClientEvents

Inheritance: objectClientEvents

Constructors

ClientEvents()

public ClientEvents()

Properties

Error

string

Gets or sets the name of the JavaScript function that will be called when an error occurs.

public string Error { get; set; }

Remarks:

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

ExportBegin

string

Gets or sets the name of the JavaScript function that will be called prior to starting the report export command.

public string ExportBegin { get; set; }

Remarks:

The export begin event is triggered before the HTML5 ReportViewer starts generating the export document.

ExportEnd

string

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.

public string ExportEnd { get; set; }

Remarks:

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

InteractiveActionEnter

string

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.

public string InteractiveActionEnter { get; set; }

Remarks:

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

InteractiveActionExecuting

string

Gets or sets the name of the JavaScript function that will be called when an interactive action is being executed.

public string InteractiveActionExecuting { get; set; }

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

string

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.

public string InteractiveActionLeave { get; set; }

Remarks:

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

PageReady

string

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.

public string PageReady { get; set; }

Remarks:

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

PrintBegin

string

Gets or sets the name of the JavaScript function that will be called prior to starting the print report command.

public string PrintBegin { get; set; }

Remarks:

The print begin event is triggered before the HTML5 ReportViewer starts generating the print document.

PrintEnd

string

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.

public string PrintEnd { get; set; }

Remarks:

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

Ready

string

Gets or sets the name of the JavaScript function that will be called when the report viewer template is loaded.

public string Ready { get; set; }

Remarks:

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

RenderingBegin

string

Gets or sets the name of the JavaScript function that will be called when the rendering of the report begins.

public string RenderingBegin { get; set; }

Remarks:

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

RenderingEnd

string

Gets or sets the name of the JavaScript function that will be called when the rendering of the report ends.

public string RenderingEnd { get; set; }

Remarks:

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

UpdateUi

string

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.

public string UpdateUi { get; set; }

Remarks:

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

ViewerToolTipOpening

string

Gets or sets the name of the JavaScript function that will be called when a tooltip is being opened.

public string ViewerToolTipOpening { get; set; }

Remarks:

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