ReportDesigner.ActionHandlers
Interface: ActionHandlers
ReportDesigner.ActionHandlers
Represents toolbar buttons actions and hotkeys action handlers
Table of contents
Methods
Methods
onCreate
▸ Optional onCreate(): Promise<undefined | Report | NewReport>
Called on open report.
Returns
Promise<undefined | Report | NewReport>
Promise with report info or 'undefined' if operation was cancelled.
onOpen
▸ Optional onOpen(): Promise<undefined | Report>
Called on opening report.
Returns
Promise<undefined | Report>
Promise with report info or 'undefined' if operation was cancelled.
onOpenFileMenu
▸ Optional onOpenFileMenu(): void
Called on open custom file menu.
Returns
void
onRender
▸ Optional onRender(report, resourceLocator?): Promise<void>
Called on render current report.
Parameters
| Name | Type | Description |
|---|---|---|
report |
ReportDefinition |
Current report info. |
resourceLocator? |
Partial<ResourceLocator> |
ResourceLocator instance. |
Returns
Promise<void>
onSave
▸ Optional onSave(options): Promise<undefined | SaveResult>
Called on saving report.
Parameters
| Name | Type | Description |
|---|---|---|
options |
SaveReportInfo |
Current report info. |
Returns
Promise<undefined | SaveResult>
Promise with new report info if report was saved or 'undefined' if operation was cancelled.
onSaveAs
▸ Optional onSaveAs(options): Promise<undefined | SaveAsResult>
Called on saving report as new.
Parameters
| Name | Type | Description |
|---|---|---|
options |
SaveNewReportInfo |
Current report info. |
Returns
Promise<undefined | SaveAsResult>
Promise with new report info if report was saved or 'undefined' if operation was cancelled.