События

В процессе подготовки печатной формы, можно перехватить некоторые события конструктора и сделать обработку данных, внести изменения или вообще отказаться от печати макета или области. Для этого предусмотрены “Алгоритмы”.

ПередИнициализацией

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
МассивОбъектов	Массив	Массив ссылок для формирования печатных форм	+
ВнешниеПараметры	Произвольный	Входящие параметры, переданные при вызове метода Печать
ПараметрыКоманды	Структура	Параметры команды подсистемы УправлениеПечатью. Изменения принимаются исполнителем. ВАЖНО: при тестовой печати параметры команды не заполняются	+
Отказ	Булево	Признак необходимости прервать обработку данных	+
ТекстОтказа	Строка	Текст ошибки, который увидит пользователь при отказе	+
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

Структура параметра ПараметрыКоманды (заполняется подсистемой «Управление печатью» БСП):

Ключ	Тип	Описание
ПараметрыПечати	Структура	Настройки печати. Только чтение
КоллекцияПечатныхФорм	ТаблицаЗначений / Соответствие	Табличные документы (для офисных макетов — соответствие)
ОбъектыПечати	СписокЗначений	Разбивка областей табличного документа по напечатанным объектам
ПараметрыВывода	Структура	Параметры сформированных табличных документов

ПриПолученииДанных

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ДанныеМакета	ДанныеМакета	Коллекция данных с результатами запросов	+
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

ПередФормированием

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ТабличныйДокумент	ТабличныйДокумент	Табличный документ для вывода печатной формы	+
ТекущаяСсылка	ЛюбаяСсылка	Ссылка для формирования печатной формы. Если выполняется печать реестра, значение пустое
НаборыДанных	НаборыДанных	Данные наборов, подготовленные для использования при печати
Отказ	Булево	Признак отказа от формирования печатной формы	+
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

ПередВыводомСтраницы

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ТабличныйДокумент	ТабличныйДокумент	Табличный документ для вывода печатной формы	+
ТекущаяСсылка	ЛюбаяСсылка	Ссылка для формирования печатной формы. Если выполняется печать реестра, значение пустое
НаборыДанных	НаборыДанных	Данные наборов, подготовленные для использования при печати
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

ПередВыводомОбласти

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ТабличныйДокумент	ТабличныйДокумент	Табличный документ для вывода печатной формы	+
ТекущаяСсылка	ЛюбаяСсылка	Ссылка для формирования печатной формы. Если выполняется печать реестра, значение пустое
НаборыДанных	НаборыДанных	Данные наборов, подготовленные для использования при печати
Отказ	Булево	Признак необходимости пропустить вывод области. На формирование остальной печатной формы не влияет	+
ИмяОбласти	Строка	Имя области для вывода в печатную форму
ОбластьМакета	ТабличныйДокумент	Сформированная область макета с заполненными значениями параметров	+
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

ПослеВыводаОбласти

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ТабличныйДокумент	ТабличныйДокумент	Табличный документ для вывода печатной формы	+
ТекущаяСсылка	ЛюбаяСсылка	Ссылка для формирования печатной формы. Если выполняется печать реестра, значение пустое
НаборыДанных	НаборыДанных	Данные наборов, подготовленные для использования при печати
ИмяОбласти	Строка	Имя области для вывода в печатную форму
НачалоОбласти	Число	Номер первой строки выведенной области в табличном документе
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

ПослеВыводаСтраницы

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ТабличныйДокумент	ТабличныйДокумент	Табличный документ для вывода печатной формы	+
НачалоСтраницы	Число	Номер первой строки, с которой начинается вывод страницы
ТекущаяСсылка	ЛюбаяСсылка	Ссылка для формирования печатной формы. Если выполняется печать реестра, значение пустое
НаборыДанных	НаборыДанных	Данные наборов, подготовленные для использования при печати
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

ПослеФормирования

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

Имя параметра	Тип значения	Описание	Изменение
ЭтотМакет	Исполнитель	Исполнитель печатной формы. Через него доступны функции макета и методы работы с областями
ТабличныйДокумент	ТабличныйДокумент	Табличный документ для вывода печатной формы	+
ТекущаяСсылка	ЛюбаяСсылка	Ссылка для формирования печатной формы. Если выполняется печать реестра, значение пустое
НаборыДанных	НаборыДанных	Данные наборов, подготовленные для использования при печати
ДополнительныеСвойства	Структура	Коллекция для передачи данных между событиями	+

Методы исполнителя в обработчиках

Через переменную ЭтотМакет в обработчиках доступны методы программного интерфейса исполнителя — работа с областями макета, объединение ячеек, группировка строк и колонок. Полный справочник методов с сигнатурами — в главе API pw_Исполнитель.

В событии ПослеВыводаОбласти для макетов с табличным документом доступны:

ЭтотМакет.ОбъединитьЯчейки(ТабличныйДокумент, ИмяОбласти)
ЭтотМакет.ОбъединитьЯчейки(ТабличныйДокумент, ПерваяСтрока, ПерваяКолонка, ПоследняяСтрока, ПоследняяКолонка)
ЭтотМакет.СгруппироватьСтроки(ТабличныйДокумент, ПерваяСтрока, ПоследняяСтрока, ИмяГруппы, РасположениеЗаголовка)
ЭтотМакет.СгруппироватьКолонки(ТабличныйДокумент, ПерваяКолонка, ПоследняяКолонка, ИмяГруппы, РасположениеЗаголовка)

Точный состав доступных переменных и методов для каждого события всегда показывает подсказка над полем алгоритма в редакторе — она собирается по фактическому поведению исполнителя.

Общие параметры событий

Структура ДанныеМакета

Ключ - имя запроса как оно задано в макете
Значение - Структура - данные запроса, ключи структуры:
- Ключ - Строка - ключ запроса из данных макета
- Имя - Строка - имя запроса как оно задано в макете
- Данные - ТаблицаЗначений - результат выполнения запроса; таблицу можно изменять

Структура НаборыДанных

Ключ - имя набора как оно задано в макете
Значение - зависит от вида набора
- Первая/Последняя строка - Структура
  - Ключ - Строка - имя поля набора
  - Значение - Произвольный - значение поля набора
- Соединение строк - Структура
  - Ключ - Строка - имя поля набора
  - Значение - Массив - массив уникальных значений поля набора
- Многострочная коллекция - Структура - имена ключей:
  - Коллекция - ТаблицаЗначений - все данные набора
  - Строка - Структура - значения текущей строки для вывода, заполняется только для событий ПередВыводомОбласти, ПослеВыводаОбласти
    - Ключ - Строка - имя поля набора
    - Значение - Произвольный - значение поля набора
  - Итог - Структура - итоги по числовым колонкам набора
    - Ключ - Строка - имя поля набора
    - Значение - Структура - агрегаты этого поля: Сумма, Количество, Максимум, Минимум, Среднее, ИтогНакопительный, ИтогПоСтранице, ПроцентКИтогу. В структуру попадают только те агрегаты, которые включены для поля в дереве доступных полей
  - КоличествоСтрок - Число - значение с количеством строк в наборе