Compartilhar via


formContext.getControl (referência da API do Cliente)

Obtém um controle no formulário.

Observação

getControl funciona apenas em controles no corpo do formulário e no cabeçalho. Não há suporte para controles em outros lugares da página, mesmo se eles se referirem à mesma coluna.

Sintaxe

formContext.getControl(arg);

O método formContext.getControl(arg) é um método de atalho para acessar formContext.ui.controls.get.

Parâmetro

arg: Opcional. Você pode acessar um controle em um formulário passando um argumento como o nome ou o valor de índice do controle em um formulário. Por exemplo: formContext.getControl("firstname") ou formContext.getControl(0). Se o arg nome estiver escrito errado e não estiver no formulário, ele retornará o valor nulo.

Quando o arg valor não é fornecido, ele retorna uma matriz de todos os controles no formulário.

Valor de retorno

Tipo: coleção de objetos, Objeto ou nulo.

Descrição: coleção de objetos se você usar o método sem parâmetros. Objeto ou nulo se você usar o método com um parâmetro. Se você usar o nome como um parâmetro e houver vários controles para a mesma coluna, somente o primeiro controle será retornado.

Dica

Se você quiser modificar todos os controles associados a uma coluna em um formulário, use a coleção de controles dentro do tipo de coluna. Por exemplo, para adicionar notificação a cada controle associado à name coluna, você pode fazer o seguinte:

 const notification = {
 messages: ['Sample Notification on Name Controls'],
 notificationLevel: 'RECOMMENDATION',
 uniqueId: 'my_unique_id'};
formContext.getAttribute("name").controls.forEach(control => control.addNotification(notification));

formContext