Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Функции

Set

void Set(string name, variant value)

Устанавливает для шаблона name значение value. Имя шаблона указывается произвольно. Если значение указанного шаблона уже было задано ранее, оно будет обновлено.

Примеры создания шаблонов:

Templates.Set("Department","Участок 1");
Templates.Set("CurrentUser", CurrentUserDisplayName);
Templates.Set("Now",DateTime.ToString(DateTime.Now()));

Clear

void Clear()

Очищает набор шаблонов.

Expand

string Expand(string text)

Возвращает текст, в котором названия шаблонов заменены их значениями. Шаблон следует вызывать, используя специальные символы: ${TemplateName}, где TemplateName – это имя шаблона. Если указать не существующий или не имеющий значения шаблон, то результирующий текст будет содержать обозначение шаблона без изменений.

Пусть с помощью функции Set() в набор шаблонов Templates помещен шаблон Department, содержащий название участка производства.

Templates.Set("Department","Участок 1");

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

Header.Text=Templates.Expand("Указаны объекты для ${Department}");

В результате в заголовок Header будет записан текст "Указаны объекты для Участок 1".

ToJSON

string ToJSON()

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

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

Функция не учитывает дополнительные текстовые шаблоны, которые могут быть указаны в свойстве pAdditionData. Чтобы получить полный набор шаблонов, используйте функцию GetTemplateList.

Пример значения, возвращаемого функцией:

[{"name":"Now","value":"30.11.2023 15:20:39"},{"name":"CurrentUser","value":"Иванов"},{"name":"Department","value":"Участок 1"}]

FromJSON

void FromJSON(string json)

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

GetTemplateList

string GetTemplateList()

Предоставляет перечень шаблонов, добавленных в текущий набор, в формате JSON, включая дополнительные наборы, указанные в свойстве pAdditionData. Чтобы получить набор шаблонов компонента без дополнительных наборов, используйте функцию ToJSON.

Пример значения, возвращаемого функцией:

[{"name":"ExtraTemplate","value":"Дополнительная информация"},{"name":"Now","value":"30.11.2023 15:20:39"},{"name":"CurrentUser","value":"Иванов"},{"name":"Department","value":"Участок 1"}]