Partager via

Contexte de formulaire de l’API client

Le contexte de formulaire de l’API client (formContext) fournit une référence au formulaire ou à un élément du formulaire, tel qu’un contrôle d’affichage rapide ou une ligne dans une grille modifiable, par rapport à laquelle le code actuel est exécuté.

Précédemment, vous avez utilisé l’objet global Xrm.Page pour représenter un formulaire ou un élément sur le formulaire. Dans la dernière version, l’objet Xrm.Page est déconseillé. Utilisez plutôt la méthode getFormContext de l’objet de contexte d’exécution transmis pour renvoyer une référence au formulaire approprié ou à un élément du formulaire.

Important

Déprécié signifie que Microsoft a l’intention de supprimer une fonctionnalité ou une capacité d’une future version majeure des applications basées sur des modèles. La fonctionnalité ou la capacité continue à fonctionner et sera entièrement prise en charge jusqu’à ce qu’elle soit officiellement supprimée. Microsoft fait une annonce publique au moins six mois avant la suppression, dans la documentation, sur le blog officiel, et dans de nombreux autres endroits.

Pour maintenir la compatibilité descendante avec les scripts existants, l’utilisation de l’objet Xrm.Page en tant qu’accès statique au contexte de formulaire principal est toujours prise en charge et ne sera pas supprimée aussi rapidement que d’autres méthodes d’API clientes répertoriées dans la section de dépréciation de l’API cliente. Utilisez le nouvel objet formContext au lieu de l’objet Xrm.Page dans votre code ciblant la version 9.0 ou ultérieure, le cas échéant. En outre, à l’aide de l’objet formContext , vous pouvez créer des gestionnaires d’événements courants qui peuvent fonctionner sur un formulaire ou dans une grille modifiable en fonction de l’emplacement où il est appelé. Pour plus d’informations, consultez getFormContext (référence de l’API cliente).

L’obtention de l’objet formContext pour les fonctions Javascript pour des actions de ruban est différente de la manière dont vous obtenez celui-ci dans les scripts de formulaire. Pour plus d’informations, consultez le contexte de formulaire et de grille dans les actions du ruban.

Note

Les contextes de formulaire ne sont valides que pendant l’événement où ils sont transmis. Les mêmes restrictions s’appliquent qu’avec les contextes d’exécution.

Utiliser l’objet formContext au lieu de l’objet Xrm.Page

Il est facile de convertir du code existant qui utilise Xrm.Page pour utiliser le nouvel objet formContext . Par exemple, prenez le script suivant qui utilise l’objet Xrm.Page :

function displayName()
{
   var firstName = Xrm.Page.getAttribute("firstname").getValue();
   var lastName = Xrm.Page.getAttribute("lastname").getValue();
   console.log(firstName + " " + lastName);
}

Voici le script mis à jour qui utilise le contexte d’exécution passé pour récupérer l’objet formContext au lieu d’utiliser l’objet Xrm.Page statique :

function displayName(executionContext)
{
   var formContext = executionContext.getFormContext(); // get formContext

   // use formContext instead of Xrm.Page   
   var firstName = formContext.getAttribute("firstname").getValue(); 
   var lastName = formContext.getAttribute("lastname").getValue();
   console.log(firstName + " " + lastName);
}

Important

Sélectionnez le contexte d’exécution pass comme première option de paramètre dans la boîte de dialogue Propriétés du gestionnaire lors de la définition de vos gestionnaires d’événements pour utiliser l’objet formContext . Pour plus d’informations, consultez le contexte d’exécution de l’API cliente.

Modèle d’objet formContext

Utilisez les objets data et ui sous l’objet formContext pour manipuler par programme les éléments de données et d’interface utilisateur dans les applications basées sur un modèle.

modèle d’objet formContext.

objet de données

Fournit des propriétés et des méthodes pour travailler avec les données d’un formulaire, y compris les données de table et les données du contrôle flux des processus d’entreprise. Contient les objets suivants :

