Contrôles (référence de l’API client)

Un contrôle représente un élément HTML présent dans le formulaire. Certains contrôles sont liés à une colonne spécifique, pendant que d’autres peuvent représenter des contrôles non liés tels qu’un IFRAME, une ressource Web ou une sous-grille ayant été ajoutée au formulaire.

L’objet contrôle fournit des méthodes pour modifier la présentation ou le comportement d’un contrôle et identifier la colonne correspondante. Vous pouvez accéder aux contrôles à l’aide de l’une des collections suivantes :

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

La méthode formContext.getControl est une méthode de raccourci pour accéder à formContext.ui.controls.get.

Les contrôles sont classés par type. Vous pouvez choisir le type d’un contrôle via la méthode getControlType. Certaines méthodes de contrôle sont uniquement disponibles pour des types de contrôles spécifiques.

Cet article fournit des informations sur les méthodes disponibles par type de contrôle.

Type de contrôle standard

Voici les méthodes disponibles pour un contrôle standard.

addNotification clearNotification getAttribute getControlType getDisabled

getLabel getName getOutputs getParent getVisible

setDisabled setFocus setLabel setNotification setVisible

Les méthodes suivantes pour le contrôle standard sont déconseillées dans cette version : addOnKeyPress, fireOnKeyPress et removeOnKeyPress.

Type de contrôle iframe

Voici les méthodes disponibles pour un contrôle IFRAME.

getContentWindow getControlType getDisabled getInitialUrl getLabel

getName getObject getParent getSrc getVisible

setDisabled setFocus setLabel setSrc setVisible

Type de contrôle kbsearch (recherche dans la Base de connaissances)

Voici les méthodes disponibles pour le contrôle de recherche dans la Base de connaissances.

addOnPostSearch addOnResultOpened addOnSelection getControlType getDisabled getLabel getName

getParent getSearchQuery getSelectedResults getTotalResultCount getVisible openSearchResult removeOnPostSearch

removeOnResultOpened removeOnSelection setFocus setLabel setSearchQuery setVisible

Notes

Lorsque le contrôle de recherche dans la Base de connaissances est ajouté au volet social, le nom du contrôle est « searchwidgetcontrol_notescontrol ». Ce nom ne peut pas être modifié.

Type de contrôle lookup

Voici les méthodes disponibles pour un contrôle de recherche.

addCustomFilter addCustomView addNotification addOnLookupTagClick addPreSearch clearNotification getAttribute getControlType

getDefaultView getDisabled getEntityTypes getLabel getName getParent getVisible removeOnLookupTagClick

removePreSearch setDefaultView setDisabled setEntityTypes setFocus setLabel setNotification setVisible

Options et types de contrôles d’option

Les options et les contrôles d’option utilisent le même ensemble de méthodes.

addNotification addOption clearNotification clearOptions getAttribute getControlType

getDisabled getLabel getName getOptions getParent getVisible

removeOption setDisabled setFocus setLabel setNotification setVisible

Type de contrôle quickform

Voir formContext.ui.quickForms pour plus d’informations sur les méthodes prises en charge pour ce type de contrôle.

Type de contrôle subgrid

Voir Grilles et sous-grilles pour plus d’informations sur les méthodes prises en charge pour ce type de contrôle.

Type de contrôle timelinewall

Le contrôle Chronologie répertorie les publications, les activités et les notes dans une vue unifiée. Voici les méthodes disponibles pour ce type de contrôle.

getControlType getDisabled getLabel getName

getParent getVisible refresh setDisabled

setFocus setLabel setVisible

Type de contrôle timer

Voici les méthodes disponibles pour le contrôle de minuterie.

getControlType getDisabled getLabel getName

getParent getState getVisible refresh

setDisabled setFocus setLabel setVisible

Type de contrôle de ressource Web

Un contrôle de ressource Web a le même ensemble de méthodes disponibles que le contrôle iframe. Voir Type de contrôle iframe

La ressource Web Sliverlight présente ces méthodes supplémentaires :

getData setData

Conseil

Si vous souhaitez modifier tous les contrôles liés à une colonne de formulaire, utilisez la collection de contrôles à l’intérieur du type de colonne. Par exemple, pour ajouter une notification à chaque contrôle lié à la colonne name, vous pouvez effectuer les opérations suivantes :

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

Type de contrôle du composant du formulaire

Un type de contrôle de composant de formulaire dispose du même ensemble de méthodes que la variable formContext d’un formulaire principal. Voir Comportement du composant de formulaire > API client

Articles associés

Colonnes

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).