Controles da API do cliente

Power Pages controles de API do cliente implementam a Control interface, que fornece métodos comuns para gerenciar valores de formulário, estados, visibilidade, requisitos e validação. Use essa referência para identificar métodos disponíveis e tipos de retorno. Para tipos de valor específicos ao controle e membros adicionais, consulte os tipos de controle da API do Cliente.

Método Returns Descrição
getDisabled() boolean Retorna true se o controle estiver desabilitado; caso contrário, retornará false.
getRequired() boolean Retorna true se o controle for necessário; caso contrário, retornará false.
getVisible() boolean Retorna true se o controle estiver visível; caso contrário, retornará false.
getName() string Retorna o nome do controle.
getType() string | undefined Retorna o tipo de controle, como MultiSelectPicklist, ou undefined quando o tipo não está disponível. Consulte os tipos de controle de API do cliente.
getLogicalName() string | undefined Retorna o nome lógico do controle ou undefined quando o nome lógico não está disponível.
getValue() Varies Recupera o valor atual. O tipo de retorno depende do tipo de controle.
setDisabled(isDisabled: boolean) void Define o estado desabilitado do controle.
setRequired(isRequired: boolean, errorMessage?: string) void Define o estado necessário do controle. Para obter mais informações, consulte parâmetros do método setRequired.
setVisible(isVisible: boolean) void Define a visibilidade do controle.
setValue(value) void Define um novo valor. O tipo de valor esperado depende do tipo de controle.
addValidator(id: string, evaluationFn: function, errorMessage: string) void Registra um validador personalizado do lado do cliente nessa instância de controle. Para obter mais informações, consulte os parâmetros do método addValidator.
removeValidator(id: string) void Remove um validador personalizado por sua ID dessa instância de controle. Ele não faz nada quando a ID não existe.
clearValidators() void Remove todos os validadores personalizados adicionados a essa instância de controle com addValidator. Ele não afeta o validador necessário que setRequired gerencia.

Parâmetros do método setRequired

Parâmetro Tipo Descrição
isRequired booleano Especifica se o controle é necessário.
errorMessage cadeia de caracteres (opcional) A mensagem de validação localizada. O padrão é <field name> is a required field.

Quando isRequired for true, a API do cliente registrará um validador que é executado quando o formulário é enviado. Quando for falso, o validador será removido. Você não pode tornar um controle opcional quando ele é marcado como necessário no servidor.

Parâmetros do método addValidator

Parâmetro Tipo Descrição
id cadeia Um identificador exclusivo na instância de controle atual. Um novo validador com a mesma ID substitui o validador existente.
evaluationFn função Recebe o valor do controle e retorna true quando o valor é válido.
errorMessage cadeia A mensagem que aparece no resumo de validação quando a validação falha.

Importante

Mantenha e reutilize a mesma Control instância de objeto ao substituir ou remover validadores. Cada acesso e form.controls cada chamada para getControlByLogicalName retornar uma nova fachada de controle.

Se a função de avaliação ou o getValue método gerar um erro, a validação falhará e o console do navegador registrará o erro.

Microsoft.PowerPages.onPagesClientApiReady(async function ($pages) {
    const form = $pages.currentPage.forms.getFormById('form_#1');
    const control = form.getControlByLogicalName('new_keyword');

    control.setRequired(true, 'This field is mandatory.');
    control.addValidator(
        'keywordCheck',
        (value) => ['alpha', 'beta', 'gamma'].includes(value),
        'Value must be one of: alpha, beta, gamma.'
    );
});
  • Última atualização em