Xrm.Page.ui (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.ui contient les propriétés et les méthodes pour récupérer les informations concernant l’interface utilisateur, ainsi que les collections de plusieurs sous-composants du formulaire.

Propriétés et méthodes Xrm.Page.ui

  • Fermer
    Méthode pour fermer le formulaire.

  • Contrôles
    Une collection de tous les contrôles sur la page.

  • formSelector
    Utilisez la méthode formSelector.getCurrentItem pour récupérer des informations sur le formulaire actuellement en service et la collection formSelector.items contenant des informations sur les formulaires disponibles pour l'utilisateur.

  • getCurrentControl
    Méthode pour obtenir l'objet de contrôle ayant actuellement le focus sur le formulaire.

    Notes

    Cette méthode est obsolète dans Microsoft Dynamics CRM 2013 Correctif cumulatif 2.

  • getFormType
    Méthode pour obtenir le contexte du formulaire pour l'enregistrement.

  • navigation.items
    Une collection de tous les éléments de navigation sur la page.

  • Notification de formulaire
    Utilisez setFormNotification pour afficher les notifications de niveau de formulaire et clearFormNotification pour supprimer les notifications.

  • quickForms
    Une collection de tous les contrôles d'aperçu sur la page.

  • refreshRibbon
    Méthode à exécuter pour que le ruban évalue à nouveau les données qui contrôlent le contenu de l'affichage.

  • onglets
    Une collection de tous les onglets sur la page.

  • Méthodes ViewPort
    ViewPort représente la zone de la page contenant les données de formulaire. Il correspond au corps du formulaire et n'inclut pas les zones de navigation, d'en-tête, de pied de page ou d'Assistant Formulaire de la page. Utilisez les méthodes getViewPortHeight et getViewPortWidth pour obtenir la taille actuelle de ViewPort.

Fermer

Méthode pour fermer le formulaire.

Xrm.Page.ui.close()

Remarques :

La méthode Window.close HTML est supprimée. Pour fermer une fenêtre de formulaire, vous devez utiliser cette méthode. Si certaines modifications du formulaire ne sont pas enregistrées, l'utilisateur sera invité à dire s'il souhaite les enregistrer avant que la fenêtre ne se ferme.

Avec Microsoft Dynamics 365 pour tablettes, cette méthode imite le comportement du bouton de navigation arrière.

Contrôles

Une collection de tous les contrôles sur la page.

Voir Collections (référence côté client) pour plus d'informations sur les modes de regroupement et Contrôle Xrm.Page.ui (référence côté client) pour plus d'informations sur les objets de contrôle de la collection.

formSelector

Utilisez la méthode formSelector.getCurrentItem pour récupérer des informations sur le formulaire actuellement en service et la collection formSelector.items contenant des informations sur les formulaires disponibles pour l'utilisateur.

Notes

La collection formSelectoritems n'existe pas et la méthode formSelector.getCurrentItem n'est pas prise en charge pour les clients mobiles Dynamics 365 (téléphones et tablettes) et le centre de services interactifs.

formSelector.getCurrentItem

Méthode pour renvoyer une référence au formulaire actuellement affiché.

Notes

Lorsqu'un seul formulaire est disponible, cette méthode renvoie null.

  • Valeur renvoyée
    Type :Objet

formSelector.items

Une collection de tous les éléments de formulaire accessibles à l'utilisateur actuel.

Notes

Seuls les formulaires qui partagent une association avec l'un des rôles de sécurité de l'utilisateur sont disponibles dans cette collection.

Voir Collections (référence côté client) pour plus d'informations sur les modes de regroupement et Élément Xrm.Page.ui.formSelector (référence côté client) pour plus d'informations sur les éléments de la collection.

getCurrentControl

Méthode pour obtenir l'objet de contrôle ayant actuellement le focus sur le formulaire. Les contrôles de ressource web et IFRAME ne sont pas retournés cette méthode.

Notes

Cette méthode est obsolète dans Microsoft Dynamics CRM 2013 Correctif cumulatif 2.

Cette méthode ne renvoie pas une référence au contrôle actuel lorsque le dernier champ modifié par l'utilisateur était un attribut booléen mis en forme comme contrôle de case d'option ou de case à cocher. Cette méthode échoue aussi à renvoyer une référence immédiatement après avoir utilisé la méthode setFocus du contrôle Xrm.Page.ui.

Xrm.Page.ui.getCurrentControl()
  • Valeur renvoyée
    Type :Objet

getFormType

Méthode pour obtenir le contexte du formulaire pour l'enregistrement.

Xrm.Page.ui.getFormType()

  • Valeur renvoyée
    Type :Numéro

    Le tableau suivant répertorie les types de formulaire correspondant à la valeur renvoyée.

    Valeur

    Type de formulaire

    0

    Indéfini

    1

    Créer

    2

    Mise à jour

    3

    Lecture seule

    4

    Désactivé

    6

    Modification en bloc

    Notes

    Les formulaires de création rapide retournent 1. La valeur 5 était utilisée pour un précédent type de formulaire de création rapide qui a été supprimé.

Une collection de tous les éléments de navigation sur la page.

Notes

Cette collection n’existe pas avec Microsoft Dynamics 365 pour tablettes.

Voir Collections (référence côté client) pour plus d'informations sur les modes de regroupement et Élément Xrm.Page.ui.navigation (référence côté client) pour plus d'informations sur les éléments de la collection.

Notification de formulaire

Utilisez setFormNotification pour afficher les notifications de niveau de formulaire et clearFormNotification pour supprimer les notifications.

clearFormNotification

Utilisez cette méthode pour supprimer des notifications au niveau du formulaire.

Xrm.Page.ui.clearFormNotification(uniqueId)

  • Paramètres

    • uniqueId
      Type : Chaîne. Un identificateur unique pour le message utilisé avec setFormNotification pour définir la notification.

  • Valeur renvoyée
    Type : Booléen. True si la méthode a réussi ; sinon false.

  • Remarques
    Cette méthode est uniquement disponible pour Entités mises à jour.

setFormNotification

Utilisez cette méthode pour afficher des notifications au niveau du formulaire. Vous pouvez afficher un nombre quelconque de notifications et elles apparaîtront jusqu'à ce qu'elles soient supprimées avec clearFormNotification. Comme la hauteur de la zone de notification est limitée, chaque nouveau message est ajouté en haut. Les utilisateurs peuvent faire défiler pour afficher les messages plus anciens qui n'ont pas encore été supprimés.

Xrm.Page.ui.setFormNotification(message, level, uniqueId);

  • Paramètres

    • message
      Type : Chaîne. Le texte du message.

    • level
      Type : Chaîne. Le niveau du message.

      Le niveau définit comment le message est affiché.

      • ERROR : la notification utilise l'icône d'erreur système.

      • WARNING : la notification utilise l'icône d'avertissement système.

      • INFO : la notification utilise l'icône d'info système.

    • uniqueId
      Type : Chaîne. Un identificateur unique pour le message utilisé avec clearFormNotification pour supprimer la notification.

  • Valeur renvoyée
    Type : Booléen. True si la méthode a réussi ; sinon false.

  • Remarques
    Cette méthode est uniquement disponible pour Entités mises à jour.

quickForms

Une collection de tous les contrôles d'aperçu dans un formulaire utilisant le nouveau moteur de rendu de formulaire (également appelé « formulaires turbo »). Pour plus d'informations sur les propriétés et les méthodes prises en charge pour cette collection, voir quickForms Xrm.Page.ui (référence côté client).

refreshRibbon

Méthode à exécuter pour que le ruban évalue à nouveau les données qui contrôlent le contenu de l'affichage.

Xrm.Page.ui.refreshRibbon()

  • Valeur renvoyée
    Type : aucun

    Remarques : cette fonctionnalité est généralement utilisée lorsqu'un ruban <EnableRule> (RibbonDiffXml) dépend d'une valeur du formulaire. Une fois que votre code a modifié une valeur utilisée par une règle, utilisez cette méthode pour forcer le ruban à réévaluer les données du formulaire afin que la règle soit appliquée.

onglets

Une collection de tous les onglets sur la page.

Voir Collections (référence côté client) pour plus d'informations sur les modes de regroupement et Onglet Xrm.Page.ui (référence côté client) pour plus d'informations sur les éléments de la collection.

Méthodes ViewPort

ViewPort représente la zone de la page contenant les données de formulaire. Il correspond au corps du formulaire et n'inclut pas les zones de navigation, d'en-tête, de pied de page ou d'Assistant Formulaire de la page. Utilisez les méthodes getViewPortHeight et getViewPortWidth pour obtenir la taille actuelle de ViewPort.

Notes

Ces méthodes ne fonctionnent pas avec Microsoft Dynamics 365 pour tablettes.

getViewPortHeight

Méthode pour obtenir la hauteur de la fenêtre d'affichage en pixels.

Xrm.Page.ui.getViewPortHeight()
  • Valeur renvoyée
    Type :Numéro

getViewPortWidth

Méthode pour obtenir la largeur de la fenêtre d'affichage en pixels.

Xrm.Page.ui.getViewPortWidth()
  • Valeur renvoyée
    Type :Numéro

Voir aussi

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

Microsoft Dynamics 365

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