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.entityAttribute.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.
Les méthodes suivantes pour le contrôle Standard sont obsolètes dans cette version : addOnKeyPress, fireOnKeyPress et removeOnKeyPress.
Type de contrôle IFRAME
Ces méthodes sont disponibles pour un contrôle IFRAME.
Type de contrôle kbsearch (recherche dans la Base de connaissances)
Ces méthodes sont disponibles pour le contrôle de recherche dans la Base de connaissances.
Note
Lorsque le contrôle de recherche dans la Base de connaissances est ajouté au volet social, le nom du contrôle sera searchwidgetcontrol_notescontrol. Ce nom ne peut pas être modifié.
Type de contrôle de recherche
Ces méthodes sont disponibles pour un contrôle de recherche.
Options et types de contrôles d’option
Les options et les contrôles d’option utilisent le même ensemble de méthodes.
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
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 de mur de chronologie
Le contrôle Chronologie répertorie les publications, les activités et les notes dans une vue unifiée. Ces méthodes sont disponibles pour ce type de contrôle.
Type de contrôle de minuteur
Ces méthodes sont disponibles pour le contrôle de minuterie.
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 Silverlight présente ces méthodes supplémentaires :
Astuce
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