getEventArgs (référence de l’API client)

Renvoie un objet avec les méthodes pour gérer les événements.

Syntaxe

ExecutionContextObj.getEventArgs()

Valeur renvoyée

Type : Objet

Description : lorsqu’un événement spécifié se produit, vous pouvez utiliser la méthode getEventArgs de l’objet de contexte d’exécution pour récupérer un objet qui peut contenir des méthodes supplémentaires que vous pouvez utiliser. Le tableau ci-dessous décrit les méthodes :

Événements	Méthodes de l’objet retourné
OnChange	None
OnDataLoad	getDataLoadState  : Permet d’obtenir l’état de la chargement de données. Il renvoie une énumération avec les valeurs suivantes : - InitialLoad =1 - Save = 2 - Refresh = 3
OnGridDataLoad	None
OnLoad	getDataLoadState  : Permet d’obtenir l’état de la chargement de données. Il renvoie une énumération avec les valeurs suivantes : - InitialLoad =1 - Save = 2 - Refresh = 3
OnLookupTagClick	- getTagValue  : Obtient la valeur de la balise sélectionnée. La valeur renvoyée pour la méthode getTagValue est une valeur LookupValue. - preventDefault : Annule l’opération d’enregistrement, mais tous les gestionnaires restants pour l’événement seront toujours exécutés. - isDefaultPrevented : Renvoie la valeur indiquant si l’événement d’enregistrement a été annulé, car la méthode preventDefault a été utilisée dans ce gestionnaire d’événements ou un gestionnaire d’événements précédent.
OnPostSearch	None
Événement OnPostSave	- getEntityReference : Renvoie une valeur de recherche faisant référence à l’enregistrement. - getIsSaveSuccess : renvoie des données indiquant si l’opération d’enregistrement a réussi. - getSaveErrorInfo : si l’opération d’enregistrement a échoué, renvoie des données sur la raison de l’échec.
OnProcessStatusChange	- getStatus  : Retourne le statut du flux des processus d’entreprise : Active, Finished ou Aborted.
OnPreProcessStatusChange	- getStatus  : Retourne le statut du flux des processus d’entreprise : Active, Finished ou Aborted.
Événement OnPreStageChange	- getStage  : récupère l’objet de phase correspondant à l’événement déclenché. Renvoie la phase sélectionnée pour l’événement OnStageSelected et la phase suivante ou précédente pour l’événement OnStageChange, selon le sens du déplacement. Informations complémentaires : Méthodes de la phase.
OnReadyStateComplete	None
OnRecordSelect	None
OnResultOpened	None
OnSave	- getSaveMode : Renvoie la valeur indiquant comment l’événement d’enregistrement a été initié par l’utilisateur. - preventDefault : Annule l’opération d’enregistrement, mais tous les gestionnaires restants pour l’événement seront toujours exécutés. - isDefaultPrevented : Renvoie la valeur indiquant si l’événement d’enregistrement a été annulé, car la méthode preventDefault a été utilisée dans ce gestionnaire d’événements ou un gestionnaire d’événements précédent. Si l’événement est asynchrone et que les gestionnaires asynchrones sont activés, les éléments suivants sont également disponibles : - preventDefaultOnError : annule l’opération de sauvegarde si le gestionnaire d’événements a une erreur de script. - disableAsyncTimeout : désactive le délai d’expiration du gestionnaire asynchrone par défaut.
OnSelection	None
OnStageChange	- getStage  : récupère l’objet de phase correspondant à l’événement déclenché. Renvoie la phase sélectionnée pour l’événement OnStageSelected et la phase suivante ou précédente pour l’événement OnStageChange, selon le sens du déplacement. Informations complémentaires : Méthodes de la phase. - getDirection  : récupère la direction de l’action de progression de phase. Il renvoie une valeur de chaîne Next ou Previous.
OnStageSelected	- getStage  : récupère l’objet de phase correspondant à l’événement déclenché. Renvoie la phase sélectionnée pour l’événement OnStageSelected et la phase suivante ou précédente pour l’événement OnStageChange, selon le sens du déplacement. Informations complémentaires : Méthodes de la phase. - getDirection  : récupère la direction de l’action de progression de phase. Il renvoie une valeur de chaîne Next ou Previous.
OnTabStateChange	None
PreSearch	None

Articles associés

Contexte d’exécution

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