Controles (referencia de la API de cliente)

En las aplicaciones controladas por modelos, un control representa un elemento HTML en el formulario. Algunos controles están enlazados a una columna específica, mientras que otros representan controles sin enlazar, como un IFRAME, un recurso web o una subgrid agregados al formulario.

El objeto control proporciona métodos para cambiar la presentación o el comportamiento de un control e identificar la columna correspondiente. Controles de acceso mediante una de las siguientes colecciones:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAttribute.controls

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

Nota

Al realizar acciones en controles vinculados a una columna, tenga en cuenta que el control puede aparecer en la página más de una vez. Por lo general, debe realizar las mismas acciones para cada control de la columna. Puede recorrer la colección de controles de columna y realizar las acciones en cada control.

Los controles se clasifican por tipo. Use el método getControlType para determinar el tipo de un control. Algunos métodos de control solo están disponibles para determinados tipos de controles.

En este artículo se proporciona información sobre los métodos disponibles para cada tipo de control.

Tipo de control estándar

Estos métodos están disponibles para un control Estándar.

Method Description
addNotification Muestra una notificación de error o recomendación con acciones opcionales.
clearNotification Quita una notificación del control .
getAttribute Devuelve la columna a la que está asignada el control.
getControlType Devuelve el tipo del control.
getDisabled Devuelve si el control está deshabilitado.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getOutputs Devuelve un diccionario de las propiedades de salida del control.
getParent Devuelve la sección que contiene el control .
getVisible Devuelve si el control está visible.
setDisabled Habilita o deshabilita el control.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setNotification Muestra un mensaje de error para indicar que los datos no son válidos.
setVisible Muestra u oculta el control.

Los métodos siguientes para el control Estándar están en desuso: addOnKeyPress, fireOnKeyPress y removeOnKeyPress.

Tipo de control IFRAME

Estos métodos están disponibles para un control IFRAME.

Method Description
getContentWindow Devuelve la ventana de contenido del recurso IFRAME o web.
getControlType Devuelve el tipo del control.
getDisabled Devuelve si el control está deshabilitado.
getInitialUrl Devuelve la dirección URL predeterminada configurada para el IFRAME.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getObject Devuelve el objeto de formulario que representa el IFRAME o el recurso web.
getParent Devuelve la sección que contiene el control .
getSrc Devuelve la dirección URL que se muestra actualmente en el recurso IFRAME o web.
getVisible Devuelve si el control está visible.
setDisabled Habilita o deshabilita el control.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setSrc Establece la dirección URL que se va a mostrar en el recurso IFRAME o web.
setVisible Muestra u oculta el control.

Tipo de control Kbsearch (búsqueda de base de conocimiento)

Estos métodos están disponibles para el control de búsqueda de la base de conocimiento.

Method Description
addOnPostSearch Agrega un controlador de eventos que se ejecuta después de que se complete una búsqueda.
addOnResultOpened Agrega un controlador de eventos que se ejecuta cuando se abre un resultado de búsqueda.
addOnSelection Agrega un controlador de eventos que se ejecuta cuando se selecciona un resultado de búsqueda.
getControlType Devuelve el tipo del control.
getDisabled Devuelve si el control está deshabilitado.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getParent Devuelve la sección que contiene el control .
getSearchQuery Devuelve el texto usado como criterios de búsqueda.
getSelectedResults Devuelve el resultado de búsqueda seleccionado actualmente.
getTotalResultCount Devuelve el número de resultados de búsqueda.
getVisible Devuelve si el control está visible.
openSearchResult Abre un resultado de búsqueda especificado.
removeOnPostSearch Quita un controlador de eventos para la finalización de la búsqueda.
removeOnResultOpened Quita un controlador de eventos para abrir un resultado de búsqueda.
removeOnSelection Quita un controlador de eventos para seleccionar un resultado de búsqueda.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setSearchQuery Establece el texto usado como criterios de búsqueda.
setVisible Muestra u oculta el control.

Nota

