formContext.getControl (référence de l’API client)

Obtient un contrôle dans le formulaire.

Notes

getControl ne fonctionne que sur les contrôles dans le corps et l’en-tête du formulaire. Il n’est pas pris en charge pour les contrôles ailleurs sur la page, même s’ils font référence à la même colonne.

• Pour les contrôles au sein des flux de processus métier, faites-y référence avec le préfixe header_process_.
• Les contrôles au sein d’autres contrôles, tels que les sous-grilles et les contrôles de chronologie ne sont pas pris en charge.

Syntaxe

formContext.getControl(arg);

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

Paramètre

arg : Facultatif. Vous pouvez accéder à un contrôle dans un formulaire en passant un argument comme le nom ou la valeur d’index du contrôle dans un formulaire. Par exemple : formContext.getControl("firstname") ou formContext.getControl(0). Si le nom arg est mal orthographié et ne figure pas sur le formulaire, il renvoie une valeur nulle.

Quand la valeur arg n’est pas fournie, elle renvoie un tableau de tous les contrôles du formulaire.

Valeur renvoyée

Type : collection d’objets, objet ou nul.

Description : collection d’objets si vous utilisez la méthode sans aucun paramètre. Objet ou nul si vous utilisez la méthode avec un paramètre. Si vous utilisez le nom comme paramètre et qu’il existe plusieurs contrôles pour la même colonne, seul le premier contrôle est renvoyé.

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));

Articles associés

formContext

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é).