Недооцененные шаблоны текста

Шаблоны текста… о шаблоны текста,
Как жил я раньше вас не знав,
Как горестно существовал в забвении,
Но миг, когда про вас я прочитав,
Оставил ум в обогащении!
© Сизых А.М.

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

Какие проблемы могут решать шаблоны текста?

1) Автозамена символов на английском языке, используемых при написании кода - ЕстьNULL, &, <>, [] и т.д.;

2) Подсказка для выбора метаданных - значений перечислений, предопределенных элементов справочников и т.д. Особенно полезно может быть при написании запросов, поскольку там нет контекстной подсказки, но с помощью шаблонов можно вызвать интерактивное окно выбора предопределенных значений либо объектов метаданных;

3) Библиотека кода часто используемых инициализаций:

• Части кода для работы с файлами формата MS Word/Excel;

• Диалоговые окна для взаимодействия с файловой системой (открыть файл, сохранить, выбрать каталог);

• Инициализация внешних отчетов обработок (сведения о внешней обработке и т.д);

• «Кастомные» универсальные процедуры/функции, которые могут пригодиться, как пример, функция для преобразования массива структур в таблицу значений;

• Быстрое оформление областей модулей;

• Упрощенная инициализация стандартных конструкторов, например, «Формат», «Описание типов» и т.д.

• Быстрая инициализация конструкторов программного создания элементов формы.

Подключение и настройка шаблонов текста

Подключение шаблонов текста выглядит следующим образом:

Рисунок 1 - расположение команды открытия окна списка шаблонов текста

1) При клике на указанную иконку в конфигураторе открывается окно «Шаблоны текста».

Рисунок 2 - расположение команды "Настройка шаблонов"

2) В контекстном меню «Действия» выбрать пункт «Настройка шаблонов…»

Рисунок 3 - окно настройки шаблонов

3) В открывшемся окне через команду «+» добавить файл шаблонов текста.

Однако данный способ больше применим для добавления новых/модифицированных шаблонов текста. По умолчанию флаг «Использовать стандартные шаблоны» установлен, и можно в любом конфигураторе сразу использовать стандартные шаблоны текста, поставляемые с платформой, т.е. те шаблоны текста, которые были разработаны 1С.

Чтобы просмотреть состав шаблона, необходимо в окне списка шаблонов (рисунок 2) открыть для изменения шаблон (двойной клик по шаблону, «Изменить» через контекстное меню либо F2). Окно содержания шаблона выглядит следующим образом:

Рисунок 4 - Окно содержания шаблона

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

Рассмотрим настройки применения конкретного шаблона:

Название - в данном поле указывается наименование шаблона, т.е. смысловая нагрузка.

Автоматически заменять строку - в этом поле указывается текст, при вводе которого при нажатии комбинации «Ctrl + Q» будет произведена замена введенной строки на значение, указанное в поле «Текст шаблона». Содержание строки замены условно можно разделить на 2 части – статическую и динамическую. Статической частью считаются все символы строки замены, которые находятся за скобками [], все, что внутри, это динамическая часть.

Статическая часть является обязательной для работы автозамены. Т.е. если в коде модуля прописать «Переч», то при нажатии комбинации «Ctrl + Q» будет произведена замена «Переч» на текст, указанный в поле «Текст шаблона». При этом если написать «Перечис», то автозамена отработает, поскольку обязательная статическая часть уже была введена.

Рисунок 5 - Параметры замены шаблона

Включать в контекстное меню - данный флаг отвечает за то, будет ли шаблон отображаться в контекстном меню.

Рисунок 6 - раздел "Шаблоны текста" контекстного меню модуля конфигуратора

Теперь перейдем к самому интересному, а именно к настройке текста шаблона для вставки.

Текст шаблона можно прописать самостоятельно, а можно воспользоваться конструктором вставки (Рис. 7).

Рисунок 7 - конструктор вставки текста шаблона

Конструктор содержит следующие поля параметризации:

Подсказка - Подсказка, которая будет выведена в заголовок интерактивного окна (при его наличии по настройкам шаблона)

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

• Произвольный запрос – произвольный текст, который будет предложено ввести пользователю при вызове шаблона.

Рисунок 8 - вид текста шаблона с типом "Произвольный запрос"

При вызове данного шаблона появится интерактивное окно для ввода текста подстановки.

Рисунок 9 - интерактивное окно вызова шаблона

Рисунок 10 - результат работы шаблона

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

• Специальный запрос – шаблоны имеют ключевые слова, которые используются внутри текста шаблона и вызывают специальные интерактивные окна.

Например, можно упростить ввод значения перечислений в коде.

Рисунок 11 - конструктор вставки с значением перечисления

Текст шаблона будет выглядеть как в «произвольном запросе», но с дополнительным ключевым параметром.

Рисунок 12 - текст шаблона для перечисления

Вызов данного шаблона будет выглядеть следующим образом:

Рисунок 13 - интерактивное окно выбора значения перечисления

После замены получим следующий код:

Рисунок 14 - Результат автозамены перечисления

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

• вызов конструктора запросов;

• вызов конструктора форматной строки;

• конструктора описания типов.

• Установка курсора – Устанавливает курсор после подстановки в указанную позицию, имеет смысл применять в сложных шаблонах, где после замены необходимо установить курсор в определенном месте.

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

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

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

Не всегда можно использовать шаблон только с ключевыми словами для получения готового кода. Однако если дополнить текст необходимыми в зависимости от контекста словами, то можно получить готовый кусочек кода.

Рисунок 15 - пример дополнения текста шаблона

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

Рисунок 16 - результат замены с дополненным текстом шаблона

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

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

Рисунок 17 - текст шаблона для программного добавления группы на форму

Вызов данного шаблона сформирует конструктор следующего вида.

Рисунок 18 - интерактивное окно выбора значения имени элемента

Рисунок 19 - интерактивное окно выбора значения заголовка

Рисунок 20 - интерактивное окно выбора значения типа группы

В результате получим следующий код.

Рисунок 21 - результат работы шаблона по программному добавлению группы на форму

В данном примере было всего 3 параметра, но при желании можно задать необходимое количество и формировать подобные инициализации целиком через интерактивные окна шаблона. И подобных примеров можно придумать много, все ограничивается только вашим воображением!

Подводя итог

Какие преимущества у шаблонов текста?

• Отсутствует необходимость установки/настройки дополнительного ПО – все, что вам нужно - это конфигуратор;

• Автономность – поскольку шаблоны текста являются целостным файлом, то их можно переносить между рабочими местами без дополнительных манипуляций с операционной системой, достаточно лишь в конфигураторе указать путь к файлу шаблонов;

• Шаблоны текста работают как в модуле объекта, так и в конструкторе запросов;

• Позволяют увеличить эффективность - экономия времени на поиск и написание стандартных частей кода;

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

• Шаблонами можно пользоваться не только для автозамены, но и для хранения кода, как справки, к которой можно обратиться;

• Шаблонами текста можно делиться с другими.

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