Поделиться через

Элементы CreateUiDefinition

  • Статья

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

Схема

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

{
  "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 другого элемента.
type Да Элемент управления пользовательского интерфейса для обработки элемента. Список поддерживаемых типов см. в разделе Элементы.
label Да Отображаемый текст элемента. Некоторые типы элементов содержат несколько меток, поэтому значение может быть объектом, содержащим несколько строк.
defaultValue No Значение элемента по умолчанию. Некоторые типы элементов поддерживают сложные значения по умолчанию, поэтому значение может быть объектом.
toolTip No Текст для отображения в подсказке элемента. Аналогично label некоторые элементы поддерживают несколько строк с подсказками. С помощью синтаксиса Markdown можно внедрить встроенные ссылки.
constraints No Одно или несколько свойств, используемых для настройки поведения проверки элемента. Поддерживаемые свойства для constraints зависят от типа элемента. Некоторые типы элементов не поддерживают настройку поведения проверки и поэтому не имеют свойств ограничений.
options No Дополнительные свойства, которые настраивают поведение элемента. Аналогично constraints поддерживаемые свойства зависят от типа элемента.
visible No Указывает, отображается ли элемент. Если задано значение true, элемент и применимые дочерние элементы будут отображены. Значение по умолчанию — true. Используйте логические функции, чтобы динамически управлять значением свойства.

Элементы

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

Следующие шаги

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