fbpx

Руководство пользователя

Глобальный объект Report ***

Звезда не активнаЗвезда не активнаЗвезда не активнаЗвезда не активнаЗвезда не активна
 

Глобальный объект Report служит для автоматизации операций, связанных с отчетом. Он доступен в любом модуле приложения.

Подпрограммы общего назначения

procedure Clear;

Процедура Clear перезапускает объект (очищает все созданные нумерованные последовательности и т. п.). Пример использования:

begin
Report.Clear;
end;

procedure Update;

Процедура Update обновляет в отчете все скриптовые вставки и объекты автоматизации:

  • формульные вставки (Script equation)
  • текстовые вставки (Script text)
  • текстовые многострочные вставки (Script multiline text)
  • ссылки (Script text reference)

Эту процедуру рекомендуется вызывать в тех местах скрипта, где требуется обновить состояние отчета — при старте модуля, в триггерах кнопок и других элементов интерфейса приложения. Не рекомендуется применять Update в циклах с большим числом итераций, так как это может замедлить работу TechEditor.

Пример использования:

begin
Report.Update;
end;

Работа с нумерованными последовательностями

Нумерованные последовательности — специальные объекты в TechEditor, которые используются для нумерации параграфов, таблиц, рисунков, формул и других разделов отчета.

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

Создание нумерации

function AddRootSequence: Integer;

Функция AddRootSequence создает новую "корневую" последовательность. Это последовательность верхнего уровня, к которой можно прикреплять другие последовательности (более низкого уровня).

Рекомендуется использовать функцию для нумерации основных или обособленных разделов документа (глав, содержания и т. п.).

Пример использования:

var
H1: Integer;
begin
H1 := Report.AddRootSequence; // Example: 1
end;

function AddRootSequenceFmt(Format: string): Integer;

Функция AddRootSequenceFmt аналогична функции AddRootSequence, но при этом пользователь может задать формат отображения номера.

Формат задается текстовой переменной Format:

  • %s — в отчете будет отображено только число, например: 1
  • (%s) — номер будет представлен в круглых скобках: (1)
  • [%s] — номер будет представлен в квадратных скобках: [1]
  • - %s - — номер будет обрамлен короткими тире: - 1 -
  • и т. д.

Пример использования:

var
H1: Integer;
begin
H1 := Report.AddRootSequenceFmt('[%s]'); // [1]
end;

function AddSequence(TopSequenceIndex: Integer): Integer;

Функция AddSequence создает новую нумерованную последовательность, принадлежащую последовательности с номером TopSequenceIndex. Последовательность с номером TopSequenceIndex уже должна быть создана.

Функцию рекомендуется использовать для нумерации промежуточных разделов документа (параграфов, таблиц, формул и т. п.).

Пример использования:

var
H1, H2, H3: Integer;
begin
H1 := Report.AddRootSequence; // Example: 1 H2 := Report.AddSequence(H1); // Example: 1.1 H3 := Report.AddSequence(H2); // Example: 1.1.1 end;

function AddSequenceFmt(TopSequenceIndex: Integer; Format: string): Integer;

Функция AddSequenceFmt аналогична функции AddSequence, но при этом пользователь может задать формат отображения номера. Формат представления номера задается переменной Format (см. функцию AddRootSequenceFmt).

Использование нумерации в отчете

Нумерованные последовательности, созданные с помощью функций AddRootSequence / AddRootSequenceFmt / AddSequence / AddSequenceFmt, могут быть использованы для автоматической нумерации неограниченного числа параграфов, рисунков, таблиц и других элементов в отчете.

function NextSequence(SequenceIndex: Integer): string;

Функция NextSequence возвращает строку со следующим номером в последовательности SequenceIndex.

Индексация последовательностей в глобальном объекте Report начинается с нуля, а сама нумерация (номера, которые отображаются в отчете) — с единицы. Например, если Вы создали одну корневую последовательность, то ее индекс будет равен 0, а номера в отчете — 1, 2, 3 и т. д. Если Вы потом создали еще одну последовательность "внутри" первой, то ее индекс будет равен 1, а номера в отчете по умолчанию будут отформатированы так: 1.1, 1.2, 1.3 и т. д.

Пример использования функции NextSequence:

1. Откройте отчет.

2. Установите курсор в место, куда требуется вставить номер.

3. Вызовите команду Script text (вкладка Automation > Report automation objects) на ленте инструментов.

4. В поле "Name of variable or function" введите имя функции с индексом требуемой последовательности:

TechEditor - insert script text

5. Добавьте скрипт автоматического обновления отчета (Report.Update).

6. Запустите приложение.

function NextSequenceRef(SequenceIndex: Integer; ReferenceName: string): string;

