Designer Events
The designer supports the events, which allow you to make necessary operations before definite actions both on the JavaScript client-side and on the PHP server-side. To make the events work on the client-side you don't need any additional settings. To make the events work on the server-side, you should add a special event handler to the page. You can find a detailed description and settings of the PHP event handler in the PHP Events Handler.
The designer supports the following events:
The event is invoked before data request, which are needed to render a report. You can find the list of arguments of the event in the Engine Events chapter. You can find a detailed description and samples of using in the Connecting Data Files and Connecting SQL Data Adapters chapters.
The event is invoked after loading data before rendering a report. You can find the list of arguments of the event in the Engine Events chapter. You can find a detailed description and samples of using in the Connecting Data Files and Connecting SQL Data Adapters chapters.
The event is invoked before rendering a report after preparing report variables. You can find the list of arguments of the event in the Engine Events chapter. You can find a detailed description and samples of using in the Connecting Data Files and Connecting SQL Data Adapters chapters.
The event is invoked after creation a new report in the designer. In the table below you can see the list of arguments of the event handler on the JavaScript client-side.
Name |
Description |
||
event |
The identifier of the current event has the "CreateReport" value. |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
Current report object. |
||
isWizardUsed |
The flag indicates that a new report is created with the help of the master (the true value) or a blank report is created (the false value). |
In the table below, you can see the list of the event handler arguments on the PHP server-side.
Name |
Description |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
The current report presented as an object. |
||
isWizardUsed |
The flag indicates that a new report is created with the help of the master (the true value) or a blank report is created (the false value). |
The event is invoked before opening a report from the designer menu. In the table below, you can see the list of the event handler arguments on the JavaScript client-side.
Name |
Description |
||
event |
The identifier of the current event has the "OpenReport" value. |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
preventDefault |
This flag allows you to stop further event processing by the designer. The true value is set by default. |
The event is invoked when saving a report in the designer. In the table below, you can see the list of the event handler arguments on the JavaScript client-side.
Name |
Description |
||
event |
The identifier of the current event has the "SaveReport" value. |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
Current report object. |
||
fileName |
Report file name for saving. |
||
preventDefault |
This flag allows you to stop further event processing by the designer. The true value is set by default. |
In the table below, you can see the list of the event handler arguments on the PHP server-side.
Name |
Description |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
The current report presented as an object. |
||
reportJson |
The current report presented as a JSON string. |
||
fileName |
Report file name for saving |
The event is invoked when saving a report in the designer with a preliminary input of the file name. In the table below, you can see the list of the event handler arguments on the JavaScript client-side.
Name |
Description |
||
event |
The identifier of the current event has the "SaveAsReport" value. |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
Current report object. |
||
fileName |
Report file name for saving. |
||
preventDefault |
This flag allows you to stop further event processing by the designer. The true value is set by default. |
In the table below, you can see the list of the event handler arguments on the PHP server-side.
Name |
Description |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
The current report presented as an object. |
||
reportJson |
The current report presented as a JSON string. |
||
fileName |
Report file name for saving. |
The event is invoked when going to the report view tab. In the table below, you can see the list of the event handler arguments on the JavaScript client-side.
Name |
Description |
||
event |
The identifier of the current event has the "PreviewReport" value. |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|
||
report |
Current report object. |
||
fileName |
Report file name for saving. |
||
preventDefault |
This flag allows you to stop further event processing by the designer. The true value is set by default. |
The event is invoked when clicking the Exit button in the main menu of the designer. In the table below, you can see the list of the event handler arguments on the JavaScript client-side.
Name |
Description |
||
event |
The identifier of the current event has the "Exit" value. |
||
sender |
The identifier of the component, which initiated this event can take the following values:
|