Controles (referencia de la API de cliente)

Un control representa un elemento HTML incluido en el formulario. Algunos controles se enlazan a una columna específica, mientras que otros pueden representar controles sin enlazar como IFRAME, un recurso web o una subcuadrícula que se ha agregado al formulario.

El objeto control proporciona métodos para cambiar la presentación o el comportamiento de un control e identificar la columna correspondiente. El acceso a los controles se realiza utilizando una de las colecciones siguientes:

• formContext.ui.controls
• formContext.ui Section.controls
• formContext.data.entity Attribute.controls

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

Los controles se clasifican por tipo. Puede determinar el tipo de un control mediante el método getControlType. Algunos métodos de control solo están disponibles para tipos específicos de controles.

En este artículo se ofrece información sobre los métodos disponibles por tipo de control.

Tipo de control standard

Estos son los métodos disponibles para un control estándar.

addNotification clearNotification getAttribute getControlType getDisabled

getLabel getName getOutputs getParent getVisible

setDisabled setFocus setLabel setNotification setVisible

Los siguientes métodos para el control estándar están obsoletos en esta versión: addOnKeyPress, fireOnKeyPress y removeOnKeyPress.

Tipo de control iframe

Estos son los métodos disponibles para un control IFRAME.

getContentWindow getControlType getDisabled getInitialUrl getLabel

getName getObject getParent getSrc getVisible

setDisabled setFocus setLabel setSrc setVisible

Tipo de control kbsearch (búsqueda de knowledge base)

Estos son los métodos disponibles para el control de búsqueda de knowledge base.

addOnPostSearch addOnResultOpened addOnSelection getControlType getDisabled getLabel getName

getParent getSearchQuery getSelectedResults getTotalResultCount getVisible openSearchResult removeOnPostSearch

removeOnResultOpened removeOnSelection setFocus setLabel setSearchQuery setVisible

Nota

Cuando el control de búsqueda de knowledge base se agrega al panel social, el nombre del control será "searchwidgetcontrol_notescontrol". Este nombre no se puede cambiar.

Tipo de control lookup.

Estos son los métodos disponibles para un control de búsqueda.

addCustomFilter addCustomView addNotification addOnLookupTagClick addPreSearch clearNotification getAttribute getControlType

getDefaultView getDisabled getEntityTypes getLabel getName getParent getVisible removeOnLookupTagClick

removePreSearch setDefaultView setDisabled setEntityTypes setFocus setLabel setNotification setVisible

tipos de control opciones y opción

Tanto los controles opciones como opción tienen el mismo conjunto de métodos disponibles.

addNotification addOption clearNotification clearOptions getAttribute getControlType

getDisabled getLabel getName getOptions getParent getVisible

removeOption setDisabled setFocus setLabel setNotification setVisible

Tipo de control quickform

Para obtener información acerca de los métodos compatibles con este tipo de control, consulte formContext.ui.quickForms.

Tipo de control subgrid

Para obtener información acerca de los métodos compatibles con este tipo de control, consulte Cuadrículas y subcuadrículas.

Tipo de control timelinewall

El control de escala de tiempo muestra las publicaciones, las actividades y las notas en una vista unificada. Estos son los métodos disponibles para este tipo de control.

getControlType getDisabled getLabel getName

getParent getVisible refresh setDisabled

setFocus setLabel setVisible

Tipo de control timer

Estos son los métodos disponibles para el control timer.

getControlType getDisabled getLabel getName

getParent getState getVisible refresh

setDisabled setFocus setLabel setVisible

tipo de control de recurso web

Un control de recursos de web tiene el mismo conjunto de métodos disponibles que el control iframe. Consulte Tipo de control iframe

El recurso web Sliverlight tiene estos métodos adicionales:

getData setData

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));

Tipo de control Form component

Un tipo de control form component tiene el mismo conjunto de métodos disponibles que formContext en un formulario principal. Consulte Comportamiento del componente del formulario > API cliente

Artículos relacionados

Columnas

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).