Utiliser le modèle d’objet Xrm.Page
Date de publication : janvier 2017
S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Lorsque vous rédigez des scripts de formulaire, vous interagissez avec des objets de l’espace de noms Xrm.Page pour effectuer les actions suivantes :
Obtenir ou définir des valeurs d’attributs.
Afficher et masquer des éléments de l’interface utilisateur.
Référencer plusieurs contrôles par attribut.
Accéder à plusieurs formulaires par entité.
Gérer les éléments de navigation dans les formulaires.
Interaction avec le contrôle de flux des processus d'entreprise.
Pour plus d’exemples, voir Référence rapide des scripts de formulaires.
Contenu de la rubrique
Hiérarchie d’objets Xrm.Page
Contexte d’exécution
Regroupements
Descriptions d’objets
attribut
contexte
contrôle
Entité
formSelector
navigation
traiter
Section
phase
étape
Onglet
Hiérarchie d’objets Xrm.Page
Comme l’indique la figure suivante, Xrm.Page fournit un conteneur d’espace de noms pour trois objets décrits dans le tableau suivant :
Objet |
Description |
|---|---|
context |
Fournit des méthodes pour récupérer des informations spécifiques à une organisation, un utilisateur ou des paramètres qui ont été transmises au formulaire dans une chaîne de requête. |
data |
Permet d'accéder aux données et aux méthodes d'entité afin de gérer les données dans le formulaire, ainsi que dans le contrôle de flux des processus d'entreprise |
ui |
Contient des méthodes pour récupérer les informations concernant l’interface utilisateur, outre les collections pour plusieurs sous-composants du formulaire. |
.jpeg "Modèle d'objet Xrm.Page")
Contexte d’exécution
Lorsque vous enregistrez une fonctionnalité pour un gestionnaire d’événements, vous avez la possibilité de passer un objet de contexte d’exécution comme premier paramètre à la fonctionnalité. Cet objet contient des méthodes qui vous permettent de gérer les variables que vous souhaitez partager avec d’autres gestionnaires d’événements et l'événements d'enregistrement. Pour plus d'informations, consultez les rubriques Contexte d'exécution (référence côté client) et Enregistrement des arguments d'événement (référence côté client).
Regroupements
Le tableau suivant décrit les collections de modèles d’objet Xrm.Page. Voir Collections (référence côté client) pour plus d’informations sur les modes disponibles pour des collections.
Collection |
Description |
|---|---|
attributes |
La collection Xrm.Page.data.entity.attributes permet d’accéder à chaque attribut d’entité disponible dans le formulaire. Seuls les attributs qui correspondent aux champs ajoutés au formulaire sont disponibles. |
controls |
Trois objets contiennent un ensemble de contrôles :
|
navigation.items |
La collection Xrm.Page.ui.navigation.items donne accès aux éléments de navigation qui sont définis dans la zone de navigation de l’éditeur de formulaires. Grâce aux formulaires TechNet : formulaires actualisés, les utilisateurs accèdent à ces derniers à l’aide de la barre de commandes. Dans TechNet : formulaires classiques, ils se trouvent du côté gauche du formulaire. |
formSelector.items |
Lorsque plusieurs formulaires sont fournis pour une entité, vous pouvez associer chaque formulaire à des rôles de sécurité. Lorsque les rôles de sécurité associés à un utilisateur lui permettent d’afficher plusieurs formulaires, la collection Xrm.Page.ui.formSelector.items permet d’accéder à chaque définition de formulaire disponible pour cet utilisateur. |
tabs |
Vous pouvez planifier chaque formulaire en utilisant un ou plusieurs onglets. La collection Xrm.Page.ui.tabs donne accès à chacun de ces onglets. |
sections |
Vous pouvez planifier chaque onglet de formulaire en utilisant une ou plusieurs sections. La collection sections d’onglet donne accès à toutes ces sections. |
Collections de flux de processus d'entreprise
Les collections relatives aux phases et aux étapes du Xrm.Page.data.process sont basées sur la même structure de collection mais permettent également d'ajouter ou de supprimer des éléments des collections.
Utilisez la méthode getStages du traiter pour accéder à la collection de phases. Utilisez la méthode getSteps de la phase pour accéder à la collection d'étapes.
Descriptions d’objets
Chaque objet possède plusieurs méthodes pour extraire des données, obtenir ou définir des propriétés d’objet, ou effectuer des actions :
attribut
Chaque attribut correspond à un attribut d’entité qui est ajouté au formulaire en tant que champ. Généralement, seuls les attributs d’entité qui ont été ajoutés au formulaire en tant que champs sont disponibles. Chaque instance d’un champ est un contrôle. Un champ peut être ajouté à un formulaire plusieurs fois, ce qui crée plusieurs contrôles qui correspondent au même attribut.
Notes
Les attributs composés ont des comportements spéciaux.Pour plus d'informations :Écrire des scripts pour les attributs composés
Les attributs sont classés par type. Vous pouvez choisir le type d’un attribut via la méthode getAttributeType.
Lorsque les attributs partagent les mêmes méthodes courantes, certaines méthodes sont disponibles uniquement pour des types d’attributs spécifiques. Pour plus d'informations, voir Attribut Xrm.Page.data.entity (référence côté client).
Notes
Les informations de type d’attribut représentent le comportement de l’attribut dans le formulaire. Elles ne correspondent pas nécessairement au type de champ défini dans l’application ou les types AttributeMetadata. Les attributs d’un type de champ particulier peuvent se comporter différemment selon la façon dont ils sont mis en forme.
Le tableau suivant répertorie les valeurs de chaîne du type d’attribut à prévoir pour chaque type de schéma d’attribut et de format d’option.
Type de champ d’application |
Option de format |
Type d'attribut |
|---|---|---|
Devise |
N/A |
money |
Date et heure |
Date et heure, Date uniquement |
datetime |
Nombre décimal |
N/A |
decimal |
Nombre à virgule flottante |
N/A |
double |
Recherche |
N/A |
lookup |
Plusieurs lignes de texte |
N/A |
memo |
Groupe d’options |
N/A |
optionset |
Une seule ligne de texte |
Courrier électronique, Texte, Symbole de l’action, URL, Téléphone |
string |
Une seule ligne de texte |
Zone de texte |
memo |
Statut |
N/A |
optionset |
Raison du statut |
N/A |
optionset |
Deux options |
Deux cases d’option, Case à cocher, Liste |
boolean |
Nombre entier |
Aucun, Durée |
integer |
Nombre entier |
Langue, Fuseau horaire |
optionset |
contexte
Xrm.Page.context fournit des méthodes pour récupérer des informations spécifiques à une organisation, un utilisateur ou des paramètres qui ont été transmises au formulaire dans une chaîne de requête. Pour plus d'informations, voir Contexte côté client (référence côté client).
contrôle
Représente un élément HTML présent dans le formulaire. Certains contrôles sont liés à un attribut spécifique, pendant que d’autres peuvent représenter des contrôles non liés tels qu’un IFRAME, une ressource Web ou une sous-grille ayant été ajoutée au formulaire.
Utilisez des noms de contrôle spécifiques dans votre code pour les contrôles IFrame, Ressource Web et Sous-grille. Ces contrôles ne sont pas liés à un attribut. Évitez d’inclure des noms de contrôle spécifiques dans votre code lorsque le contrôle est lié à un attribut. Lorsque plusieurs contrôles sont liés à un attribut, les noms de contrôle sont déterminés au moment de l’exécution et peuvent varier en fonction de l’emplacement du contrôle dans le formulaire.
Pour la plupart des tâches associées à l’attribution des contrôles liés, accédez aux contrôles en utilisant la collection de contrôles d’attribut ou via la collection de contrôles d’une section. Plutôt que de se référer à un contrôle par nom, vous pouvez également le faire en fonction du contexte de la collection. Dans ce cas, le nom n’est pas important. Reportez-vous à l’exemple relatif à l’attribut Contrôles permettant de créer des fonctionnalités pour effectuer des actions dans tous les contrôles liés à un attribut spécifique.
Notes
Les attributs composés ont des comportements spéciaux.Pour plus d'informations :Écrire des scripts pour les attributs composés.
Notes
Pour la plupart des tâches de développement de script en dehors de Microsoft Dynamics 365, les développeurs peuvent avoir l’habitude de faire référence à des éléments de page en utilisant la méthode document.getElementById. Pour les scripts de formulaire Microsoft Dynamics 365, cette méthode n’est pas prise en charge. Il est important de savoir que l’attribut stocke les données et que le contrôle est simplement la présentation de l’attribut dans le formulaire. Pour les contrôles liés aux attributs, vous devrez peut-être ajuster votre manière d’accéder aux données du formulaire.
Les contrôles sont classés par type. Vous pouvez choisir le type d’un contrôle via la méthode 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType. Certaines méthodes de contrôle sont uniquement disponibles pour des types de contrôles spécifiques. Par exemple, la méthode 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_addOption est disponible uniquement pour les contrôles qui sont présentés sous la forme de groupes d’options. Pour plus d'informations, voir Contrôle Xrm.Page.ui (référence côté client).
Entité
Xrm.Page.data.entity fournit des méthodes pour récupérer des informations spécifiques à l’enregistrement affichées sur la page, la méthode save et une collection de tous les attributs inclus dans le formulaire. Pour plus d'informations, voir Xrm.Page.data.entity (référence côté client).
formSelector
Xrm.Page.ui.formSelector contient une collection d’éléments qui fournit des fonctionnalités pour interroger les formulaires disponibles pour l’utilisateur actuel. Utilisez la méthode bcf42b09-b672-4f4b-b866-ea7b24cc3ae0#BKMK_navigate pour fermer le formulaire actif et pour en ouvrir un autre. Pour plus d'informations, voir Élément Xrm.Page.ui.formSelector (référence côté client).
navigation
Ne contient aucune méthode. Permet d’accéder aux éléments de navigation via la collection d’éléments.
traiter
Contient des méthodes permettant d'extraire les propriétés d'un flux des processus d'entreprise.Pour plus d'informations :Méthodes de processus
Section
Une section contient des méthodes pour gérer le mode d’affichage en plus de l’accès à l’onglet qui contient la section. Une section donne également accès aux contrôles qu’elle renferme via une collection de contrôles.Pour plus d'informations :Xrm.Page.ui section (référence côté client)
phase
Chaque traiter est composé d'une collection de phases accessible à l'aide de la méthode du processus getStages.
Une seule phase est la phase active.Pour plus d'informations :Structure des flux de processus d'entreprise
étape
Les étapes représentent des éléments de données individuels à collecter pendant une phase. Chaque phase dispose d'une collection d'étapes accessibles à l'aide de la méthode de phasegetSteps.Pour plus d'informations :Structure des flux de processus d'entreprise
Vous pouvez accéder à un contrôle d'étape de la phase active d'un contrôle de flux des processus d'entreprise en référençant le nom du contrôle avec le préfixe « header_process_<nom du contrôle> ». Par exemple, pour masquer l'étape qui représente l'attribut purchaseprocess, utilisez ce qui suit :
Xrm.Page.getControl("header_process_purchaseprocess").setVisible(false);
Onglet
Un onglet est un groupe de sections sur une page. Il contient des méthodes permettant de modifier la présentation de l’onglet. Vous pouvez accéder à des sections dans l’onglet via la collection de sections. Pour plus d'informations, voir Onglet Xrm.Page.ui (référence côté client).
Voir aussi
Référence rapide des scripts de formulaires
Écrire et déboguer des scripts pour Dynamics 365 pour téléphones et tablettes
Écrire du code pour les formulaires Microsoft Dynamics 365
Écrire des scripts pour les attributs composés
Écriture d'événements pour les flux de processus d'entreprise
Utilisation de JavaScript avec Microsoft Dynamics 365
Référence par programmation côté client
Référence par programmation côté client
Bibliothèques JavaScript pour Microsoft Dynamics 365
Personnaliser les formulaires d’entités
Microsoft Dynamics 365
© 2017 Microsoft. Tous droits réservés. Copyright