Elemento da IU Microsoft.Common.DropDown

Um controlo de seleção com uma lista pendente. Pode permitir a seleção de apenas um único item ou múltiplos itens. Opcionalmente, também pode incluir uma descrição com os itens.

Exemplo de IU

O elemento DropDown tem diferentes opções que determinam o seu aspeto no portal.

Quando só é permitido um único item para seleção, o controlo é apresentado como:

Quando são incluídas descrições, o controlo é apresentado como:

Quando a seleção múltipla está ativada, o controlo adiciona uma opção Selecionar tudo e caixas de verificação para selecionar mais do que um item:

As descrições podem ser incluídas com seleção múltipla ativada.

Quando a filtragem está ativada, o controlo inclui uma caixa de texto para adicionar o valor de filtragem.

Esquema

{
  "name": "element1",
  "type": "Microsoft.Common.DropDown",
  "label": "Example drop down",
  "placeholder": "",
  "defaultValue": ["Value two"],
  "toolTip": "",
  "multiselect": true,
  "selectAll": true,
  "filter": true,
  "filterPlaceholder": "Filter items ...",
  "multiLine": true,
  "defaultDescription": "A value for selection",
  "constraints": {
    "allowedValues": [
      {
        "label": "Value one",
        "description": "The value to select for option 1.",
        "value": "one"
      },
      {
        "label": "Value two",
        "description": "The value to select for option 2.",
        "value": "two"
      }
    ],
    "required": true
  },
  "visible": true
}

Saída de exemplo

"two"

Observações

• Utilize multiselect para especificar se os utilizadores podem selecionar mais do que um item.
• Por predefinição, selectAll é true quando a seleção múltipla está ativada.
• A filter propriedade permite que os utilizadores pesquisem numa longa lista de opções.
• A etiqueta para constraints.allowedValues é o texto a apresentar de um item e o respetivo valor é o valor de saída do elemento quando selecionado.
• Se especificado, o valor predefinido tem de ser uma etiqueta presente em constraints.allowedValues. Se não for especificado, o primeiro item em constraints.allowedValues é selecionado. O valor predefinido é nulo.
• constraints.allowedValues tem de ter, pelo menos, um item.
• Para emular um valor que não está a ser necessário, adicione um item com uma etiqueta e um valor de "" (cadeia vazia) a constraints.allowedValues.
• A defaultDescription propriedade é utilizada para itens que não têm uma descrição.
• A placeholder propriedade é texto de ajuda que desaparece quando o utilizador começa a editar. Se os placeholder e defaultValue estiverem definidos, o defaultValue tem precedência e é apresentado.

Exemplo

No exemplo seguinte, o defaultValue é definido com os valores do allowedValues em vez das etiquetas. O valor predefinido pode conter vários valores quando multiselect está ativado.

{
  "name": "element1",
  "type": "Microsoft.Common.DropDown",
  "label": "Example drop down",
  "placeholder": "",
  "defaultValue": [{"value": "one"}, {"value": "two"}],
  "toolTip": "Multiple values can be selected",
  "multiselect": true,
  "selectAll": true,
  "filter": true,
  "filterPlaceholder": "Filter items ...",
  "multiLine": true,
  "defaultDescription": "A value for selection",
  "constraints": {
    "allowedValues": [
      {
        "label": "Value one",
        "description": "The value to select for option 1.",
        "value": "one"
      },
      {
        "label": "Value two",
        "description": "The value to select for option 2.",
        "value": "two"
      }
    ],
    "required": true
  },
  "visible": true
}

Passos seguintes

• Para obter uma introdução à criação de definições de IU, veja Introdução ao CreateUiDefinition.
• Para obter uma descrição das propriedades comuns nos elementos da IU, veja CreateUiDefinition elements (Elementos CreateUiDefinition).