Настройка пользовательских кнопок

При выборе типа «Открытие объекта репозитория» задайте дополнительные настройки:

• Открыть объект репозитория. Выберите в раскрывающемся списке объект репозитория, который будет открываться по нажатию кнопки:

Примечание. Объект, используемый в пользовательской кнопке, включается в иерархию объектов, из которых состоит отчёт. Для просмотра иерархии объектов отчёта используйте вкладку «Состоит из» окна «Свойства объекта» в навигаторе объектов.

•  Модуль. Выберите из раскрывающегося списка модуль, написанный на языке Fore. Для кнопки можно задать только один модуль;

• Установите флажок при необходимости:

• Открывать в модальном окне. По умолчанию флажок снят. При установке флажка блокируется работа с родительским отчётом во время открытия объекта;

• Обновлять после закрытия окна. Переключатель становится доступным после установки флажка «Открывать в модальном окне». В раскрывающемся списке выберите листы, которые необходимо обновить после закрытия объекта.

• Задайте параметры для объектов, у которых есть параметры:

• Способ задания. В раскрывающемся списке выберите:

• Не передавать. Значение по умолчанию. При открытии объекта в параметр ничего не будет передаваться;

• Параметр объекта. При открытии объекта в параметр передается значение параметра отчёта или формы ввода;

• Атрибут измерения. При открытии объекта в параметр передается значение атрибута первого элемента или всех элементов выбранного измерения из выделенной в таблице области;

• Вручную. При открытии объекта в параметр передается указанное значение;

• Значение. Наполнение поля зависит от выбранного способа передачи значения:

• если был выбран способ передачи значения «Не передавать», то поле недоступно;

• если был выбран способ передачи значения «Параметр объекта», то в раскрывающемся списке выберите параметр. В списке отображаются доступные параметры отчёта. Список параметров отчёта отфильтрован по типу параметра объекта. Выбрать можно только один параметр;

• если был выбран способ передачи значения «Атрибут измерения», то в раскрывающемся списке выберите атрибут. В списке отображаются все доступные атрибуты всех измерений всех табличных областей в отчёте. Выбрать можно только один атрибут;

• если был выбран способ передачи значения «Вручную», то в поле «Значение» отображается редактор, соответствующий типу параметра. Выбрать можно только один элемент;

• Тип отметки. Раскрывающийся список доступен если был выбран способ передачи значения «Атрибут измерения». В раскрывающемся списке выберите:

• Первый элемент. В параметр передается выбранный атрибут первого элемента измерения из выделения;

• Все элементы. В параметр передаются значения выбранного атрибута всех элементов измерения из выделения.

При выборе типа «Расчёт алгоритма» задайте дополнительные настройки:

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

Примечание. Алгоритм расчёта, используемый в пользовательской кнопке, включается в иерархию объектов, из которых состоит отчёт. Для просмотра иерархии объектов отчёта используйте вкладку «Состоит из» окна «Свойства объекта» в навигаторе объектов.

•  Модуль. Выберите из раскрывающегося списка модуль, написанный на языке Fore. Для кнопки можно задать только один модуль;

• Задайте параметры для алгоритмов расчёта, у которых есть параметры:

• Тип значения. Укажите значения, которые используются при расчёте алгоритма:

• Параметр объекта. В расчёте используется значение параметра объекта;

• Константное значение. В расчёте используется постоянное значение;

• Тип отметки. В зависимости от выбранного типа значения:

• если установлен тип «Параметр объекта», укажите тип отметки, выбрав его из раскрывающегося списка. Допустимые значения: исходная, первый элемент, последний элемент, исходная+дочерние, исходная+дочерние (рекурсивно), дочерние, дочерние (рекурсивно);

• если установлен тип «Константное значение», тип отметки недоступен;

• Схема справочника. Выберите из раскрывающегося списка схему отметки  справочника, используемого в качестве параметра алгоритма. Если у справочника не настроена схема отметки, то список будет пустой;

Примечание. Схема отметки справочника имеет больший приоритет, чем тип отметки.

• Значение. В зависимости от выбранного типа значения:

• если установлен тип «Параметр объекта», укажите параметр или атрибут параметра отчёта, выбрав его из раскрывающегося списка;

• если установлен тип «Константное значение», задайте значение константы.

