Condividi tramite

Elementi di CreateUiDefinition

  • Articolo

Questo articolo descrive lo schema e le proprietà per tutti gli elementi supportati di un file di createUiDefinition.json .

Schema

Lo schema per la maggior parte degli elementi è il seguente:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Proprietà Richiesto Descrizione
name Sì Identificatore interno per fare riferimento a un'istanza specifica di un elemento. Il nome dell'elemento viene usato con maggiore frequenza in outputs, dove i valori di output degli elementi specificati vengono mappati ai parametri del modello. È anche possibile usarlo per associare il valore di output di un elemento al valore defaultValue di un altro elemento.
type Sì Controllo dell'interfaccia utente da sottoporre a rendering per l'elemento. Per un elenco di tipi supportati, vedere Elementi.
label Sì Testo visualizzato dell'elemento. Alcuni tipi di elemento includono più etichette, quindi il valore può essere un oggetto contenente più stringhe.
defaultValue No Valore predefinito dell'elemento. Alcuni tipi di elementi supportano valori predefiniti complessi, quindi il valore può essere un oggetto.
toolTip No Testo da visualizzare nella descrizione comando dell'elemento. Analogamente a label, alcuni elementi supportano più stringhe di descrizione comando. I collegamenti inline possono essere incorporati tramite la sintassi di markdown.
constraints No Una o più proprietà usate per personalizzare il comportamento di convalida dell'elemento. Le proprietà supportate per constraints dipendono dal tipo di elemento. Alcuni tipi di elemento non supportano la personalizzazione del comportamento di convalida e pertanto non hanno alcuna proprietà di vincoli.
options No Altre proprietà che personalizzano il comportamento dell'elemento. Analogamente a constraints, le proprietà supportate dipendono dal tipo di elemento.
visible No Indica se l'elemento è visualizzato. Se true, l'elemento e gli elementi figlio applicabili vengono visualizzati. Il valore predefinito è true. Usare le funzioni logiche per controllare dinamicamente il valore di questa proprietà.

Elementi

La documentazione per ogni elemento include un esempio di interfaccia utente, uno schema, commenti sul comportamento dell'elemento, in genere relativi alla convalida e alla personalizzazione supportata, e infine output di esempio.

Passaggi successivi

Per un'introduzione alla creazione delle definizioni dell'interfaccia utente, vedere Introduzione a CreateUiDefinition.