Enregistrement des arguments d'événement (référence côté client)

Article
03/04/2017

Date de publication : janvier 2017

S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Dans l'événement d'enregistrement, vous pouvez utiliser la méthode getEventArgs d'objet du contexte d'exécution pour récupérer un objet qui contient des méthodes permettant de gérer l'événement d'enregistrement.

Méthodes d'argument d'événement d'enregistrement

getSaveMode
Renvoie la valeur indiquant comment l'événement d'enregistrement a été initié par l'utilisateur.
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.
preventDefault
Annule l'opération d'enregistrement, mais tous les gestionnaires restants pour l'événement seront toujours exécutés.

getSaveMode

Renvoie la valeur indiquant comment l'événement d'enregistrement a été initié par l'utilisateur.

execObj.getEventArgs().getSaveMode()

Valeur renvoyée
Type : Nombre

Le tableau suivant décrit les valeurs prises en charge renvoyées pour détecter les différentes manières dont les enregistrements d'entité peuvent être enregistrés par l'utilisateur.

Entité	Mode d'événement	Valeur
Tous	Enregistrer	1
Tous	Enregistrer et fermer	2
Tous	Enregistrer et nouveau	59
Tous	Enregistrement automatique	70
Activités	Enregistrer sous le statut terminé	58
Tous	Désactiver	5
Tous	Réactiver	6
Entités appartenant à un utilisateur ou à une équipe	Attribuer	47
Courrier électronique (email)	Envoyer	7
Prospect	Inclure	16
Prospect	Exclure	15

Remarques
Cette méthode est indispensable si vous souhaitez activer l'enregistrement automatiquement pour la plupart des formulaires dans une organisation mais le désactiver pour des formulaires spécifiques. Le code suivant enregistré pour l'événement onSave avec le contexte d'exécution qui lui est transmis empêche les enregistrements initiés par un enregistrement automatique, mais autorise tous les autres. Lorsque l'enregistrement automatique est activé, le fait de quitter équivaut à enregistrer et fermer. Ce code empêche les enregistrements initiés par le minuteur de 30 secondes ou lorsque les utilisateurs quittent un formulaire avec des données non enregistrées.
```
function preventAutoSave(econtext) {
    var eventArgs = econtext.getEventArgs();
    if (eventArgs.getSaveMode() == 70 || eventArgs.getSaveMode() == 2) {
        eventArgs.preventDefault();
    }
}
```
Pour enregistrer un enregistrement, l'utilisateur doit cliquer sur l'icône Enregistrer en bas du formulaire ou une commande Enregistrer personnalisée doit être ajoutée à la barre de commandes.

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.

execObj.getEventArgs().isDefaultPrevented()

Valeur renvoyée
Type : Booléen.

preventDefault

Annule l'opération d'enregistrement, mais tous les gestionnaires restants pour l'événement seront toujours exécutés.

execObj.getEventArgs().preventDefault()

Voir aussi

Référence par programmation côté client
Collections (référence côté client)
Référence rapide des scripts de formulaires
Contexte d'exécution (référence côté client)
getEventArgs
Écrire du code pour les formulaires Microsoft Dynamics 365
Utiliser le modèle d’objet Xrm.Page

Microsoft Dynamics 365