При выборе типа «Модуль Fore/JS-функция» задайте дополнительные настройки:

• Модуль. Выберите из раскрывающегося списка модуль, написанный на языке Fore. Для кнопки можно задать только один модуль;

• Метод/функция модуля. Выберите из раскрывающегося списка метод или функцию модуля. Функция должна иметь требуемую сигнатуру:

Public Sub <Наименование функции>(<Report>: IPrxReport);
Begin
…
End Sub <Наименование функции>;

Параметр:

Report. В параметр передаётся регламентный отчёт в формате IPrxReport. При работе с этим объектом будут доступны все свойства и методы интерфейса IPrxReport;

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

Для настройки предобработчика задайте параметры:

• Метод/функция модуля. Выберите из раскрывающегося списка метод или функцию модуля. Поле доступно только после выбора модуля.

Список содержит все методы и функции выбранного модуля, соответствующие сигнатуре:

Function <Наименование функции> (<Report>: IPrxReport; [Var messageType: Integer]): String;

Примечание. Если в модуле нет методов и функций, удовлетворяющих требуемой сигнатуре, то список «Метод/функция модуля» недоступен.

Параметры:

Report. В параметр передаётся регламентный отчёт в формате IPrxReport. При работе с этим объектом будут доступны все свойства и методы интерфейса IPrxReport;

messageType. Необязательный параметр. Предназначен для определения формата выводимого сообщения. Если параметр не задан, то будет применяться диалог подтверждения. Для скрытия выводимого сообщения уберите возвращаемое значение в Return. Допустимые значения:

• 0. Диалог подтверждения. При нажатии кнопки «Да» диалога выполняется заданное для кнопки действие. При нажатии кнопки «Нет» диалога заданное для кнопки действие выполняться не будет;

• 1. Ошибка. При нажатии кнопки «ОК» диалога заданное для кнопки действие не выполняется;

• 2. Предупреждение. При нажатии кнопки «ОК» диалога заданное для кнопки действие не выполняется;

• 3. Информационное сообщение. При нажатии кнопки «ОК» диалога заданное для кнопки действие не выполняется.

Пример функции:

Function MessageInformationBox(Report: IPrxReport; Var messageType: integer): String;
    Begin
        messageType := 3;
    Return "Операция будет доступна, когда будут введены все данные";
End Function MessageInformationBox;

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

Для настройки постобработчика задайте параметры:

• Метод/функция модуля. Выберите из раскрывающегося списка метод или функцию модуля. Поле доступно только после выбора модуля.

Список содержит все методы и функции выбранного модуля, соответствующие сигнатуре:

Sub <Наименование метода>(<Report>: IPrxReport);

Примечание. Если в модуле нет методов и функций, удовлетворяющих требуемой сигнатуре, то список «Метод/функция модуля» недоступен.

Параметр:

Report. В параметр передаётся регламентный отчёт в формате IPrxReport. При работе с этим объектом будут доступны все свойства и методы интерфейса IPrxReport.

Пример функции:

Sub UpdateData(Report: IPrxReport);
Var
    SheetT: IPrxTable;
    ItemIndex: Integer;
Begin
    ItemIndex := Report.ActiveSheet.Index;
    SheetT := Report.Sheets.Item(ItemIndex) As IPrxTable;
    SheetT.TabSheet.CellValue(10,10) := 1000000;
End Sub UpdateData;

Для настройки управления активностью кнопки задайте параметр «Метод/функция модуля»», в котором выберите из раскрывающегося списка метод или функцию модуля. Поле доступно только после выбора модуля.

Список содержит все методы и функции выбранного модуля, соответствующие сигнатуре:

Function <Название функции>(<Report>: IPrxReport): Boolean;

Примечание. Если в модуле нет методов и функций, удовлетворяющих требуемой сигнатуре, то список «Метод/функция модуля» недоступен.

Параметр:

Report. В параметр передаётся регламентный отчёт в формате IPrxReport. При работе с этим объектом будут доступны все свойства и методы интерфейса IPrxReport.

Допустимые значения:

• True. Кнопка активна;

• False. Кнопка неактивна.

Примечание. Проверка выполнения условия проходит постоянно, поэтому Fore-функция должна быстро выполняться, иначе регламентный отчёт будет неработоспособным.