Elementos CreateUiDefinition

  • Artigo

Este artigo descreve o esquema e as propriedades de todos os elementos de um CreateUiDefinition com suporte.

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
}
Propriedade Obrigató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 está em outputs, onde os valores de saída de elementos especificados são mapeados para os parâmetros do modelo. Você também pode usá-lo para associar o valor de saída de um elemento ao defaultValue de outro elemento.
type Sim O controle de interface do usuário a ser processado para o elemento. Para obter uma lista dos tipos com suporte, consulte Elementos.
label Sim O texto de exibição do elemento. Alguns tipos de elemento contêm vários rótulos e, portanto, o valor pode ser um objeto que contém várias cadeias de caracteres.
defaultValue Não O valor padrão do elemento. Alguns tipos de elemento dão suporte a valores padrão complexos e, portanto, o valor pode ser um objeto.
toolTip Não O texto exibido na dica de ferramenta do elemento. Semelhante a label, alguns elementos dão suporte a várias cadeias de caracteres de dica de ferramenta. Links embutidos podem ser inseridos usando a sintaxe de markdown.
constraints Não Uma ou mais propriedades que são usadas para personalizar o comportamento de validação do elemento. As propriedades com suporte a restrições variam de acordo com o tipo de elemento. Alguns tipos de elemento não dão suporte à personalização do comportamento de validação e, portanto, não têm nenhuma propriedade de restrições.
opções Não Propriedades adicionais que personalizam o comportamento do elemento. Semelhantemente a constraints, as propriedades com suporte 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 são exibidos. O valor padrão é true. Use funções lógicas para controlar o valor da propriedade dinamicamente.

Elementos

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

Próximas etapas

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