Controls (referència de l'API del client)

En aplicacions basades en models, un control representa un element HTML al formulari. Alguns controls estan vinculats a una columna específica, mentre que d'altres representen controls no vinculats com un IFRAME, un recurs web o una subgraella afegida al formulari.

L'objecte control proporciona mètodes per canviar la presentació o el comportament d'un control i identificar la columna corresponent. Els controls d'accés utilitzen una de les següents col·leccions:

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

El formularContext. El mètode getControl és un mètode de drecera per accedir a formContext.ui.controls.get.

Nota

Quan realitzes accions en controls vinculats a una columna, tingues en compte que el control pot aparèixer a la pàgina més d'una vegada. En general, hauries de fer les mateixes accions per a cada control de la columna. Pots recórrer la col·lecció de controls de columna i fer les accions de cada control.

Els controls es classifiquen per tipus. Utilitza el mètode getControlType per determinar el tipus de control. Certs mètodes de control només estan disponibles per a tipus específics de controls.

Aquest article proporciona informació sobre els mètodes disponibles per a cada tipus de control.

Tipus de control estàndard

Aquests mètodes estan disponibles per a un control estàndard.

Mètode Descripció
addNotificació Mostra una notificació d'error o de recomanació amb accions opcionals.
clearNotificació Elimina una notificació del control.
getAttribute Retorna la columna a la qual està enllaçat el control.
getControlType Retorna el tipus de control.
getDisabled Retorna si el control està inhabilitat.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getOutputs Retorna un diccionari de les propietats de sortida del control.
getParent Retorna la secció que conté el control.
getVisible Retorna si el control és visible.
setDisabled Activa o desactiva el control.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setNotificació Mostra un missatge d'error per indicar que les dades no són vàlides.
setVisible Mostra o amaga el control.

Els següents mètodes per al control Standard estan obsolets: addOnKeyPress, fireOnKeyPress i removeOnKeyPress.

Tipus de control IFRAME

Aquests mètodes estan disponibles per a un control IFRAME.

Mètode Descripció
getContentWindow Retorna la finestra de contingut de l'IFRAME o recurs web.
getControlType Retorna el tipus de control.
getDisabled Retorna si el control està inhabilitat.
getInitialUrl Retorna la URL per defecte configurada per a l'IFRAME.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getObjecte Retorna l'objecte formulari que representa l'IFRAME o recurs web.
getParent Retorna la secció que conté el control.
getSrc Retorna l'URL que actualment es mostra a l'IFRAME o al recurs web.
getVisible Retorna si el control és visible.
setDisabled Activa o desactiva el control.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setSrc Estableix l'URL perquè es mostri a l'IFRAME o al recurs web.
setVisible Mostra o amaga el control.

Tipus de control de Kbsearch (cerca a la base de coneixement)

Aquests mètodes estan disponibles per al control de cerca de la base de coneixement.

Mètode Descripció
addOnPostSearch Afegeix un gestor d'esdeveniments que s'executa després que una cerca acabi.
addOnResultObert Afegeix un gestor d'esdeveniments que s'executa quan s'obre un resultat de cerca.
addOnSelection Afegeix un gestor d'esdeveniments que s'executa quan es selecciona un resultat de cerca.
getControlType Retorna el tipus de control.
getDisabled Retorna si el control està inhabilitat.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getParent Retorna la secció que conté el control.
getSearchQuery Retorna el text utilitzat com a criteri de cerca.
getSelectedResults Retorna el resultat de cerca seleccionat actualment.
getTotalResultCount Retorna el nombre de resultats de cerca.
getVisible Retorna si el control és visible.
ResultatCerca obert Obre un resultat de cerca específic.
removeOnPostSearch Elimina un gestor d'esdeveniments per completar la cerca.
removeOnResultOpened Elimina un gestor d'esdeveniments per obrir un resultat de cerca.
removeOnSelection Elimina un gestor d'esdeveniments per seleccionar un resultat de cerca.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setSearchQuery Estableix el text utilitzat com a criteri de cerca.
setVisible Mostra o amaga el control.

Nota

Quan afegeixes el control de cerca de la base de coneixement al panell social, el nom del control és searchwidgetcontrol_notescontrol. No pots canviar aquest nom.

Tipus de control de cerca

Aquests mètodes estan disponibles per a un control de cerca.

Mètode Descripció
addCustomFilter Afegeix un filtre als resultats de la cerca, combinat amb filtres existents utilitzant AND.
addCustomView Afegeix una vista al diàleg de cerca.
addNotificació Mostra una notificació d'error o de recomanació amb accions opcionals.
addOnLookupTagClick Afegeix un gestor d'esdeveniments que s'executa quan es fa clic en una etiqueta de cerca.
addPreSearch Afegeix un gestor d'esdeveniments que s'executa abans d'una cerca de cerca.
clearNotificació Elimina una notificació del control.
getAttribute Retorna la columna a la qual està enllaçat el control.
getControlType Retorna el tipus de control.
getDefaultView Retorna l'ID de la vista de cerca per defecte.
getDisabled Retorna si el control està inhabilitat.
getEntityTypes Retorna els tipus de taula permesos a la cerca.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getParent Retorna la secció que conté el control.
getVisible Retorna si el control és visible.
removeOnLookupTagFeu clic Elimina un gestor d'esdeveniments per als clics d'etiquetes de cerca.
removePreSearch Elimina un gestor d'esdeveniments que s'executa abans d'una cerca de cerca.
setDefaultView Estableix la vista per defecte al diàleg de cerca.
setDisabled Activa o desactiva el control.
setEntityTypes Estableix els tipus de taula permesos a la cerca.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setNotificació Mostra un missatge d'error per indicar que les dades no són vàlides.
setVisible Mostra o amaga el control.

Opcions i tipus de control d'elecció

Les eleccions i els controls d'elecció tenen el mateix conjunt de mètodes disponibles.

Mètode Descripció
addNotificació Mostra una notificació d'error o de recomanació amb accions opcionals.
addOption Afegeix una opció al control.
clearNotificació Elimina una notificació del control.
clearOpcions Elimina totes les opcions del control.
getAttribute Retorna la columna a la qual està enllaçat el control.
getControlType Retorna el tipus de control.
getDisabled Retorna si el control està inhabilitat.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getOptions Retorna les opcions disponibles, incloent-hi l'opció en blanc i excloent les opcions eliminades.
getParent Retorna la secció que conté el control.
getVisible Retorna si el control és visible.
eliminarOpció Elimina una opció del control.
setDisabled Activa o desactiva el control.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setNotificació Mostra un missatge d'error per indicar que les dades no són vàlides.
setVisible Mostra o amaga el control.

Tipus de control de forma ràpida

Vegeu formContext.ui.quickForms per obtenir informació sobre els mètodes admesos per a aquest tipus de control.

Tipus de control de subquadrícula

Vegeu Graelles i subgraelles per a informació sobre mètodes admesos per a aquest tipus de control.

Tipus de control de paret de línia de temps

El control de la línia de temps presenta les publicacions, activitats i notes en una vista unificada. Aquests mètodes estan disponibles per a aquest tipus de control.

Mètode Descripció
getControlType Retorna el tipus de control.
getDisabled Retorna si el control està inhabilitat.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getParent Retorna la secció que conté el control.
getVisible Retorna si el control és visible.
refrescar Actualitza les dades mostrades a la línia de temps.
setDisabled Activa o desactiva el control.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setVisible Mostra o amaga el control.

Tipus de control del temporitzador

Aquests mètodes estan disponibles per al control del temporitzador.

Mètode Descripció
getControlType Retorna el tipus de control.
getDisabled Retorna si el control està inhabilitat.
getLabel Retorna l'etiqueta del control.
getName Retorna el nom del control.
getParent Retorna la secció que conté el control.
getState Retorna l'estat actual del temporitzador.
getVisible Retorna si el control és visible.
refrescar Actualitza les dades mostrades al temporitzador.
setDisabled Activa o desactiva el control.
setFocus Canvia el focus al control.
setLabel Canvia l'etiqueta del control.
setVisible Mostra o amaga el control.

Tipus de control de recursos web

Un control de recursos web té el mateix conjunt de mètodes disponibles que el control iframe. Vegeu el tipus de control d'iframe.

Tipus de control de component de formulari

Un tipus de control de component de formulari té el mateix conjunt de mètodes disponibles que formContext en un formulari principal. Vegeu Comportament > dels components del formulari API del client.

Columnes