Al agregar el control de búsqueda de la base de conocimiento al panel social, el nombre del control es searchwidgetcontrol_notescontrol. No puedes cambiar este nombre.

Tipo de control de búsqueda

Estos métodos están disponibles para un control de búsqueda.

Method Description
addCustomFilter Agrega un filtro a los resultados de la búsqueda, combinados con filtros existentes mediante AND.
addCustomView Agrega una vista al cuadro de diálogo de búsqueda.
addNotification Muestra una notificación de error o recomendación con acciones opcionales.
addOnLookupTagClick Agrega un controlador de eventos que se ejecuta cuando se hace clic en una etiqueta de búsqueda.
addPreSearch Agrega un controlador de eventos que se ejecuta antes de una búsqueda.
clearNotification Quita una notificación del control .
getAttribute Devuelve la columna a la que está asignada el control.
getControlType Devuelve el tipo del control.
getDefaultView Devuelve el identificador de la vista de búsqueda predeterminada.
getDisabled Devuelve si el control está deshabilitado.
getEntityTypes Devuelve los tipos de tabla permitidos en la búsqueda.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getParent Devuelve la sección que contiene el control .
getVisible Devuelve si el control está visible.
removeOnLookupTagClick Quita un controlador de eventos para hacer clic en etiquetas de búsqueda.
removePreSearch Quita un controlador de eventos que se ejecuta antes de una búsqueda.
setDefaultView Establece la vista predeterminada en el cuadro de diálogo de búsqueda.
setDisabled Habilita o deshabilita el control.
setEntityTypes Establece los tipos de tabla permitidos en la búsqueda.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setNotification Muestra un mensaje de error para indicar que los datos no son válidos.
setVisible Muestra u oculta el control.

Tipos de control de opción y opciones

Las opciones y los controles de elección tienen el mismo conjunto de métodos disponibles.

Method Description
addNotification Muestra una notificación de error o recomendación con acciones opcionales.
addOption Agrega una opción al control .
clearNotification Quita una notificación del control .
clearOptions Quita todas las opciones del control.
getAttribute Devuelve la columna a la que está asignada el control.
getControlType Devuelve el tipo del control.
getDisabled Devuelve si el control está deshabilitado.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getOptions Devuelve las opciones disponibles, incluida la opción en blanco y excluyendo las opciones eliminadas.
getParent Devuelve la sección que contiene el control .
getVisible Devuelve si el control está visible.
removeOption Quita una opción del control .
setDisabled Habilita o deshabilita el control.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setNotification Muestra un mensaje de error para indicar que los datos no son válidos.
setVisible Muestra u oculta el control.

Tipo de control de formulario rápido

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

Tipo de control subgrid

Consulte Cuadrículas y subgrides para obtener información sobre los métodos admitidos para este tipo de control.

Tipo de control de pared de escala de tiempo

El control de escala de tiempo presenta las publicaciones, las actividades y las notas en una vista unificada. Estos métodos están disponibles para este tipo de control.

Method Description
getControlType Devuelve el tipo del control.
getDisabled Devuelve si el control está deshabilitado.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getParent Devuelve la sección que contiene el control .
getVisible Devuelve si el control está visible.
refresh Actualiza los datos mostrados en la escala de tiempo.
setDisabled Habilita o deshabilita el control.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setVisible Muestra u oculta el control.

Tipo de control timer

Estos métodos están disponibles para el control timer.

Method Description
getControlType Devuelve el tipo del control.
getDisabled Devuelve si el control está deshabilitado.
getLabel Devuelve la etiqueta del control.
getName Devuelve el nombre del control.
getParent Devuelve la sección que contiene el control .
getState Devuelve el estado actual del temporizador.
getVisible Devuelve si el control está visible.
refresh Actualiza los datos mostrados en el temporizador.
setDisabled Habilita o deshabilita el control.
setFocus Mueve el foco al control.
setLabel Cambia la etiqueta del control.
setVisible Muestra u oculta el control.

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 el tipo de control iframe.

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 > de componentes de formulario API de cliente.

Columnas