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

 

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

onDatabaseConnect
onBeginProcessData
onEndProcessData
onPrepareVariables
onCreateReport
onOpenReport
onOpenedReport
onSaveReport
onSaveAsReport
onPreviewReport
onExit

 

 

onDatabaseConnect

[-] JavaScript  [+] PHP

 

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

 

 

onBeginProcessData

[+] JavaScript  [+] PHP

 

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

 

 

onEndProcessData

[+] JavaScript  [+] PHP

 

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

 

 

onPrepareVariables

[+] JavaScript  [+] PHP

 

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

 

 

onCreateReport

[+] JavaScript  [+] PHP

 

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

 

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

 

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

Описание

event

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

sender

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

"Designer"

report

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

isWizardUsed

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

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне PHP сервера, аргументы имеют тип StiReportEventArgs:

 

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

Описание

event

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

sender

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

StiDesigner

report

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

isWizardUsed

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

 

 

onOpenReport

[+] JavaScript  [-] PHP

 

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

 

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

Описание

event

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

sender

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

"Designer"

preventDefault

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

 

 

onOpenedReport

[+] JavaScript  [+] PHP

 

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

 

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

Описание

event

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

sender

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

"Designer"

report

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

preventDefault

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

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне PHP сервера, аргументы имеют тип StiReportEventArgs:

 

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

Описание

event

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

sender

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

StiDesigner

report

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

 

 

onSaveReport

[+] JavaScript  [+] PHP

 

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

 

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

 

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

Описание

event

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

sender

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

"Designer"

report

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

fileName

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

autoSave

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

preventDefault

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

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне PHP сервера, аргументы имеют тип StiReportEventArgs:

 

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

Описание

event

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

sender

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

StiDesigner

report

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

fileName

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

autoSave

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

 

 

onSaveAsReport

[+] JavaScript  [+] PHP

 

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

 

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

 

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

Описание

event

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

sender

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

"Designer"

report

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

fileName

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

preventDefault

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

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне PHP сервера, аргументы имеют тип StiReportEventArgs:

 

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

Описание

event

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

sender

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

StiDesigner

report

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

fileName

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

 

 

onPreviewReport

[+] JavaScript  [+] PHP

 

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

 

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

 

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

Описание

event

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

sender

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

"Designer"

report

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

viewer

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

preventDefault

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

 

 

В таблице ниже представлен список свойств, передаваемых в аргументах события на стороне PHP сервера, аргументы имеют тип StiReportEventArgs:

 

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

Описание

event

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

sender

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

StiDesigner

report

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

 

 

onExit

[+] JavaScript  [-] PHP

 

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

 

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

 

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

Описание

event

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

sender

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

"Designer"