formContext.getControl (referencia de la API de cliente)

  • Artículo

Obtiene un control en el formulario.

Nota

getControl solo funciona en controles en el cuerpo del formulario y el encabezado. No es compatible con controles en otras partes de la página, incluso si hacen referencia a la misma columna.

Sintaxis

formContext.getControl(arg);

El método formContext.getControl(arg) es un acceso directo para acceder a formContext.ui.controls.get.

Parámetro

arg: opcional. Puede acceder a un control de un formulario si pasa un argumento como el nombre o el valor de índice del control en un formulario. Por ejemplo: formContext.getControl("firstname") o formContext.getControl(0). Si el nombre arg se escribe mal y no está en el formulario, devuelve un valor nulo.

Cuando no se proporciona el valor arg, devuelve una matriz de todos los controles del formulario.

Valor devuelto

Tipo: objeto, colección de objetos o nulo.

Descripción: una colección de objetos si usa el método sin parámetros. Objeto o nulo si usa el método con un parámetro. Si utiliza el nombre como parámetro y hay varios controles para la misma columna, solo se devuelve el primer control.

Sugerencia

Si desea modificar todos los controles asociados a una columna en un formulario, use la colección de controles dentro del tipo de columna. Por ejemplo, para agregar una notificación a cada control asociado a la columna name, puede hacer lo siguiente:

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

formContext

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).