Partager via

Xrm.Page.data.entity (référence côté client)

  • Article

 

Date de publication : janvier 2017

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

Xrm.Page.data.entity fournit des méthodes pour récupérer les informations spécifiques à l’enregistrement affiché sur la page, la méthode d'enregistrement et une collection de tous les attributs inclus dans le formulaire. Les données d'attribut sont limitées aux attributs représentés par les champs du formulaire.

Propriétés et méthodes de Xrm.Page.data.entity

  • attributs
    Collection d'attributs de l'entité.

  • getDataXml
    Renvoie une chaîne représentant le fichier xml envoyé au serveur lorsque l’enregistrement est enregistré.

  • getEntityName
    Renvoie une chaîne représentant le nom logique de l’entité de l'attribut.

  • getId
    Renvoie une chaîne représentant la valeur d'ID GUID pour l'enregistrement.

  • getIsDirty
    Renvoie une valeur booléenne indiquant si les champs du formulaire ont été modifiés.

  • OnSave
    Utilisation des méthodes addOnSave et removeOnSave pour ajouter ou supprimer des gestionnaires d'événements à l'événement d'enregistrement

  • getPrimaryAttributeValue
    Obtient une chaîne pour la valeur de l’attribut principal de l’entité.

  • Enregistrer
    Enregistre l'enregistrement avec les options pour fermer le formulaire ou ouvrir un nouveau formulaire une fois l'enregistrement terminé.

attributs

La collection d'Xrm.Page.data.entity.attributes fournit des méthodes permettant d'accéder aux données d'un enregistrement affiché sur le formulaire. Pour plus d'informations sur cette collection, voir Collections (référence côté client). Voir Attribut Xrm.Page.data.entity (référence côté client) concernant les propriétés et les méthodes disponibles pour les objets dans cette collection.

getDataXml

Renvoie une chaîne représentant le fichier XML envoyé au serveur lorsque l’enregistrement est enregistré. Seules les données dans les champs modifiés sont définies sur le serveur.

Notes

Cette fonction ne fonctionne pas avec Microsoft Dynamics 365 pour tablettes.

Xrm.Page.data.entity.getDataXml()

  • Valeur renvoyée
    Type : Chaîne

    Exemple :Dans cet exemple, les trois champs suivants pour un enregistrement de compte ont été mis à jour :

    • nom

    • accountnumber

    • telephone2

    "<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425 555-1234</telephone2></account>"

getEntityName

Renvoie une chaîne représentant le nom logique de l’entité de l'attribut.

Xrm.Page.data.entity.getEntityName()

  • Valeur renvoyée
    Type : Chaîne. Nom de l'entité.

    Exemple : Dans cet exemple, un enregistrement de compte a été modifié.

    "account"

getId

Renvoie une chaîne représentant la valeur d'ID GUID pour l'enregistrement.

Xrm.Page.data.entity.getId()

  • Valeur renvoyée
    Type : Chaîne

    Exemple : Valeur d'ID GUID pour l'enregistrement.

    "{825CB223-A651-DF11-AA8B-00155DBA3804}"

getIsDirty

Renvoie une valeur booléenne indiquant si les champs du formulaire ont été modifiés.

Xrm.Page.data.entity.getIsDirty()
  • Valeur renvoyée
    Type : Booléen.

OnSave

Utilisation des méthodes addOnSave et removeOnSave pour ajouter ou supprimer des gestionnaires d'événements à l'événement d'enregistrement

addOnSave

Ajoute une fonction à appeler lorsque l'enregistrement est enregistré.

Xrm.Page.data.entity.addOnSave([function reference])

  • Paramètre
    Type : référence de fonction

    Remarques : la fonction est ajoutée en bas du pipeline gestionnaire d’événements. Le contexte d’exécution est automatiquement défini pour être transmis en tant que premier paramètre transmis aux gestionnaires d’événements définis à l'aide de cette méthode. Pour plus d'informations, voir Contexte d'exécution (référence côté client).

    Exemple : Dans cet exemple, la bibliothèque JavaScript contient deux fonctions. L'ajout de la fonction addMessageToOnSave à l'événement OnLoad de formulaire ajoute la fonction displayOrgName comme gestionnaire pour l'événement OnSave.

    function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

function addMessageToOnSave() {
    Xrm.Page.data.entity.addOnSave(displayOrgName);
}

removeOnSave

Supprime une fonction à appeler lorsque l'enregistrement est enregistré.

Xrm.Page.data.entity.removeOnSave([function reference])

  • Paramètre
    Type : référence de fonction

    Exemple : Dans cet exemple, la bibliothèque JavaScript contient deux fonctions. L'ajout de la fonction removeMessageFromOnSave à un événement de formulaire supprime la fonction displayOrgName comme gestionnaire pour l'événement OnSave.

    function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

function removeMessageFromOnSave() {
    Xrm.Page.data.entity.removeOnSave(displayOrgName);
}

getPrimaryAttributeValue

Obtient une chaîne pour la valeur de l’attribut principal de l’entité.

Xrm.Page.data.entity.getPrimaryAttributeValue()

Chaque entité comporte un attribut de chaîne désigné comme l'PrimaryNameAttribute. La valeur de cet attribut est utilisée lorsque des liens vers l'enregistrements sont affichés.

  • Valeur renvoyée
    Type : Chaîne. Valeur de l'attribut principal de l'entité.

  • Remarques
    Cette méthode est uniquement disponible pour 41462684-3e5d-4858-8be4-1a7c4fcdeff6#BKMK_UpdatedEntties.

Enregistrer

Enregistre l'enregistrement de manière synchrone avec les options pour fermer le formulaire ou ouvrir un nouveau formulaire une fois l'enregistrement terminé.

Xrm.Page.data.save et Xrm.Page.data.entity.save enregistrent les enregistrements, mais Xrm.Page.data.save fournit des fonctions de rappel une fois l'opération d'enregistrement terminée.

Xrm.Page.data.entity.save( null | "saveandclose" |"saveandnew" )

  • Arguments

    • save()
      Si aucun paramètre n'est inclus, les enregistrements sont simplement enregistrés. Ceci revient à utiliser la commande Enregistrer.

    • save("saveandclose")
      Ceci revient à utiliser la commande Enregistrer et fermer.

    • save("saveandnew")
      Ceci revient à utiliser la commande Enregistrer et nouveau.

  • Remarques
    Lorsque vous utilisez des formulaires de création rapide dans l'application Web, l'option saveandnew n'est pas appliquée. Cela fonctionne toujours comme si saveandclose était utilisée. Les formulaires de création rapide de Microsoft Dynamics 365 pour tablettes imposent le comportement d'saveandnew.

Voir aussi

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

Microsoft Dynamics 365

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