Contexte d'exécution (référence côté client)

 

Date de publication : novembre 2016

S’applique à : Dynamics CRM 2015

Le contexte d'exécution est un paramètre optionnel pouvant être transmis à une fonctionnalité de la bibliothèque JavaScript via un gestionnaire d'événements. Cette option est présente dans la boîte de dialogue des propriétés du gestionnaire lorsque vous spécifiez le nom de la fonctionnalité. Cette option est définie pour un élément <Handler> (FormXml) à l'aide de l'attribut passExecutionContext.

Le contexte d'exécution est automatiquement transmis aux fonctions définies avec les méthodes Xrm.Page.data.addOnSave et Xrm.Page.data.entityAttribute.addOnChange et Xrm.Page.uiControl.addPreSearch.

Méthodes du contexte d’exécution

  • getContext
    Méthode qui renvoie l'objet Contexte côté client (référence côté client).

  • getDepth
    Méthode qui renvoie la valeur indiquant l’ordre dans lequel ce gestionnaire est exécuté.

  • getEventArgs
    Méthode qui renvoie un objet avec les méthodes pour gérer l'événement Save.

  • getEventSource
    Méthode qui renvoie une référence à l’objet sur lequel l’événement s’est produit.

  • Variables partagées
    Les variables partagées permettent le partage d'une variable avec d'autres gestionnaires du même événement. Vous utilisez les méthodes setSharedVariable et getSharedVariable pour utiliser les variables partagées.

getContext

Méthode qui renvoie l'objet Contexte côté client (référence côté client).

ExecutionContextObj.getContext()
  • Valeur renvoyée
    Type : Objet

getDepth

Méthode qui renvoie la valeur indiquant l’ordre dans lequel ce gestionnaire est exécuté.

  • Valeur renvoyée
    Type : Nombre

    La commande commence par 0.

getEventArgs

Méthode qui renvoie un objet avec les méthodes pour gérer l'événement Save.

Notes

Cette méthode renvoie null pour tout autre événement que l'événement Save.

ExecutionContextObj.getEventArgs()

getEventSource

Méthode qui renvoie une référence à l’objet sur lequel l’événement s’est produit.

ExecutionContextObj.getEventSource()
  • Valeur renvoyée
    Type : Objet

    Cette méthode renvoie l'objet du modèle d'objet Xrm.Page qui est la source de l'événement, pas un objet HTMLDOM. Par exemple, dans un événement OnChange, cette méthode renvoie l'objet d'attribut Xrm.Page.data.entity représentant l'attribut modifié.

Variables partagées

Les variables partagées permettent le partage d'une variable avec d'autres gestionnaires du même événement. Vous utilisez les méthodes setSharedVariable et getSharedVariable pour passer des variables entre les fonctions.

setSharedVariable

Définit la valeur d’une variable qui peut être utilisée par un gestionnaire une fois que le gestionnaire actuel a terminé.

ExecutionContextObj.setSharedVariable(key, value)
  • Arguments
    String : nom de la variable

    Object : valeur à définir.

getSharedVariable

Récupère une variable définie à l’aide de setSharedVariable.

ExecutionContextObj.getSharedVariable(key)
  • Arguments
    String : nom de la variable.

  • Valeur renvoyée
    Type : Objet

    Le type spécifique dépend de ce qu'est l'objet valeur.

Voir aussi

Référence par programmation côté client

© 2017 Microsoft. Tous droits réservés. Copyright