Tipos de controle de API do cliente

Este artigo lista os tipos de controle com suporte. Todos os controles têm os métodos de controle comuns, mas alguns métodos usam tipos de valor diferentes e alguns controles têm membros adicionais.

Tipo de controle Descrição
Composição de endereço Fornece campos de entrada de endereço com vários subcomponentes, como rua, cidade e estado.
Boolean Fornece campos de botão de opção com opções verdadeiras ou falsas.
DateTime Fornece campos de entrada de data e hora.
Decimal Fornece campos de entrada de número decimal.
Duplo Fornece campos de entrada de número de ponto flutuante.
Pesquisa suspensa Fornece uma lista suspensa nãomodal para selecionar um registro relacionado.
Email Fornece campos de entrada de endereço de email.
Arquivo Permite que alguém selecione um arquivo para um formulário editável.
Inteiro formatado Fornece campos inteiros formatados como valores como durações, idiomas e fusos horários.
Nome completo Fornece campos de entrada de nome com vários componentes, como nome e sobrenome.
Image Permite que alguém selecione uma imagem para um formulário editável.
Inteiro Fornece campos de entrada de inteiro numérico.
Memorando Fornece campos de entrada de texto multilinha.
Pesquisa modal Fornece uma caixa de diálogo modal para selecionar um registro relacionado.
Dinheiro Fornece campos de entrada de moeda.
Múltipla escolha Fornece campos de caixa de seleção.
Lista de seleção multiSelect Fornece campos para selecionar várias opções.
Lista de opções Fornece campos de conjunto de opções, como menus suspensos e botões de opção.
Status Fornece o estado atual de um registro de tabela como um valor somente leitura.
Motivo do status Fornece o motivo do status atual de um registro de tabela como um valor somente leitura.
String Fornece campos de entrada de texto de linha única.
Código de negociação Fornece campos de entrada de símbolo de ticker de estoque.
URL Fornece campos de entrada de URL.

Composição de endereço

Endereçar campos de entrada que contêm vários subcomponentes, como rua, cidade e estado, use o controle composto de endereço.

Abordar propriedades e métodos compostos

Use esses membros para configurar e ler valores compostos de endereço.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Consulte o parâmetro do método setValue.
getValue Método Retorna o mesmo objeto.

Parâmetro do método setValue

Espera um objeto com as propriedades a seguir.

{
    "line1": "address line one value",
    "line2": "address line two value",
    "line3": "address line three value",
    "city": "address city value",
    "state": "address state value",
    "postalCode": "address postalCode value",
    "country": "address country value"
}

booleano

Campos de botão de opção com opções true/false usam o controle booliano.

Propriedades e métodos boolianos

Use esses membros para definir e recuperar valores de campo boolianos.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera um valor de cadeia de caracteres correspondente a valores verdadeiros ou falsos localizados
getValue Método Retorna o valor da opção selecionada como uma cadeia de caracteres

DateTime

Os campos de entrada de data e hora usam o controle DateTime.

Métodos e propriedades datetime

Use esses membros para gerenciar e acessar valores de data e hora.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
isDisabled Propriedade Retorna true se o campo estiver desabilitado, caso contrário false.
dataType Propriedade O tipo de dados do campo datetime
setValue Método Espera uma cadeia de caracteres datetime no formato apropriado
getValue Método Retorna o valor de datetime como uma cadeia de caracteres.

Decimal

Os campos de entrada de número decimal usam o controle Decimal.

Propriedades e métodos decimal

Use esses membros para trabalhar com entradas de número decimal.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um número decimal válido.
getValue Método Retorna o valor decimal como uma cadeia de caracteres.

Double

Os campos de entrada de número de ponto flutuante usam o controle Double.

Propriedades e métodos duplos

Use esses membros para lidar com valores de número de ponto flutuante.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um número de ponto flutuante válido.
getValue Método Retorna o valor do número como uma cadeia de caracteres.

Os controles de pesquisa que não são modais usam o controle de pesquisa suspensa.

Use esses membros para interagir com seleções de pesquisa suspensas.

