CreateUiDefinition-Elemente

In diesem Artikel werden das Schema und die Eigenschaften für alle unterstützten Elemente eines CreateUiDefinition-Elements beschrieben.

Schema

Das Schema für die meisten Elemente ist wie folgt:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Eigenschaft Erforderlich BESCHREIBUNG
name Ja Ein interner Bezeichner für den Verweis auf eine bestimmte Instanz eines Elements. Am häufigsten wird der Elementname in outputs verwendet. Dabei werden die Ausgabewerte der angegebenen Elemente den Parametern der Vorlage zugeordnet. Sie können mit ihm auch den Ausgabewert eines Elements an defaultValue eines anderen Elements binden.
type Ja Das Benutzeroberflächensteuerelement, das für das Element gerendert werden soll. Eine Liste der unterstützten Typen finden Sie unter Elemente.
label Ja Der Anzeigetext des Elements. Einige Elementtypen enthalten mehrere Bezeichnungen. Der Wert kann also ein Objekt sein, das mehrere Zeichenfolgen enthält.
defaultValue Nein Der Standardwert des Elements. Einige Elementtypen unterstützen komplexe Standardwerte. Der Wert kann also ein Objekt sein.
toolTip Nein Der Text, der in der QuickInfo des Elements angezeigt werden soll. Ähnlich wie bei label unterstützen einige Elemente mehrere QuickInfo-Zeichenfolgen. Inlinelinks können mithilfe von Markdownsyntax eingebettet werden.
constraints Nein Eigenschaften, die zum Anpassen des Überprüfungsverhaltens des Elements verwendet werden. Die unterstützten Eigenschaften für Einschränkungen variieren je nach Elementtyp. Einige Elementtypen unterstützen die Anpassung des Überprüfungsverhaltens nicht und enthalten daher keine constraints-Eigenschaft.
Optionen Nein Zusätzliche Eigenschaften, die das Verhalten des Elements anpassen. Ähnlich wie bei constraints variieren die unterstützten Eigenschaften je nach Elementtyp.
visible Nein Gibt an, ob das Element angezeigt wird. Ist true angegeben, werden das Element und entsprechende untergeordnete Elemente angezeigt. Standardwert: true. Verwenden Sie logische Funktionen, um den Wert dieser Eigenschaft dynamisch zu steuern.

Elemente

Die Dokumentation für die einzelnen Elemente enthält ein Benutzeroberflächenbeispiel, ein Schema, Hinweise zum Verhalten des Elements (in der Regel in Bezug auf Überprüfung und unterstützte Anpassung) und eine Beispielausgabe.

Nächste Schritte

Eine Einführung zum Erstellen von Benutzeroberflächendefinitionen finden Sie unter Erste Schritte mit „CreateUiDefinition“.