Функция NextSequenceRef аналогична функции NextSequence, но при этом пользователь может задать произвольную текстовую метку ReferenceName. Текстовая метка ReferenceName используется для организации ссылок — Вы можете сослаться на данный номер из любого места отчета.

Функцию NextSequenceRef удобно использовать, например, при нумерации таблиц или формул.

Чтобы вставить ссылку в отчет, используйте команду Automation > Script text. Пример использования:

TechEditor - insert script text

Ссылка на номер в последовательности

function ReferenceToSequence(ReferenceName: string): string;

Функция ReferenceToSequence возвращает номер, маркированный с помощью функции NextSequenceRef. Параметр ReferenceName должен совпадать с таким же параметром в функции NextSequenceRef (регистр значения не имеет).

Чтобы вставить ссылку в отчет, используйте команду Automation > Script reference. Пример использования:

TechEditor - insert script text

Текстовые метки (ReferenceName), с помощью которых маркируются номера в функциях NextSequenceRef, ReferenceToSequence, едины для всего документа.

Форматирование номеров последовательности

procedure SetSequenceFormat(SequenceIndex: Integer; Format: string);

Процедура SetSequenceFormat устанавливает новый формат номеров в последовательности SequenceIndex.

Параметр Format задает формат отображения номера (см. функцию AddRootSequenceFmt). По умолчанию Format='%s', т. е. выводится только номер.

Пример использования:

var
H1, H2, H3: Integer;
begin
H1 := Report.AddRootSequence; // Example: 1
H2 := Report.AddSequence(H1); // Example: 1.1
H3 := Report.AddSequence(H2); // Example: 1.1.1
SetSequenceFormat(H3, '(%s)'); // New format: (1.1.1)
end;

procedure SetSequenceDelimiter(SequenceIndex: Integer; Delimiter: string);

Процедура SetSequenceDelimiter задает строку Delimiter, которая будет использоваться для разделения номеров в последовательности SequenceIndex. По умолчанию, Delimiter='.', т. е. номера отделяются точкой.

Пример использования:

var
H1, H2, H3: Integer;
begin
H1 := Report.AddRootSequence; // Example: 1
H2 := Report.AddSequence(H1); // Example: 1.1
H3 := Report.AddSequence(H2); // Example: 1.1.1
SetSequenceDelimiter(H3, '*'); // New format: 1*1*1
end;

Программная вставка объектов в отчет

Под "программной" вставкой подразумевается, что объекты будут созданы в ходе работы приложения. Утилиты этого блока рекомендуются при разработке приложений для ТехЭдитора с визуальным интерфейсом пользователя.

procedure InsertScriptEquation(Identifier: string);

Процедура InsertScriptEquation вставляет скриптовую формулу Identifier в текущую позицию курсора (в отчете). Процедура является программным аналогом команды Automation > Script equation и может использоваться при разработке приложений для TechEditor с оконным интерфейсом.

procedure InsertScriptText(Identifier: string);

Процедура InsertScriptText вставляет однострочный скрипт Identifier в текущую позицию курсора (в отчете). Процедура является программным аналогом команды Automation > Script text и может использоваться при разработке приложений для TechEditor с оконным интерфейсом.

procedure InsertScriptMultilineText(Identifier: string);

Процедура InsertScriptMultilineText вставляет многострочный скрипт Identifier в текущую позицию курсора (в отчете). Процедура является программным аналогом команды Automation > Script multiline text и может использоваться при разработке приложений для TechEditor с оконным интерфейсом.

procedure InsertScriptReference(Identifier: string);

Процедура InsertScriptReference вставляет ссылку Identifier в текущую позицию курсора (в отчете). Процедура является программным аналогом команды Automation > Script reference и может использоваться при разработке приложений для TechEditor с оконным интерфейсом.

Мероприятия

К сожалению, в настоящий момент нет мероприятий.
Просмотреть все мероприятия

Простой калькулятор в TechEditor за 10 минут!

Ontario Building Code 2012 | Load combination (Free Application & Report Template)

Видеообзор версии 1.0

Новые статьи

Dystlab™ — Project for Engineers

Dystlab™. Все права защищены.

Адрес офиса в Канаде: 223-2275 Lake Shore Boulevard West, Toronto, ON, M8V 3Y3

Адрес офиса в Украине: 76006, г. Ивано-Франковск, ул. Ивана Миколайчука 17/97

E-mail:
technot needed texteditoranother not needed text@dystlabdummy text.store

Telegram:
https://t.me/techeditor

Dystlab™ — торговая марка, зарегистрированная в Государственном реестре свидетельств Украины на знаки для товаров и услуг 26.02.2018, свидетельство № 238304. Владелец: физическое лицо-предприниматель Артемов В. Е., ЕГРПОУ/ИНН: 3003314690.

Всё самое интересное о TechEditor — в Твиттере. Присоединяйся!

TechEditor Twitter