CreateUiDefinition 元素

  • 项目

本文介绍了 CreateUiDefinition 的所有受支持元素的架构和属性。

架构

大多数元素的架构如下所示：

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
properties 必选 说明
name 是 一个内部标识符，用于引用元素的特定实例。 元素名称最常用于 outputs 中，其中指定元素的输出值映射到模板的参数。 还可以使用它将元素的输出值绑定到其他元素的 defaultValue。
type 是 要为元素呈现的 UI 控件。 有关支持的类型的列表，请参阅元素。
label 是 元素的显示文本。 某些元素类型包含多个标签，因此，值可能是包含多个字符串的对象。
defaultValue 否 元素的默认值。 某些元素类型支持复杂的默认值，因此，值可能是对象。
toolTip 否 要在元素的工具提示中显示的文本。 与 label 类似，某些元素支持多个工具提示字符串。 可以使用 Markdown 语法嵌入内联链接。
constraints 否 用来自定义元素的验证行为的一个或多个属性。 constraints 支持的属性因元素类型而异。 某些元素类型不支持自定义验证行为，因此没有 constraints 属性。
选项 否 用于自定义元素行为的其他属性。 与 constraints 类似，支持的属性因元素类型而异。
visible 否 指示是否显示此元素。 如果为 true，则会显示此元素及其相应的子元素。 默认值是 true。 可使用逻辑函数动态控制此属性的值。

元素

每个元素的文档都包含此元素的 UI 示例、架构、行为备注（通常涉及验证和支持的自定义）以及示例输出。

后续步骤

有关创建 UI 定义的简介，请参阅 CreateUiDefinition 入门。