Elementos CreateUiDefinition

  • Artigo

Este artigo descreve o esquema e as propriedades de todos os elementos suportados de uma CreateUiDefinition.

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 Necessário Descrição
name Yes Um identificador interno para referenciar uma instância específica de um elemento. A utilização 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. Também pode utilizá-lo para vincular o valor de saída de um elemento ao defaultValue de outro elemento.
tipo Yes O controlo de IU a compor para o elemento . Para obter uma lista de tipos suportados, veja Elementos.
etiqueta Yes O texto a apresentar do elemento. Alguns tipos de elementos contêm várias etiquetas, pelo que o valor pode ser um objeto que contém múltiplas cadeias.
valordepredefinido No O valor predefinido do elemento . Alguns tipos de elementos suportam valores predefinidos complexos, pelo que o valor pode ser um objeto.
descrição No O texto a apresentar na ponta da ferramenta do elemento. Semelhante ao label, alguns elementos suportam múltiplas cadeias de sugestão de ferramentas. As ligações inline podem ser incorporadas com a sintaxe markdown.
restrições No Uma ou mais propriedades que são utilizadas para personalizar o comportamento de validação do elemento. As propriedades suportadas para restrições variam consoante 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 de restrições.
opções No Propriedades adicionais que personalizam o comportamento do elemento. Semelhante a constraints, as propriedades suportadas variam consoante o tipo de elemento.
visível No Indica se o elemento é apresentado. Se true, o elemento e os elementos subordinados aplicáveis são apresentados. O valor predefinido é true. Utilize funções lógicas para controlar dinamicamente o valor desta propriedade.

Elementos

A documentação para cada elemento contém um exemplo de IU, esquema, observações sobre o comportamento do elemento (geralmente relacionado com validação e personalização suportada) e saída de exemplo.

Passos seguintes

Para obter uma introdução à criação de definições de IU, veja Introdução ao CreateUiDefinition.