Viewer Events
Information |
Since dashboards and reports use the same unified template format - MRT, methods for loading the template and working with data, the word “report” will be used in the documentation text.
|
In order to write interactive applications it is needed to respond to changes in the application. The event system which is represented in Stimulsoft Report Viewer can be used for this. The following events exist:
onPrepareVariables
Asynchronous event is called before filling in the variables in the report at the beginning of the report rendering. The event occurs immediately after execution onPrepareVariables event of the StiReport object. The event handler argument “event” is an object with the next fields:
|
onBeginProcessData
Asynchronous event is called before requesting the data for the report. The event occurs immediately after execution onBeginProcessData event of the StiReport object. The event handler argument “event” is an object with the next fields:
|
onEndProcessData
Is called after retrieving data for the report. The event occurs immediately after execution onEndProcessData event of the StiReport object. The event handler argument “event” is an object with the next fields:
|
onPrintReport
Asynchronous event is called before printing the report. This is not relevant when viewing dashboards. The event handler argument “event” is an object with the next fields:
|
onBeginExportReport
Asynchronous event is called before export but after applying the export options. The event handler argument “event” is an object with the next fields:
|
onEndExportReport
Asynchronous event is called after export report. The event handler argument “event” is an object with the next fields:
|
onInteraction
Asynchronous event is called while interactive action of the viewer (dynamic sorting, collapsing, drill-down, applying of parameters) until processing values by the report generator. The event handler argument “event” is an object with the next fields:
|
onEmailReport
It is called before sending the report by email. This is not relevant when viewing dashboards. The event handler argument “event” is an object with the next fields:
|
onDesignReport
It is called by pressing the Design button. The event handler argument “event” is an object with the following fields:
|
onShowReport
Asynchronous event is called after a report is rendered before its displaying in the viewer. The event handler argument “event” is an object with the following fields:
|
onOpenReport
Asynchronous event that provides the ability to use custom method of opening templates. The event is called before the dialog box is opened and before report is assigned to the viewer. The event handler argument “event” is an object with the following fields:
|
onOpenedReport
Asynchronous event that provides the ability to change of the report before it is assigned to the viewer. The event is called after report has been opened and before report is assigned to the viewer. The event handler argument “event” is an object with the following fields:
|