Дизайнер отчетов поддерживает события, которые предоставляют возможность выполнить необходимые операции перед определенными действиями - как на стороне JavaScript клиента, так и на стороне Python сервера. Подробное описание работы событий находится в разделе События генератора отчетов.

 

Некоторые аргументы событий принимают значения из перечислений, которые находятся в определенных пространствах имен. Все используемые в событиях дизайнера перечисления указаны в блоке кода ниже:

 

app.py

 

from stimulsoft_reports.enums import StiEventType

 

 

 

Дизайнер поддерживает следующие события:

•onPrepareVariables
•onBeginProcessData
•onEndProcessData
•onCreateReport
•onOpenReport
•onOpenedReport
•onSaveReport
•onSaveAsReport
•onPreviewReport
•onExit

 

onPrepareVariables

[v] JavaScript  [v] Python

 

Событие вызывается перед построением отчета после подготовки переменных отчета. Список аргументов события находится в разделе События генератора отчетов. Подробное описание и примеры использования находятся в разделе Работа с переменными отчета.

 

 

onBeginProcessData

[v] JavaScript  [v] Python

 

Событие вызывается перед запросом данных, необходимых для построения отчета. Список аргументов события находится в разделе События генератора отчетов. Подробное описание и примеры использования находятся в разделах Подключение файловых данных и Подключение SQL адаптеров данных.

 

 

onEndProcessData

[v] JavaScript  [v] Python

 

Событие вызывается после загрузки данных перед построением отчета. Список аргументов события находится в разделе События генератора отчетов. Подробное описание и примеры использования находятся в разделах Подключение файловых данных и Подключение SQL адаптеров данных.

 

 

onCreateReport

[v] JavaScript  [v] Python

 

Событие вызывается после создания нового отчета в дизайнере. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "CreateReport".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"

report

Текущий объект отчета.

isWizardUsed

Данный флаг указывает на то, что создание нового отчета осуществляется при помощи мастера (значение true), либо создается пустой отчет (значение false).

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события. По умолчанию установлено значение false.

 

 

Список свойств, передаваемых в аргументах события на стороне Python сервера. Аргументы имеют тип StiReportEventArgs:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.CREATE_REPORT

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiDesigner

report

Текущий объект отчета.

isWizardUsed

Флаг указывает на то, что создание нового отчета осуществляется при помощи мастера (значение True), либо создается пустой отчет (значение False).

 

 

onOpenReport

[v] JavaScript  [x] Python

 

Список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "OpenReport".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события дизайнером. По умолчанию установлено значение true.

 

 

onOpenedReport

[v] JavaScript  [v] Python

 

Событие вызывается после открытия отчета из меню дизайнера до его передачи в сам дизайнер.

 

Список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "OpenReport".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"

report

Текущий объект отчета.

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события дизайнером. По умолчанию установлено значение true.

 

 

Список свойств, передаваемых в аргументах события на стороне Python сервера. Аргументы имеют тип StiReportEventArgs:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.OPENED_REPORT

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiDesigner

report

Текущий объект отчета.

 

 

onSaveReport

[v] JavaScript  [v] Python

 

Событие вызывается при сохранении отчета в дизайнере. В таблице ниже представлен список аргументов обработчика событий на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "SaveReport".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"

report

Текущий объект отчета.

fileName

Имя файла отчета для сохранения.

autoSave

Данный флаг на то, что сохранение отчета осуществляется автоматически (значение true), либо при нажатии на кнопку сохранения (значение false).

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события дизайнером. По умолчанию установлено значение false.

 

 

Список свойств, передаваемых в аргументах события на стороне Python сервера. Аргументы имеют тип StiReportEventArgs:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.SAVE_REPORT

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiDesigner

report

Текущий отчет, представленный в виде объекта.

fileName

Имя файла отчета для сохранения.

autoSave

Данный флаг на то, что сохранение отчета осуществляется автоматически (значение True), либо при нажатии на кнопку сохранения (значение False).

 

 

onSaveAsReport

[v] JavaScript  [v] Python

 

Событие вызывается при сохранении отчета в дизайнере с предварительным вводом имени файла. Список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "SaveAsReport".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"

report

Текущий объект отчета.

fileName

Имя файла отчета для сохранения.

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события дизайнером. По умолчанию установлено значение false.

 

 

Список свойств, передаваемых в аргументах события на стороне Python сервера. Аргументы имеют тип StiReportEventArgs:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.SAVE_AS_REPORT

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiDesigner

report

Текущий объект отчета.

fileName

Имя файла отчета для сохранения.

 

 

onPreviewReport

[v] JavaScript  [v] Python

 

Событие вызывается при переходе на вкладку предварительного просмотра отчета.

 

Список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "PreviewReport".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"

report

Текущий объект отчета.

viewer

Текущий объект встроенного в дизайнер компонента вьвера.

preventDefault

Данный флаг предоставляет возможность остановить дальнейшую обработку события дизайнером. По умолчанию установлено значение true.

 

 

Список свойств, передаваемых в аргументах события на стороне Python сервера. Аргументы имеют тип StiReportEventArgs:

 

Наименование

Описание

event

Идентификатор текущего события, для данного события имеет значение StiEventType.PREVIEW_REPORT

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•StiDesigner

report

Текущий объект отчета.

 

 

onExit

[v] JavaScript  [x] Python

 

Событие вызывается при нажатии на кнопку Выход (Exit) в главном меню дизайнера.

 

Список свойств, передаваемых в аргументах события на стороне JavaScript клиента:

 

Наименование

Описание

event

Идентификатор текущего события, имеет значение "Exit".

sender

Идентификатор компонента, который инициировал данное событие, может принимать следующие значения:

•"Designer"