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

Dans les applications basées sur des modèles, un contrôle représente un élément HTML sur le formulaire. Certains contrôles sont liés à une colonne spécifique, tandis que d’autres représentent des contrôles non liés tels qu’un IFRAME, une ressource web ou un sous-réseau ajouté 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. Contrôles d’accès à l’aide de l’une des collections suivantes :

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

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

Note

Lorsque vous effectuez des actions sur des contrôles liés à une colonne, considérez que le contrôle peut apparaître sur la page plusieurs fois. En règle générale, vous devez effectuer les mêmes actions pour chaque contrôle pour la colonne. Vous pouvez parcourir la collection de contrôles de colonne et effectuer les actions sur chaque contrôle.

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

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

Type de contrôle standard

Ces méthodes sont disponibles pour un contrôle Standard.

Method	Description
addNotification	Affiche une notification d’erreur ou de recommandation avec des actions facultatives.
clearNotification	Supprime une notification du contrôle.
getAttribute	Renvoie la colonne auquel le contrôle est lié.
getControlType	Retourne le type du contrôle.
getDisabled	Retourne si le contrôle est désactivé.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getOutputs	Retourne un dictionnaire des propriétés de sortie du contrôle.
getParent	Retourne la section qui contient le contrôle.
getVisible	Retourne si le contrôle est visible.
setDisabled	Active ou désactive le contrôle.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setNotification	Affiche un message d’erreur pour indiquer que les données ne sont pas valides.
setVisible	Affiche ou masque le contrôle.

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

Type de contrôle IFRAME

Ces méthodes sont disponibles pour un contrôle IFRAME.

Method	Description
getContentWindow	Retourne la fenêtre de contenu de la ressource IFRAME ou web.
getControlType	Retourne le type du contrôle.
getDisabled	Retourne si le contrôle est désactivé.
getInitialUrl	Retourne l’URL par défaut configurée pour l’IFRAME.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getObject	Renvoie l’objet de formulaire qui représente l’IFRAME ou la ressource web.
getParent	Retourne la section qui contient le contrôle.
getSrc	Retourne l’URL actuellement affichée dans l’IFRAME ou la ressource web.
getVisible	Retourne si le contrôle est visible.
setDisabled	Active ou désactive le contrôle.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setSrc	Définit l’URL à afficher dans l’IFRAME ou la ressource web.
setVisible	Affiche ou masque le contrôle.

Type de contrôle Kbsearch (recherche de base de connaissances)

Ces méthodes sont disponibles pour le contrôle de recherche de la base de connaissances.

Method	Description
addOnPostSearch	Ajoute un gestionnaire d’événements qui s’exécute après la fin d’une recherche.
addOnResultOpened	Ajoute un gestionnaire d’événements qui s’exécute lorsqu’un résultat de recherche s’ouvre.
addOnSelection	Ajoute un gestionnaire d’événements qui s’exécute lorsqu’un résultat de recherche est sélectionné.
getControlType	Retourne le type du contrôle.
getDisabled	Retourne si le contrôle est désactivé.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getParent	Retourne la section qui contient le contrôle.
getSearchQuery	Retourne le texte utilisé comme critères de recherche.
getSelectedResults	Retourne le résultat de recherche actuellement sélectionné.
getTotalResultCount	Retourne le nombre de résultats de recherche.
getVisible	Retourne si le contrôle est visible.
openSearchResult	Ouvre un résultat de recherche spécifié.
removeOnPostSearch	Supprime un gestionnaire d’événements pour l’achèvement de la recherche.
removeOnResultOpened	Supprime un gestionnaire d’événements pour ouvrir un résultat de recherche.
removeOnSelection	Supprime un gestionnaire d’événements pour sélectionner un résultat de recherche.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setSearchQuery	Définit le texte utilisé comme critères de recherche.
setVisible	Affiche ou masque le contrôle.

Note

Lorsque vous ajoutez le contrôle de recherche de la base de connaissances au volet social, le nom du contrôle est searchwidgetcontrol_notescontrol. Tu ne peux pas changer ce nom.

Type de contrôle de recherche

Ces méthodes sont disponibles pour un contrôle de recherche.

