Événements dans les formulaires et les grilles des applications basées sur un modèle

  • Article

Les événements initient tout le code côté client. Dans les applications basées sur un modèle, vous associez une fonction spécifique au sein d′une bibliothèque JavaScript (Ressource Web de script) à exécuter lorsqu′un événement se produit. Cette fonction est appelée gestionnaire d′événements. Chaque gestionnaire d′événements spécifie une fonction unique au sein d′une bibliothèque JavaScript et tous les paramètres qui peuvent être transmis à la fonction.

Vous ne pouvez associer des gestionnaires d′événements qu′à certains événements à l′aide de l′interface utilisateur. Pour les événements qui ne peuvent pas être associés via l’interface utilisateur, l’API client fournit des méthodes qui peuvent être utilisées pour attacher des gestionnaires d’événements à ces événements.

Ajouter ou supprimer la fonction de gestionnaire d′événements d′un événement à l′aide de l′interface utilisateur

Utilisez la section Gestionnaires d′événements de la boîte de dialogue Propriétés du formulaire pour associer votre script à un événement pour les formulaires et les colonnes.

Section Gestionnaire d′événements dans les propriétés du formulaire.

Formulaires de modification en bloc

Par défaut, les gestionnaires d’événements ne sont pas appelés lorsqu’un formulaire est en mode de modification en bloc.

Pour activer un gestionnaire d’événements en mode de modification en bloc, modifiez le XML du formulaire en recherchant l’élément event approprié et en créant/définissant l’attribut BehaviorInBulkEditForm sur Enabled. Actuellement, ceci n’est pris en charge que pour les événements OnLoad.

Pour plus d’informations sur la personnalisation XML du formulaire, consultez Quand modifier le fichier de personnalisations, Personnaliser les formulaires et Schéma XML du formulaire.

Pour déterminer quand un gestionnaire d’événements est appelé sur un formulaire en mode de modification en bloc, utilisez la méthode getFormType.

Ajouter ou supprimer la fonction de gestionnaire d′événements d′un événement à l′aide de code

Utilisez les méthodes suivantes pour ajouter et supprimer un gestionnaire d’événements pour les événements qui ne peuvent pas être associés via l’interface utilisateur :

Événements  Gestionnaire d’événements
Événement OnChange d′un attribut Méthodes addOnChange et removeOnChange
Événement OnLoad d′un formulaire Méthodes formContext.ui addOnLoad et removeOnLoad
Formulaire chargé Méthodes formContext.ui addLoaded et removeLoaded
Événement OnLoad des données de formulaire Méthodes addOnLoad et removeOnLoad de formContext.data
Événement OnSave d′un formulaire Méthodes addOnSave et removeOnSave
Événement PreSearch du contrôle de recherche Méthodes addPreSearch et removePreSearch
Événement OnResultOpened du contrôle de recherche dans la base de connaissances Méthodes addOnResultOpened et removeOnResultOpened
Événement OnSelection du contrôle de recherche dans la base de connaissances Méthodes addOnSelection et removeOnSelection
Événement PostSearch du contrôle de recherche dans la base de connaissances Méthodes addOnPostSearch et removeOnPostSearch

Important

Le contexte d’exécution est automatiquement transmis comme premier paramètre aux fonctions définies à l′aide du code. Pour plus d′informations, voir Contexte d′exécution de l′API client

Pipeline d’événements de formulaire

Vous pouvez définir jusqu’à 50 gestionnaires d′événements pour chaque événement. Chaque gestionnaire d’événements est exécuté dans l’ordre dans lequel il est affiché dans la section Gestionnaires d’événements de l’onglet Événements de la boîte de dialogue Propriétés du formulaire .

Utilisez les méthodes setSharedVariable et getSharedVariable pour transmettre une variable commune entre les gestionnaires d′événements (fonctions). Utilisez la méthode getDepth du contexte d’exécution pour connaître la séquence d’exécution d’un gestionnaire d′événements par rapport à d’autres gestionnaires d′événements.

Comprendre le modèle objet de l’API client
Contexte d’exécution de l’API client
Événements (référence de l′API client)

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