共用方式為

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 Yes 要參考元素特定執行個體的內部識別碼。 元素名稱的最常見用法是在 outputs，其中指定元素的輸出值會對應到範本的參數。 您也可以使用它，將元素的輸出值繫結至另一個元素的 defaultValue。
type Yes 要呈現元素的 UI 控制項。 如需支援類型的清單，請參閱元素。
label Yes 元素的顯示文字。 某些元素類型會包含多個標籤，因此值可能是包含多個字串的物件。
defaultValue No 元素的預設值。 某些元素類型支援複雜的預設值，因此值可能是物件。
toolTip No 要顯示在元素之工具提示的文字。 類似於 label，某些元素可支援多個工具提示字串。 您可以使用 Markdown 語法將內嵌連結進行內嵌。
constraints No 用於自訂元素驗證行為的一個或多個屬性。 支援的條件約束屬性會依元素類型而有所不同。 某些專案類型不支援自定義驗證行為，因此沒有條件約束屬性。
options No 自定義項目行為的更多屬性。 類似於 constraints，支援的屬性會依元素類型而有所不同。
visible No 指出是否要顯示元素。 如果為 true，就會顯示元素和適用的子元素。 預設值是 true。 使用邏輯函式以動態方式控制這個屬性的值。

元素

每個元素的文件中包含元素行為的 UI 範例、結構描述、註解 (通常是關於驗證和支援的自訂) 以及範例輸出。

下一步

如需建立 UI 定義的簡介，請參閱開始使用 CreateUiDefinition。