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

 

Вьювер поддерживает следующие события:

•onBeginProcessData
•onEndProcessData
•onPrepareVariables
•onPrintReport
•onBeginExportReport
•onEndExportReport
•onInteraction
•onEmailReport
•onDesignReport

 

 

onBeginProcessData

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

 

 

onEndProcessData

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

 

 

onPrepareVariables

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

 

 

onPrintReport

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

 

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

Описание

event

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

sender

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

•Viewer
•Designer

report

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

printAction

Тип печати отчета. Может принимать следующие значения:

•PrintPdf - печать в PDF формат;
•PrintWithoutPreview - печать в HTML формат непосредственно на принтер, будет отображен системный диалог печати;
•PrintWithPreview - печать в HTML формат с предварительным просмотром во всплывающем окне.

fileName

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

preventDefault

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

 

 

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

 

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

Описание

sender

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

•StiComponentType::Viewer
•StiComponentType::Designer

printAction

Тип печати отчета. Может принимать следующие значения:

•StiPrintAction::PrintPdf - печать в PDF формат;
•StiPrintAction::PrintWithoutPreview - печать в HTML формат непосредственно на принтер, будет отображен системный диалог печати;
•StiPrintAction::PrintWithPreview - печать в HTML формат с предварительным просмотром во всплывающем окне.

fileName

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

 

 

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

 

 

onBeginExportReport

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

 

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

Описание

event

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

sender

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

•Viewer
•Designer

action

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

•Stimulsoft.Viewer.StiExportAction.ExportReport
•Stimulsoft.Viewer.StiExportAction.SendEmail

report

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

format

Выбранный формат экспорта отчета. Может принимать следующие значения:

•Stimulsoft.Report.StiExportFormat.Document
•Stimulsoft.Report.StiExportFormat.Pdf
•Stimulsoft.Report.StiExportFormat.Xps
•Stimulsoft.Report.StiExportFormat.PowerPoint
•Stimulsoft.Report.StiExportFormat.Html
•Stimulsoft.Report.StiExportFormat.Html5
•Stimulsoft.Report.StiExportFormat.Text
•Stimulsoft.Report.StiExportFormat.Word
•Stimulsoft.Report.StiExportFormat.Excel2007
•Stimulsoft.Report.StiExportFormat.Odt
•Stimulsoft.Report.StiExportFormat.Ods
•Stimulsoft.Report.StiExportFormat.Csv
•Stimulsoft.Report.StiExportFormat.ImageSvg

formatName

Название выбранного формата экспорта отчета, соответствует названию констант в перечислении форматов.

settings

Настройки выбранного формата экспорта. Список доступных свойств будет зависеть от выбранного типа экспорта.

fileName

Имя файла отчета для сохранения после завершения экспорта.

openAfterExport

Флаг указывает на то, что экспортирование отчета будет происходить в новой вкладке браузера (значение true), либо по завершению экспорта будет вызвано сохранение файла (значение false).

preventDefault

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

 

 

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

 

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

Описание

sender

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

•StiComponentType::Viewer
•StiComponentType::Designer

action

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

•StiExportAction::ExportReport
•StiExportAction::SendEmail

format

Выбранный формат экспорта отчета. Может принимать следующие значения:

•StiExportFormat::Document
•StiExportFormat::Pdf
•StiExportFormat::Xps
•StiExportFormat::PowerPoint
•StiExportFormat::Html
•StiExportFormat::Html5
•StiExportFormat::Text
•StiExportFormat::Word
•StiExportFormat::Excel2007
•StiExportFormat::Odt
•StiExportFormat::Ods
•StiExportFormat::Csv
•StiExportFormat::ImageSvg

formatName

Название выбранного формата экспорта отчета, соответствует названию констант в перечислении форматов.

fileName

Имя файла отчета для сохранения после завершения экспорта.

settings

Настройки выбранного формата экспорта. Список доступных свойств будет зависеть от выбранного типа экспорта.

 

 

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

 

 

onEndExportReport

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

 

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

Описание

event

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

sender

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

•Viewer
•Designer

report

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

format

Выбранный формат экспорта отчета. Может принимать следующие значения:

•Stimulsoft.Report.StiExportFormat.Document
•Stimulsoft.Report.StiExportFormat.Pdf
•Stimulsoft.Report.StiExportFormat.Xps
•Stimulsoft.Report.StiExportFormat.PowerPoint
•Stimulsoft.Report.StiExportFormat.Html
•Stimulsoft.Report.StiExportFormat.Html5
•Stimulsoft.Report.StiExportFormat.Text
•Stimulsoft.Report.StiExportFormat.Word
•Stimulsoft.Report.StiExportFormat.Excel2007
•Stimulsoft.Report.StiExportFormat.Odt
•Stimulsoft.Report.StiExportFormat.Ods
•Stimulsoft.Report.StiExportFormat.Csv
•Stimulsoft.Report.StiExportFormat.ImageSvg

formatName

Название выбранного формата экспорта отчета, соответствует названию констант в перечислении форматов.

data

Байтовые данные экспортированного отчета, подготовленные для сохранения в файл.

fileName

Имя файла отчета для сохранения после завершения экспорта.

openAfterExport

Флаг указывает на то, что экспортирование отчета будет происходить в новой вкладке браузера (значение true), либо по завершению экспорта будет вызвано сохранение файла (значение false).

preventDefault

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

 

 

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

 

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

Описание

sender

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