Membro Variante Descrição
isDropdown Propriedade É sempre verdade. Use essa propriedade para distinguir entre uma pesquisa modal e uma pesquisa suspensa.
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera um parâmetro de cadeia de caracteres que representa a ID da opção a ser selecionada.
getValue Método Retorna um objeto do formulário { id: string, name: string } para a opção selecionada ou indefinido quando nenhuma opção é selecionada.

Email

Os campos de entrada de email usam o controle email.

Propriedades e métodos de email

Use esses membros para validar e recuperar valores de endereço de email.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um endereço de email válido.
getValue Método Retorna o valor do email como uma cadeia de caracteres.

Arquivo

O controle Arquivo permite que alguém selecione um arquivo para um formulário editável.

Propriedades e métodos de arquivo

Use esses membros para selecionar, acessar e remover arquivos.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
maxFileSizeInByte Propriedade O tamanho máximo do arquivo em bytes que você pode carregar.
setValue Método Espera um objeto do tipo Arquivo e o define como se alguém o tivesse selecionado com o seletor de arquivos. O método lança um erro quando o arquivo está vazio ou excede maxFileSizeInByte.
getValue Método Retorna o objeto File que você selecionou ou definiu durante a sessão de formulário atual. Ele não baixa um arquivo que já está armazenado no Dataverse.
removeFile Método Remove o arquivo definido.

Para baixar um arquivo armazenado em uma coluna de arquivo do Dataverse, use o downloadFileFromColumn método.

Inteiro formatado

Campos inteiros com requisitos de formatação específicos, como duração, idioma e fuso horário, usam o controle inteiro formatado.

Propriedades e métodos inteiros formatados

Use esses membros para gerenciar inteiros com formatação especializada.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um inteiro formatado válido.
getValue Método Retorna o valor inteiro formatado como uma cadeia de caracteres.

Nome completo

Campos de entrada de nome que podem conter vários componentes (nome, sobrenome e assim por diante) usam o controle de nome completo.

Métodos de nome completo

Use esses membros para configurar e ler componentes de nome completo.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera um objeto com as seguintes propriedades: { "firstName": "first name value", "middleName": "middle name value", "lastName": "last name value" }.
getValue Método Retorna o mesmo objeto.

Imagem

O controle Imagem permite que alguém selecione uma imagem para um formulário editável.

Propriedades e métodos de imagem

Use esses membros para selecionar, acessar e remover imagens.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
maxFileSizeInByte Propriedade O tamanho máximo da imagem em bytes que você pode carregar.
setValue Método Espera uma imagem do tipo Arquivo e a define como se alguém a tivesse selecionado com o seletor de arquivos. O método lança um erro quando o arquivo está vazio, excede maxFileSizeInByteou não tem um tipo MIME de imagem.
getValue Método Retorna o objeto File que você selecionou ou definiu durante a sessão de formulário atual. Ele não baixa uma imagem que já está armazenada no Dataverse.
removeFile Método Remove a imagem definida.

Para baixar uma imagem armazenada em uma coluna de imagem do Dataverse, use o downloadFileFromColumn método.

Integer

Campos de entrada numéricos usam o controle Integer.

Propriedades e métodos inteiros

Use esses membros para definir e recuperar valores de campo inteiros.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um inteiro válido.
getValue Método Retorna o valor inteiro como uma cadeia de caracteres.

Memorando

Campos de entrada de texto multilinha usam o controle Memorando.

Métodos e propriedades de memorando

Use esses membros para gerenciar o conteúdo de entrada de texto de várias linhas.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera um valor de cadeia de caracteres. O método lança um erro quando o valor excede o comprimento máximo configurado do campo.
getValue Método Retorna o texto do memorando como uma cadeia de caracteres.

Os campos de pesquisa modal usam o controle de pesquisa modal.

Use esses membros para definir, obter e limpar valores de pesquisa modal.

