Элементы CreateUiDefinition

  • Статья

В этой статье описывается схема и свойства всех поддерживаемых элементов CreateUiDefinition.

схема

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

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Свойство Обязательно Описание
name Да Внутренний идентификатор для ссылки на конкретный экземпляр элемента. Чаще всего имя элемента используется в outputs, где значения выходных данных указанных элементов сопоставляются с параметрами шаблона. Его также можно использовать для привязки выходного значения элемента к defaultValue другого элемента.
тип Да Элемент управления пользовательского интерфейса для обработки элемента. Список поддерживаемых типов см. в разделе Элементы.
метка Да Отображаемый текст элемента. Некоторые типы элементов содержат несколько меток, поэтому значение может быть объектом, содержащим несколько строк.
defaultValue Нет Значение элемента по умолчанию. Некоторые типы элементов поддерживают сложные значения по умолчанию, поэтому значение может быть объектом.
toolTip Нет Текст для отображения в подсказке элемента. Аналогично label некоторые элементы поддерживают несколько строк с подсказками. С помощью синтаксиса Markdown можно внедрить встроенные ссылки.
constraints Нет Одно или несколько свойств, используемых для настройки поведения проверки элемента. Поддерживаемые свойства для constraints зависят от типа элемента. Некоторые типы элементов не поддерживают настройку поведения проверки и поэтому не содержат свойство constraints.
options Нет Дополнительные свойства, позволяющие настроить поведение элемента. Аналогично constraints поддерживаемые свойства зависят от типа элемента.
visible Нет Указывает, отображается ли элемент. Если задано значение true, элемент и применимые дочерние элементы будут отображены. Значение по умолчанию — true. Используйте логические функции, чтобы динамически управлять значением свойства.

Элементы

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

Дальнейшие действия

Общие сведения о создании определений пользовательского интерфейса см. в статье Начало работы с CreateUiDefinition.