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 にバインドすることもできます。
type はい レンダリングする要素の UI コントロール。 サポートされる型の一覧については、「要素」を参照してください。
label はい 要素の表示テキスト。 要素の種類によっては複数のラベルが含まれるため、この値は複数の文字列を含んだオブジェクトになる場合があります。
defaultValue いいえ 要素の既定値。 要素の種類によっては複合的な既定値がサポートされるため、この値はオブジェクトになる場合があります。
toolTip いいえ 要素のヒントに表示するテキスト。 label と同様、要素によっては複数のヒント文字列がサポートされます。 マークダウン構文を使ってインライン リンクを埋め込むことができます。
constraints いいえ 要素の検証動作をカスタマイズする目的で使う 1 つまたは複数のプロパティ。 constraints でサポートされるプロパティは要素の種類によって異なります。 要素の種類によっては検証動作のカスタマイズがサポートされていません。その場合、constraints プロパティは存在しません。
options いいえ 要素の動作をカスタマイズする補足的なプロパティ。 constraints と同様、サポートされるプロパティは要素の種類によって異なります。
visible いいえ 要素が表示されるかどうかを示します。 true の場合、要素と該当する子要素が表示されます。 既定値は true です。 このプロパティの値を動的に制御するには論理関数を使います。

要素

それぞれの要素のドキュメントには、UI サンプル、スキーマ、要素の (通常、検証およびサポートされるカスタマイズに関連した) 動作についての備考、サンプル出力が記載されています。

次のステップ

UI 定義の作成の概要については、「CreateUiDefinition の基本概念」を参照してください。