Membro Variante Descrição
isModal Propriedade Sempre verdadeiro. Use essa propriedade para distinguir entre uma pesquisa modal e uma pesquisa suspensa.
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera um objeto com as seguintes propriedades: { "id": "O identificador exclusivo do registro.", "nome": "O valor do campo de nome primário do registro", "entityType": "O valor do nome do tipo de entidade da tabela". }
getValue Método Retorna o mesmo objeto.
clearValue Método Limpa o valor definido do campo.

Dinheiro

Os campos de entrada de moeda usam o controle Money.

Propriedades e métodos de dinheiro

Use esses membros para definir e recuperar valores de moeda.

Membro Variante Descrição
readOnly Propriedade true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um valor monetário válido.
getValue Método retorna o valor do dinheiro como uma cadeia de caracteres.

Múltipla escolha

Os campos de caixa de seleção usam o controle de múltipla escolha.

Métodos de múltipla escolha

Use esses métodos para definir e ler estados de caixa de seleção.

Membro Variante Descrição
setValue Método Espera um valor booliano.
getValue Método retorna o estado da caixa de seleção como um booliano.

Lista de seleção multiSelect

Os campos de opção multisseleção usam o controle de lista de seleção MultiSelect.

Métodos de lista de seleção multiSelect

Use esses métodos para definir e ler as opções selecionadas.

Membro Variante Descrição
setValue Método Espera uma matriz de números que representam os valores de opção a serem selecionados. Retornará um erro se um valor não for uma das opções disponíveis.
getValue Método Retorna os valores de opção selecionados como uma matriz de números.
setDisabled Método Não tem efeito quando o formulário ou o campo é somente leitura, porque o controle está bloqueado no servidor.

O exemplo a seguir lê e define as opções selecionadas.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    let form = $pages.currentPage.forms.getFormById('form_#1');
    let control = form && form.controls.find(c => c.getType() === 'MultiSelectPicklist');

    if (!control) {
        return;
    }

    // Get the selected values.
    let selectedValues = control.getValue(); // For example, [740740000, 740740001]

    // Set the selected values.
    control.setValue([740740000, 740740001]);
});

Lista de seleção

Os campos de conjunto de opções (menu suspenso, botões de opção e assim por diante) usam o controle Picklist.

Propriedades e métodos da lista de seleção

Use esses membros para configurar e ler seleções de conjunto de opções.

Membro Variante Descrição
subType Propriedade O subtipo do controle picklist. Os valores possíveis são: VerticalRadioButton, , HorizontalRadioButton, MultipleChoiceMatrixDropdown
setValue Método Espera que uma cadeia de caracteres que represente o valor da opção seja selecionada.
getValue Método Retorna o valor da opção selecionada como uma cadeia de caracteres.

Status

O estado atual de um registro de entidade usa o controle Status.

Note

Esse controle não permite definir o valor. O valor é somente leitura.

Motivo do status

O motivo do status atual de um registro de entidade usa o controle de motivo de status.

Note

Esse controle não permite definir o valor. O valor é somente leitura.

String

Os campos de entrada de texto usam o controle String.

Propriedades e métodos de cadeia de caracteres

Use esses membros para gerenciar valores de entrada de texto de linha única.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera um valor de cadeia de caracteres. O método lança um erro quando o valor excede o comprimento máximo configurado do campo.
getValue Método Retorna o valor da cadeia de caracteres.

Símbolo do ticker

Os campos de entrada do símbolo do ticker de estoque usam o controle de símbolo do ticker.

Propriedades e métodos de símbolo do ticker

Use esses membros para definir e recuperar símbolos do ticker de estoque.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa um símbolo de ticker válido.
getValue Método Retorna o símbolo do ticker como uma cadeia de caracteres.

URL

Os campos de entrada de URL usam o controle de URL.

Propriedades e métodos de URL

Use esses membros para validar e recuperar valores de URL.

Membro Variante Descrição
isReadOnly Propriedade Retorna true se o campo for somente leitura, caso contrário false.
setValue Método Espera uma cadeia de caracteres que representa uma URL válida.
getValue Método Retorna o valor da URL como uma cadeia de caracteres.
  • Última atualização em