•StiComponentType::Viewer
•StiComponentType::Designer

format

Выбранный формат экспорта отчета. Может принимать следующие значения:

•StiExportFormat::Document
•StiExportFormat::Pdf
•StiExportFormat::Xps
•StiExportFormat::PowerPoint
•StiExportFormat::Html
•StiExportFormat::Html5
•StiExportFormat::Text
•StiExportFormat::Word
•StiExportFormat::Excel2007
•StiExportFormat::Odt
•StiExportFormat::Ods
•StiExportFormat::Csv
•StiExportFormat::ImageSvg

formatName

Название выбранного формата экспорта отчета, соответствует названию констант в перечислении форматов.

data

Байтовые данные экспортированного отчета, подготовленные для сохранения в файл.

fileName

Имя файла отчета для сохранения после завершения экспорта.

fileExtension

Расширение файла отчета для сохранения после завершения экспорта, соответствует типу выбранного формата.

 

 

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

 

 

onInteraction

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

 

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

Описание

event

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

sender

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

•Viewer
•Designer

report

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

action

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

•Sorting - действие происходит при использовании сортировки колонок;
•DrillDown - действие происходит при использовании сортировки колонок;
•Collapsing - действие происходит при использовании сворачивания блоков отчета.

variables

Коллекция переменных отчета и их значений, заданных на панели параметров.

sortingParameters

Коллекция параметров, необходимых для динамической сортировки отчета.

collapsingParameters

Коллекция параметров, необходимых для динамического сворачивания элементов отчета.

drillDownParameters

Коллекция параметров, необходимых для детализации отчета.

 

 

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

 

 

onEmailReport

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

 

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

Описание

event

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

sender

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

•Viewer
•Designer

report

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

format

Выбранный формат экспорта отчета. Может принимать следующие значения:

•Stimulsoft.Report.StiExportFormat.Document
•Stimulsoft.Report.StiExportFormat.Pdf
•Stimulsoft.Report.StiExportFormat.Xps
•Stimulsoft.Report.StiExportFormat.PowerPoint
•Stimulsoft.Report.StiExportFormat.Html
•Stimulsoft.Report.StiExportFormat.Html5
•Stimulsoft.Report.StiExportFormat.Text
•Stimulsoft.Report.StiExportFormat.Word
•Stimulsoft.Report.StiExportFormat.Excel2007
•Stimulsoft.Report.StiExportFormat.Odt
•Stimulsoft.Report.StiExportFormat.Ods
•Stimulsoft.Report.StiExportFormat.Csv
•Stimulsoft.Report.StiExportFormat.ImageSvg

formatName

Название выбранного формата экспорта отчета, соответствует названию констант в перечислении форматов.

data

Байтовые данные экспортированного отчета, подготовленные для отправки по Email.

fileName

Имя файла отчета для отправки по Email.

settings

Объект, содержащий параметры, заполненные в диалоге вьювера отправки отчета по Email. Описание всех параметров находится в отдельной таблице ниже. Все параметры являются обязательными для заполнения (могут быть проверены и заполнены на стороне PHP сервера).

 

 

В таблице ниже представлен список параметров отправки Email на стороне JavaScript клиента:

 

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

Описание

email

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

subject

Тема письма.

message

Текст письма.

 

 

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

 

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

Описание

sender

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

•StiComponentType::Viewer
•StiComponentType::Designer

format

Выбранный формат экспорта отчета. Может принимать следующие значения:

•StiExportFormat::Document
•StiExportFormat::Pdf
•StiExportFormat::Xps
•StiExportFormat::PowerPoint
•StiExportFormat::Html
•StiExportFormat::Html5
•StiExportFormat::Text
•StiExportFormat::Word
•StiExportFormat::Excel2007
•StiExportFormat::Odt
•StiExportFormat::Ods
•StiExportFormat::Csv
•StiExportFormat::ImageSvg

formatName

Название выбранного формата экспорта отчета, соответствует названию констант в перечислении форматов.

data

Байтовые данные экспортированного отчета, подготовленные для отправки по Email.

fileName

Имя файла отчета для отправки по Email.

settings

Объект, содержащий параметры отправки Email на стороне сервера. Описание всех параметров находится в отдельной таблице ниже.

 

 

В таблице ниже представлен список параметров отправки Email на стороне PHP сервера:

 

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

Описание

from

Email адрес отправителя письма.

name

Имя и фамилия отправителя письма.

to

Email адрес, на который будет отправлен экспортированный отчет, передается из диалогового окна вьювера.

subject

Тема письма, передается из диалогового окна вьювера.

message

Текст письма, передается из диалогового окна вьювера.

attachmentName

Имя отчета во вложении, по умолчанию используется имя файла отчета.

charset

Кодировка, используемая для текста письма, по умолчанию используется "UTF-8".

host

Адрес SMTP сервера. Является обязательным для заполнения.

port

Порт SMTP сервера, по умолчанию используется 465.

secure

Тип шифрования соединения с почтовым сервером, может использоваться "ssl" (по умолчанию) либо "tls" шифрование.

login

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

password

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

cc

Массив CC (Carbon Copy) адресов вторичных получателей письма.

bcc

Массив BCC (Blind Carbon Copy) адресов скрытых получателей письма.

 

 

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

 

 

onDesignReport

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

 

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

Описание

event

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

sender

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

•Viewer

report

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

fileName

Имя файла отчета для передачи и загрузки в дизайнер.

 

 

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