Objet Description
attributes Collecte de données non tabulaires sur le formulaire. Les éléments de cette collection sont du même type que la collection de colonnes, mais ce ne sont pas des colonnes de la table de formulaire.
Pour plus d’informations, voir Collections
entity Fournit des méthodes pour récupérer des informations spécifiques de l'enregistrement affiché sur la page, la méthode de sauvegarde, et une collection de toutes les colonnes incluses dans le formulaire. Les données de colonne sont limitées aux colonnes représentées sur le formulaire.
Pour plus d′informations, voir formContext.data.entity
process Fournit des objets et des méthodes pour interagir avec les données du flux des processus d′entreprise dans un formulaire.
Pour plus d’informations, voir formContext.data.process

Fournit également une collection d’attributs pour accéder à un contrôle non lié à une table. Consultez la section Collections du modèle d’objet formContext plus loin dans cet article.

Pour plus d’informations, consultez : formContext.data

Objet UI

Fournit des méthodes pour récupérer des informations sur l’interface utilisateur, en plus des regroupements pour plusieurs sous-composants du formulaire ou de la grille. Contient les objets suivants :

Objet Description
formSelector Fournit une collection d’éléments que vous pouvez utiliser pour interroger les formulaires disponibles pour l’utilisateur actuel. Utilisez la navigate méthode pour fermer le formulaire actuel et ouvrir une autre méthode.
navigation Ne contient aucune méthode. Permet d’accéder aux éléments de navigation via la collection d’éléments. Consultez la section suivante sur les collections pour plus d’informations.
process Fournit des méthodes pour interagir avec le contrôle du flux des processus d’entreprise dans un formulaire.

Pour plus d’informations, consultez : formContext.ui

Collections du modèle d’objet formContext

Le tableau suivant décrit les collections dans le modèle objet Xrm . Pour plus d’informations sur les méthodes disponibles pour les collections en général, voir Collections (référence de l’API client).

Collection Description
attributes Deux objets contiennent une collection de colonnes :

- La collection formContext.data.attributes permet d’accéder aux colonnes non liées à une table.

- La collection formContext.data.entity.attributes permet d’accéder à chaque colonne de table disponible sur le formulaire. Seules les colonnes ajoutées au formulaire sont disponibles.
Contrôles Trois objets contiennent un ensemble de contrôles :

- formContext.ui.controls : donne accès à chaque contrôle présent dans le formulaire.

- formContext.data.entity.attribute.controls : étant donné qu’une colonne peut avoir plusieurs contrôles sur le formulaire, cette collection fournit un accès à chacun d’eux. Cette collection ne contient qu’un seul élément, sauf si plusieurs contrôles pour la colonne sont ajoutés au formulaire.

- formContext.ui.tabs.sections.controls : cette collection contient uniquement les contrôles disponibles dans la section.
formContext.data.process.étapes et formContext.data.process.actions Donne accès à une collection de phases et d’étapes dans un flux des processus d’entreprise. Elles permettent également d’ajouter et de supprimer des éléments de la collection.
formContext.ui.formSelector.items Lorsque plusieurs formulaires sont fournis pour une table, 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 formContext.ui.formSelector.items permet d’accéder à chaque définition de formulaire disponible pour cet utilisateur.
formContext.ui.navigation.items La collection formContext.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. Les utilisateurs accèdent à ces éléments à l’aide de la barre de commandes.
formContext.ui.quickForms Fournit des méthodes pour accéder à tous les contrôles d’aperçu rapide et leurs contrôles constitutifs dans les formulaires.
formContext.ui.tabs Vous pouvez organiser chaque formulaire en utilisant un ou plusieurs onglets. Cette collection donne accès à chacun de ces onglets.
formContext.ui Tab.sections Vous pouvez organiser chaque onglet de formulaire en utilisant une ou plusieurs sections. La collection sections donne accès à chacune de ces sections. Vous devez définir l’onglet qui contient la section souhaitée ou parcourir chaque onglet pour trouver la section appropriée.

Méthode getFormContext
Méthode getGlobalContext
méthode getAttribute
méthode getControl
Méthodes du contexte d’exécution

  • Last updated on