Method	Description
addCustomFilter	Ajoute un filtre aux résultats de recherche, combiné à des filtres existants à l’aide de AND.
addCustomView	Ajoute une vue à la boîte de dialogue de recherche.
addNotification	Affiche une notification d’erreur ou de recommandation avec des actions facultatives.
addOnLookupTagClick	Ajoute un gestionnaire d’événements qui s’exécute lorsqu’une balise de recherche est cliquée.
addPreSearch	Ajoute un gestionnaire d’événements qui s’exécute avant une recherche de recherche.
clearNotification	Supprime une notification du contrôle.
getAttribute	Renvoie la colonne auquel le contrôle est lié.
getControlType	Retourne le type du contrôle.
getDefaultView	Retourne l’ID de la vue de recherche par défaut.
getDisabled	Retourne si le contrôle est désactivé.
getEntityTypes	Retourne les types de tables autorisés dans la recherche.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getParent	Retourne la section qui contient le contrôle.
getVisible	Retourne si le contrôle est visible.
removeOnLookupTagClick	Supprime un gestionnaire d’événements pour les clics de balise de recherche.
removePreSearch	Supprime un gestionnaire d’événements qui s’exécute avant une recherche de recherche.
setDefaultView	Définit la vue par défaut dans la boîte de dialogue de recherche.
setDisabled	Active ou désactive le contrôle.
setEntityTypes	Définit les types de tables autorisés dans la recherche.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setNotification	Affiche un message d’erreur pour indiquer que les données ne sont pas valides.
setVisible	Affiche ou masque le contrôle.

Options et types de contrôles d’option

Les choix et les contrôles de choix ont le même ensemble de méthodes disponibles.

Method	Description
addNotification	Affiche une notification d’erreur ou de recommandation avec des actions facultatives.
addOption	Ajoute une option au contrôle.
clearNotification	Supprime une notification du contrôle.
clearOptions	Supprime toutes les options du contrôle.
getAttribute	Renvoie la colonne auquel le contrôle est lié.
getControlType	Retourne le type du contrôle.
getDisabled	Retourne si le contrôle est désactivé.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getOptions	Retourne les options disponibles, y compris l’option vide et l’exclusion des options supprimées.
getParent	Retourne la section qui contient le contrôle.
getVisible	Retourne si le contrôle est visible.
removeOption	Supprime une option du contrôle.
setDisabled	Active ou désactive le contrôle.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setNotification	Affiche un message d’erreur pour indiquer que les données ne sont pas valides.
setVisible	Affiche ou masque le contrôle.

Type de contrôle de formulaire rapide

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 de sous-grille

Pour plus d’informations sur les méthodes prises en charge pour ce type de contrôle, consultez Grilles et sous-réseaux .

Type de contrôle de mur de chronologie

Le contrôle de chronologie présente les publications, les activités et les notes dans une vue unifiée. Ces méthodes sont disponibles pour ce type de contrôle.

Method	Description
getControlType	Retourne le type du contrôle.
getDisabled	Retourne si le contrôle est désactivé.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getParent	Retourne la section qui contient le contrôle.
getVisible	Retourne si le contrôle est visible.
refresh	Actualise les données affichées dans la chronologie.
setDisabled	Active ou désactive le contrôle.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setVisible	Affiche ou masque le contrôle.

Type de contrôle de minuteur

Ces méthodes sont disponibles pour le contrôle de minuterie.

Method	Description
getControlType	Retourne le type du contrôle.
getDisabled	Retourne si le contrôle est désactivé.
getLabel	Retourne l’étiquette du contrôle.
getName	Retourne le nom du contrôle.
getParent	Retourne la section qui contient le contrôle.
getState	Retourne l’état actuel du minuteur.
getVisible	Retourne si le contrôle est visible.
refresh	Actualise les données affichées dans le minuteur.
setDisabled	Active ou désactive le contrôle.
setFocus	Déplace le focus sur le contrôle.
setLabel	Modifie l’étiquette du contrôle.
setVisible	Affiche ou masque le contrôle.

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 le type de contrôle iframe.

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. Consultez l’API cliente du comportement > des composants de formulaire.

Articles associés

Colonnes