Elementos CreateUiDefinition

  • Artigo

Este artigo descreve o esquema e as propriedades de todos os elementos suportados de um arquivo createUiDefinition.json .

Esquema

O esquema para a maioria dos elementos é o seguinte:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Property Necessário Descrição
name Sim Um identificador interno para fazer referência a uma instância específica de um elemento. O uso mais comum do nome do elemento é em outputs, onde os valores de saída dos elementos especificados são mapeados para os parâmetros do modelo. Você também pode usá-lo para vincular o valor de saída de um elemento ao defaultValue de outro elemento.
type Sim O controle de interface do usuário a ser renderizado para o elemento . Para obter uma lista dos tipos suportados, consulte Elementos.
label Sim O texto de exibição do elemento. Alguns tipos de elementos contêm vários rótulos, portanto, o valor pode ser um objeto contendo várias cadeias de caracteres.
defaultValue Não O valor padrão do elemento . Alguns tipos de elementos suportam valores padrão complexos, de modo que o valor pode ser um objeto.
toolTip Não O texto a ser exibido na dica de ferramenta do elemento. Semelhante ao , alguns elementos suportam várias cadeias de caracteres de dica labelde ferramenta. Os links embutidos podem ser incorporados usando a sintaxe Markdown.
constraints Não Uma ou mais propriedades que são usadas para personalizar o comportamento de validação do elemento. As propriedades suportadas para restrições variam de acordo com o tipo de elemento. Alguns tipos de elementos não suportam a personalização do comportamento de validação e, portanto, não têm nenhuma propriedade constraints.
options Não Mais propriedades que personalizam o comportamento do elemento. Semelhante ao constraints, as propriedades suportadas variam de acordo com o tipo de elemento.
visible Não Indica se o elemento é exibido. Se true, o elemento e os elementos filho aplicáveis serão exibidos. O valor predefinido é true. Use funções lógicas para controlar dinamicamente o valor dessa propriedade.

Elementos

A documentação para cada elemento contém um exemplo de interface do usuário, esquema, comentários sobre o comportamento do elemento (geralmente sobre validação e personalização suportada) e saída de exemplo.

Próximos passos

Para obter uma introdução à criação de definições de interface do usuário, consulte Introdução a CreateUiDefinition.