Contrôle Xrm.Page.ui (référence côté client)

 

Date de publication : janvier 2017

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

L’objet control fournit des méthodes pour modifier la présentation ou le comportement d’un contrôle et d’identifier l’attribut correspondant.

Vous pouvez accéder aux contrôles à l’aide des collections suivantes : Xrm.Page.ui.Contrôles, Xrm.Page.ui Section.Contrôles ou Xrm.Page.data.entity Attribute.Contrôles. La méthode Xrm.Page.getControl est une méthode de raccourcis pour accéder à Xrm.Page.ui.controls.get.

L'exemple de syntaxe présenté dans cette rubrique montre l’utilisation de la méthode Xrm.Page.getControl pour accéder à un contrôle. Le contrôle dépend des arguments passés à la méthode. Le paramètre args pour accéder à un contrôle unique doit correspondre au nom du contrôle ou de l’index.

Lorsqu’un formulaire affiche un contrôle de vidage des processus d’entreprise dans l’en-tête, les contrôles supplémentaires sont ajoutés pour chaque attribut affiché dans les flux de processus d’entreprise. Ces contrôles ont un nom unique similaire à l'exemple suivant : header_process_<attribute name>.

Note

Seuls les contrôles de l'étape active du flux de processus métier sont accessibles par nom de cette façon.

Les contrôles affichés dans l’en-tête de formulaire sont accessibles et ont un nom unique comme suit : header_<attribute name>.

Pour les contrôles liés aux attributs, il est commun d’accéder aux contrôles via la collection Xrm.Page.data.entity Attribute.Contrôles.

Les contrôles personnalisés pour les clients mobiles Dynamics 365 (téléphones et tablettes) prennent en charge toutes les propriétés et méthodes de contrôle sauf les suivantes : Méthodes de saisie semi-automatique, getValue, Méthodes d'activation de touche et Recherche de méthodes et d’événements de contrôle.

Avec le lancement de Mise à jour 1 de Microsoft Dynamics CRM Online 2016 et de Microsoft Dynamics CRM 2016 Service Pack 1 (local), les méthodes suivantes sont désormais prises en charge pour le contrôle minuterie sur le nouveau moteur de rapport de formulaire (également appelé « formulaires turbo ») : méthodes getControlType, getName, getParent, Étiquette, refresh, et méthodes Visible.

Propriétés et méthodes relatives aux contrôles

  • Méthodes de saisie semi-automatique
    Permet de configurer l'expérience de saisie semi-automatique des contrôles de texte dans les formulaires Dynamics 365. Ces méthodes ont été présentées dans Dynamics 365.

  • Désactivé
    Détecte l’état et active ou désactive les contrôles à l’aide des méthodes getDisabled et setDisabled.

  • getAttribute
    Obtient l’attribut auquel le contrôle est lié.

  • getControlType
    Obtient les informations relatives au type de contrôle.

  • getName
    Obtient le nom du contrôle.

  • getParent
    Obtient l’objet section dans lequel le contrôle se trouve.

  • getValue
    Récupère la dernière valeur pour un contrôle lorsque les utilisateurs tapent un caractère dans un champ de texte ou de nombre spécifique. Cette méthode a été introduite dans Dynamics 365.

  • Méthodes d'activation de touche
    Permet l'ajout, la suppression ou l'exécution d'une fonctionnalité lorsque l'utilisateur appuie sur la clé d'un contrôle. Ces méthodes ont été présentées dans Dynamics 365.

  • Méthodes relatives au contrôle de recherche dans la Base de connaissances
    Ces méthodes ne sont disponibles que pour le contrôle de recherche dans la Base de connaissances dans une instance de Dynamics 365 ayant la fonctionnalité de gestion des connaissances activée.

    Pour plus d'informations sur ce contrôle, voir Contrôle de recherche de la Base de connaissances (référence côté client).

  • Étiquette
    Obtient ou modifie l’étiquette d’un contrôle à l’aide des méthodes getLabel et setLabel.

  • Recherche de méthodes et d’événements de contrôle
    Contrôle les résultats affichés pour qu’un utilisateur puisse choisir lorsqu’il définit la valeur d’un contrôle de recherche à l’aide des méthodes addCustomFilter, addCustomView, getDefaultView et setDefaultView.

    Vous pouvez ajouter ou supprimer des gestionnaires d’événements pour Événement PreSearch à l’aide des méthodes addPreSearch et removePreSearch.

  • Notification
    Affiche et supprime des notifications relatives à un contrôle pour les utilisateurs à l’aide des méthodes setNotification, addNotification et clearNotification.

  • Méthodes du contrôle de groupe d’options
    Modifie les options affichées dans les contrôles OptionSet à l’aide des addOption, clearOptions et removeOption.

  • ShowTime
    Utilisez setShowTime pour spécifier si un contrôle de date doit indiquer la partie horaire dans la date et getShowTime pour déterminer si une partie horaire de la date est actuellement affichée.

  • Méthodes de contrôle SubGrid
    Pour les organisations utilisant Mise à jour 1 de CRM Online 2015, il existe de nouvelles fonctionnalités pour utiliser les contrôles de sous-grille.Pour plus d'informations :Méthodes et objets de grille (lecture seule) (référence côté client)

    Pour les autres organisations, la méthode refresh est la seule disponible pour les contrôles de sous-grille. Cette méthode actualisera les données affichées dans la sous-grille.

  • Visible
    Détermine quels contrôles sont visibles et les affiche ou les masque à l’aide des méthodes getVisible et setVisible.

  • Méthodes relatives aux contrôles de ressources Web et IFRAME
    Interagit avec les contrôles de ressources Web et IFRAME à l’aide des méthodes getData, setData, getInitialUrl, getObject, setSrc et getSrc.

Méthodes de saisie semi-automatique

Utilisez les méthodes showAutoComplete et hideAutoComplete pour configurer l'expérience de saisie semi-automatique des contrôles de texte dans les formulaires.

Pour un exemple de code JavaScript qui montre la fonctionnalité de saisie semi-automatique, voir Exemple : Saisie semi-automatique dans les contrôles Dynamics 365

Note

Ces méthodes ne sont pas prises en charge pour les clients mobiles Dynamics 365 (téléphones ou tablettes) et le centre de services interactifs. Ces méthodes sont disponibles uniquement pour Entités mises à jour.

showAutoComplete

À utiliser pour afficher jusqu'à 10 chaînes de correspondance dans une liste déroulante lorsque les utilisateurs appuient sur des touches pour saisir des caractères dans un champ de texte spécifique. Vous pouvez également ajouter une commande personnalisée avec une icône en bas de la liste déroulante. À la sélection d'un élément de la liste déroulante, les valeurs du champ de texte changent en fonction de l'élément sélectionné, la liste déroulante disparaît et Événement OnChange pour le champ de texte est appelé.

Xrm.Page.getControl(arg).showAutoComplete(object)
  • Paramètre
    Type : objet qui définit l'ensemble de résultats, comprenant results et commands, à afficher dans la liste déroulante de saisie semi-automatique.

    Remarques : appelez cette méthode dans une fonction que vous avez ajoutée à l'aide de la méthode addOnKeyPress devant être exécutée lors de l'événement keypress.

    Exemple : cet exemple montre la définition de l'objet à passer à la méthode showAutoComplete.

    var resultset = { 
       results: [{ 
             id: <value1>, 
             icon: <url>, 
             fields: [<fieldValue1>]}, 
    
             {...}, 
    
             { 
             id: <valueN>, 
             icon: <url>, 
             fields: [<fieldValue1, fieldValue2,..., fieldValueN>]}],
       commands:{ 
             id: <value>, 
             icon: <url>, 
             label: <value>, 
             action: <function reference> 
       } 
    }
    

hideAutoComplete

Utilisez cette fonction pour masquer la liste déroulante de saisie semi-automatique que vous avez configurée pour un champ de texte spécifique.

Xrm.Page.getControl(arg).hideAutoComplete()

Note

Vous ne devez pas utiliser explicitement la méthode hideAutoComplete car, par défaut, la liste déroulante masque automatiquement si l'utilisateur clique quelque part ou si une nouvelle liste déroulante apparaît. Cette fonctionnalité est disponible dans le cas où les développeurs doivent masquer explicitement la liste déroulante de saisie semi-automatique pour gérer un scénario personnalisé.

Désactivé

Utilisez getDisabled et setDisabled pour le détecter si un contrôle est désactivé ou pour l’activer ou le désactiver.

Types de contrôle : standard, recherche, groupe d’options.

getDisabled

Retourne si le contrôle est désactivé.

Xrm.Page.getControl(arg).getDisabled()
  • Valeur renvoyée
    Type : Booléen. True si le contrôle est désactivé, autrement False.

setDisabled

Définit si le contrôle est désactivé.

Xrm.Page.getControl(arg).setDisabled(bool)
  • Arguments
    Type : Booléen. True si le contrôle doit être désactivé, autrement False.

getAttribute

Retourne l’attribut auquel le contrôle est lié.

Types de contrôle : standard, recherche, groupe d’options.

Xrm.Page.getControl(arg).getAttribute()

Note

Les contrôles qui ne sont pas liés à un attribut (sous-grille, ressource Web et IFRAME) n’ont pas cette méthode. Une erreur a été levée si vous tentez d’utiliser cette méthode dans un de ces contrôles.

  • Valeur renvoyée
    Type : Objet: Un attribut.

Remarques

Les contrôles membres constitutifs d’un contrôle de vue rapide sont inclus dans la collection de contrôles et ces contrôles ont la méthode getAttribute. Toutefois, l’attribut ne fait pas partie de la collection d’attributs de l’entité. Lorsque vous pouvez récupérer la valeur de cet attribut à l’aide de getValue, et même modifier la valeur dans setValue, les modifications que vous apportez ne sont pas stockées dans l’entité.

Le code suivant montre l’utilisation de la valeur de l’attribut mobilephone du contact lorsqu’il est affiché dans un formulaire d’entité à l’aide d’un contrôle de vue rapide nommé contactQuickForm. Ce code masque le contrôle lorsque la valeur de l’attribut est null.

var quickViewMobilePhoneControl = Xrm.Page.getControl("contactQuickForm_contactQuickForm_contact_mobilephone");
 if (quickViewMobilePhoneControl.getAttribute().getValue() == null)
 {
  quickViewMobilePhoneControl.setVisible(false);
 }

getControlType

Renvoie une valeur qui classe les contrôles par catégorie.

Types de contrôle : tous.

Xrm.Page.getControl(arg).getControlType()
  • Valeur renvoyée
    Type : Chaîne

    Valeurs de retour possibles de getControlType :

    Valeur renvoyée

    Description

    standard

    Contrôle standard.

    iframe

    Contrôle IFRAME

    lookup

    Contrôle de recherche.

    optionset

    Contrôle de groupe d’options.

    subgrid

    Contrôle de sous-grille.

    webresource

    Contrôle de ressource Web.

    notes

    Contrôle de notes.

    timercontrol

    Contrôle Minuterie.

    kbsearch

    Contrôle de recherche dans la Base de connaissances.

    customcontrol: <espace_de_noms>.<nom>

    Contrôle personnalisé pour les clients mobiles Dynamics 365 (téléphones et tablettes).

    customsubgrid:<espace_de_noms>.<nom>

    Contrôle de jeu de données personnalisé pour les clients mobiles Dynamics 365 (téléphones et tablettes).

getName

Renvoie le nom attribué au contrôle.

Note

Le nom attribué à un contrôle n’est pas défini avant le chargement du formulaire. Les modifications apportées au formulaire peuvent modifier le nom attribué à un contrôle donné.

Types de contrôle : tous.

Xrm.Page.getControl(arg).getName()
  • Valeur renvoyée
    Type : Chaîne. Nom du contrôle.

getParent

Renvoie une référence à l’objet de section contenant le contrôle.

Types de contrôle : tous.

Xrm.Page.getControl(arg).getParent()

getValue

Récupère la dernière valeur dans un contrôle lorsque l'utilisateur saisit un caractère dans un champ de texte ou de nombre spécifique. Cette méthode vous aide à créer des expériences interactives en validant des données et alertant les utilisateurs lorsqu'ils saisissent des caractères dans un contrôle.

La méthode getValue est différente de la méthode d'attribut getValue car la méthode de contrôle récupère la valeur du contrôle lorsque l'utilisateur tape dans le contrôle, par opposition à la méthode d'attribut getValue qui récupère la valeur lorsque l'utilisateur valide (enregistre) le champ.

Note

Cette méthode n'est pas prise en charge pour les clients mobiles Dynamics 365 (téléphones ou tablettes), et est disponible uniquement pour les Entités mises à jour.

Pour un exemple de code JavaScript qui utilise la méthode getValue pour configurer l'expérience de saisie semi-automatique, voir Exemple : Saisie semi-automatique dans les contrôles Dynamics 365.

Xrm.Page.getControl(arg).getValue()
  • Valeur renvoyée
    Type : Chaîne. Dernière valeur de données pour un contrôle.

Méthodes d'activation de touche

Utilisez les méthodes addOnKeyPress, removeOnKeyPress et fireOnKeyPress pour fournir des commentaires immédiats ou prendre des mesures lorsqu'un utilisateur saisit des caractères dans un contrôle. Ces méthodes vous permettent d'effectuer des validations de données dans un contrôle avant que l'utilisateur valide (enregistre) la valeur dans un formulaire.

Note

Ces méthodes ne sont pas prises en charge pour les clients mobiles Dynamics 365 (téléphones ou tablettes), et sont disponibles uniquement pour les Entités mises à jour.

addOnKeyPress

À utiliser pour ajouter une fonction comme gestionnaire d'événements pour l'événement d'activation de touche de manière à ce que la fonction soit appelée lorsque vous saisissez un caractère dans un champ de texte ou de nombre.

Pour un exemple de code JavaScript qui utilise la méthode addOnKeyPress pour configurer l'expérience de saisie semi-automatique, voir Exemple : Saisie semi-automatique dans les contrôles Dynamics 365.

Xrm.Page.getControl(arg).addOnKeyPress([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 au gestionnaire d’événement défini à l'aide de cette méthode.Pour plus d'informations :Contexte d'exécution (référence côté client)

    Vous devez utiliser une référence à une fonction nommée plutôt qu'à une fonction anonyme s'il se peut que vous souhaitiez supprimer le gestionnaire d'événements ultérieurement pour le champ.

removeOnKeyPress

À utiliser pour supprimer un gestionnaire d'événements pour un champ de texte ou de nombre que vous avez ajouté à l'aide de addOnKeyPress.

Xrm.Page.getControl(arg).removeOnKeyPress([function reference])
  • Paramètre
    Type : référence de fonction

    Remarques : Si une fonction anonyme est définie à l'aide de la méthode addOnKeyPress, elle ne peut pas être supprimée avec cette méthode.

fireOnKeyPress

À utiliser pour déclencher manuellement un gestionnaire d'événements que vous avez créé pour un champ de texte ou de nombre spécifique à exécuter sur l'événement keypress.

Xrm.Page.getControl(arg).fireOnKeyPress()

Méthodes relatives au contrôle de recherche dans la Base de connaissances

Ces méthodes ne sont disponibles que pour le contrôle de recherche dans la Base de connaissances, qui est disponible lorsque l'organisation Dynamics 365 est activée pour la fonctionnalité de gestion des connaissances. Pour plus d'informations sur ces contrôles, voir Contrôle de recherche de la Base de connaissances (référence côté client).

Étiquette

Obtient ou modifie l’étiquette d’un contrôle à l’aide des méthodes getLabel et setLabel.

Types de contrôle : tous.

getLabel

Retourne l’étiquette du contrôle.

Xrm.Page.getControl(arg).getLabel()
  • Valeur renvoyée
    Type : Chaîne. Étiquette du contrôle.

setLabel

Définit l’étiquette du contrôle.

Xrm.Page.getControl(arg).setLabel(label)
  • Arguments
    Type : Chaîne. Nouvelle étiquette pour le contrôle.

Recherche de méthodes et d’événements de contrôle

Contrôle les résultats affichés pour qu’un utilisateur puisse choisir lorsqu’il définit la valeur d’un contrôle de recherche à l’aide des méthodes addCustomFilter, addCustomView, getDefaultView et setDefaultView. Le contrôle Lookup expose également Événement PreSearch de telle sorte que vous puissiez ajouter par programme des gestionnaires d’événements à l’aide des méthodes addPreSearch et removePreSearch.

rechercheTypes de vérification :.

addCustomFilter

Permet d’ajouter des filtres aux résultats affichés dans la recherche. Chaque filtre est combiné avec tous les filtres précédemment ajoutés sous forme d'une condition « AND ».

Xrm.Page.getControl(arg).addCustomFilter(filter, entityLogicaName)
  • Arguments

    • filterXml
      Type : Chaîne : élément du filtre fetchXml à appliquer. Par exemple :

      <filter type="and">
       <condition attribute="address1_city" operator="eq" value="Redmond" />
      </filter>
      
    • entityLogicalName
      Type : Chaîne : (facultatif) s'il est défini, le filtre s’applique uniquement à ce type d’entité. Sinon, il s’applique à tous les types d’entités retournées.

  • Remarques
    Pour plus d'informations :FetchXML schema.

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

    Cette méthode peut être utilisée dans une fonction dans un gestionnaire d’événements pour l’Événement PreSearch de contrôle de recherche.

    L’exemple de code suivant concerne la recherche de Compte (parentaccountid) du formulaire Opportunité. Lorsque la fonction Sdk.setParentAccountIdFilter est défini dans le gestionnaire d’événements de formulaire Onload, la fonction Sdk.filterCustomAccounts est ajoutée à l’événement PreSearch pour cette recherche. Le résultat est que des comptes avec la valeur Catégorie (accountcategorycode) de Client favori ) (1) sont renvoyés.

    var Sdk = window.Sdk || {};
    
    Sdk.filterCustomerAccounts = function () {
        //Only show accounts with the type 'Preferred Customer'
        var customerAccountFilter = "<filter type='and'><condition attribute='accountcategorycode' operator='eq' value='1'/></filter>";
        Xrm.Page.getControl("parentaccountid").addCustomFilter(customerAccountFilter, "account");
    }
    //set 'Sdk.setParentAccountIdFilter' in the Opportunity form onload event handler
    Sdk.setParentAccountIdFilter = function () {
        Xrm.Page.getControl("parentaccountid").addPreSearch(Sdk.filterCustomerAccounts);
    }
    

addCustomView

Ajoute une nouvelle vue de la boîte de dialogue de recherche.

Xrm.Page.getControl(arg).addCustomView(viewId, entityName, viewDisplayName, fetchXml, layoutXml, isDefault)
  • Arguments

    • viewId
      Type :Chaîne : représentation de la chaîne d’un GUID pour une vue.

      Note

      Cette valeur n’est jamais enregistrée et doit être unique entre les autres vues disponibles pour la recherche. Une chaîne pour GUID non valide fonctionne, par exemple « {00000000-0000-0000-0000-000000000001} ». Il est préférable d’utiliser un outil comme guidgen.exe pour générer un GUID valide. L'outil guidgen.exe est inclus dans le Kit de développement logiciel Windows.

    • entityName
      Type : Chaîne : nom de l’entité.

    • viewDisplayName
      Type : Chaîne : nom de la vue.

    • fetchXml
      Chaîne : requête fetchXml pour la vue.

    • layoutXml
      Type :Chaîne : XML qui définit la disposition de la vue.

    • isDefault
      Type :Booléen : si la vue doit être la vue par défaut.

  • Remarques
    Cette méthode ne fonctionne pas avec les recherches Propriétaire. Les recherches propriétaire sont utilisées pour attribuer les enregistrements appartenant à l’utilisateur.

DefaultView

Vous pouvez détecter quelle vue est la vue par défaut à afficher pour permettre aux utilisateurs de sélectionner des enregistrements dans une recherche et pour modifier la vue par défaut dans getDefaultView et setDefaultView.

getDefaultView

Retourne la valeur d'ID de la vue par défaut de la boîte de dialogue de recherche.

Xrm.Page.getControl(arg).getDefaultView()
  • Valeur renvoyée
    Type : Chaîne. Valeur d'ID de la vue par défaut.

setDefaultView

Définit la vue par défaut de la boîte de dialogue du contrôle de recherche.

Xrm.Page.getControl(arg).setDefaultView(viewGuid)
  • Arguments
    Type : Chaîne. ID de la vue à définir comme vue par défaut.

Exemple : cette fonction setDefaultViewSample définit la vue par défaut de recherche de contact principal du formulaire d'entité account sur la vue Mes contacts actifs.

function setDefaultViewSample() {
    Xrm.Page.getControl("primarycontactid").setDefaultView("{00000000-0000-0000-00AA-000010001003}");
}​

Événement PreSearch

Vous pouvez ajouter ou supprimer des gestionnaires d’événements pour Événement PreSearch de contrôle de recherche à l’aide des méthodes addPreSearch et removePreSearch.

Utilisez l’événement PreSearch pour contrôler les résultats qui sont affichés pour le contrôle à l’aide des données de formulaire lorsque l’utilisateur commence à rechercher des enregistrements.

Les deux méthodes ont le Contexte d'exécution (référence côté client) passé en tant que premier paramètre.

addPreSearch

Utilisez cette méthode pour appliquer des modifications aux champs en fonction des valeurs au moment où l’utilisateur affiche les résultats de la recherche.

Xrm.Page.getControl(arg).addPreSearch(handler)
  • Arguments
    Type : fonction à ajouter.

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

L’argument est une fonction qui est uniquement exécutée avant la recherche pour fournir les résultats d’une recherche. Vous pouvez utiliser ce gestionnaire pour appeler les autres fonctions de contrôle de recherche et améliorer les résultats à afficher dans la recherche.

removePreSearch

Utilisez cette méthode pour supprimer les fonctions de gestionnaire d’événements qui ont été définies précédemment pour l’événement PreSearch.

Xrm.Page.getControl(arg).removePreSearch(handler)
  • Arguments
    Type : fonction à supprimer.

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

Notification

Utilisez ces méthodes pour afficher et désactiver des notifications pour un contrôle.

setNotification

Affiche un message d'erreur pour le contrôle pour indiquer que les données ne sont pas valides. Lorsque cette méthode est utilisée, une icône « X » rouge apparaît en regard du contrôle. Sur les clients mobiles Dynamics 365, le message s'affiche lorsque vous appuyez sur l'icône.

Xrm.Page.getControl(arg).setNotification(message,uniqueId)

Remarques

Le paramétrage d’une notification d'erreur sur un contrôle empêche l’enregistrement du formulaire.

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

Arguments

  • message
    Type : Chaîne : message à afficher.

  • uniqueId
    Type : Chaîne : ID à utiliser pour désactiver uniquement ce message en utilisant clearNotification. Facultatif.

Valeur renvoyée

Type : Booléen : indique si la méthode est réussie.

addNotification

Affiche une notification d'erreur ou de recommandation pour un contrôle, et vous permet de spécifier des actions à exécuter en fonction de la notification. Lorsque vous spécifiez une notification de type Erreur, une icône rouge « X » s'affiche en regard du contrôle. Lorsque vous spécifiez une notification de type Recommandation, une icône « i » s'affiche en regard du contrôle. Sur les clients mobiles Dynamics 365, le message s'affiche lorsque vous appuyez sur l'icône. Vous pouvez également effectuer l'action configurée en cliquant sur le bouton Appliquer ou ignorer le message.

Xrm.Page.getControl(arg).addNotification(object)

Remarques

La définition d'une notification de type Erreur sur un contrôle bloque l'enregistrement du formulaire ; la définition d'une notification de type Recommandation n'empêche pas l'enregistrement du formulaire.

Cette méthode a été introduite dans la Mise à jour de décembre 2016 pour Dynamics 365 (en ligne et local), et est disponible uniquement pour les Entités mises à jour.

Arguments

La méthode accepte un objet avec les attributs suivants :

Attribut

Type de données

Nécessaire

Description

messages

Tableau

Oui

Message à afficher dans la notification. Dans la version actuelle, seul le premier message spécifié dans ce tableau s'affiche. La chaîne que vous définissez ici s'affiche en tant que texte en gras dans la notification, et est généralement utilisée pour le titre ou l'objet de la notification. Il est recommandé de limiter votre message à 50 caractères pour une utilisation optimale.

notificationLevel

Chaîne

Non

Définit le type de notification. Les valeurs valides sont ERROR ou RECOMMENDATION. Si vous ne spécifiez pas cet attribut dans votre définition d'objet, il est défini sur ERROR par défaut.

uniqueId

Chaîne

Non

ID à utiliser pour désactiver cette notification lors de l'utilisation de clearNotification.

actions

Tableau d'objets

Non

Ensemble d'objets avec les attributs suivants :

  • message : chaîne. Message secondaire ou corps du message de la notification à afficher à l'utilisateur. Limitez votre message à 100 caractères pour une utilisation optimale.

  • actions : tableau. Actions correspondantes pour le message.

Dans la version actuelle, un seul message et l'action correspondante sont pris en charge. Cependant, vous pouvez définir plusieurs tâches à effectuer avec du code JavaScript dans le bloc d'actions.

Note

La méthode addNotification affiche une notification avec les messages que vous avez spécifiés et deux boutons standard : Appliquer et Ignorer. Lorsque vous cliquez sur Appliquer, l'action que vous définissez s'exécute ; lorsque vous cliquez sur Ignorer, le message de notification se ferme.

Valeur renvoyée

Type : Booléen : indique si la méthode est réussie.

Exemple

L'exemple de code suivant affiche une notification dans le champ Nom du compte du formulaire de compte pour définir le Symbole de l'action si le champ Nom du compte contient « Microsoft ». Si vous cliquez sur Appliquer dans la notification, le champ Symbole de l'action est défini sur "MSFT".

function addTickerSymbolRecommendation() {
    var myControl = Xrm.Page.getControl('name');
    var accountName = Xrm.Page.data.entity.attributes.get('name');
    var tickerSymbol = Xrm.Page.data.entity.attributes.get('tickersymbol');

    if (accountName.getValue('Microsoft') && tickerSymbol.getValue() != 'MSFT') {
        var actionCollection = {
            message: 'Set the Ticker Symbol to MSFT?',
            actions: null
        };

        actionCollection.actions = [function () {
            tickerSymbol.setValue('MSFT');
            myControl.clearNotification('my_unique_id');
        }];

        myControl.addNotification({
            messages: ['Set Ticker Symbol'],
            notificationLevel: 'RECOMMENDATION',
            uniqueId: 'my_unique_id',
            actions: [actionCollection]
        });
    }
    else
        console.log("Notification not set");
}

clearNotification

Supprime un message déjà affiché pour un contrôle.

Xrm.Page.getControl(arg).clearNotification(uniqueId)

Arguments

  • uniqueId
    Type : Chaîne : ID à utiliser pour effacer un message spécifique qui a été défini en utilisant setNotification ou addNotification.

    Si le paramètre uniqueId n'est pas spécifié, la notification correspondante est supprimée.

Remarques

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

Valeur renvoyée

Type : Booléen : indique si la méthode est réussie.

Méthodes du contrôle de groupe d’options

Utilisez les méthodes addOption, clearOptions et removeOption pour gérer les options disponibles pour les contrôles OptionSet.

addOption

Ajoute une option à un contrôle de groupe d’options.

Xrm.Page.getControl(arg).addOption(option, [index])

Important

Cette méthode ne vérifie pas si les valeurs des options que vous ajoutez sont valides. Si vous ajoutez des options non valides, elles ne fonctionnent pas correctement. Vous devez uniquement ajouter les options qui ont été définies pour l’attribut de groupe d’options spécifique auquel le contrôle est lié. Utilisez l’attribut getOptions ou les méthodes getOption pour obtenir des objets d’option valides à ajouter à l’aide de cette méthode.

  • Arguments

    • option
      Type : Objet : objet d’option à ajouter à OptionSet.

    • index
      Type : Nombre : (facultatif) position d’index où placer la nouvelle option. Si la position n’est pas fournie, l’option est ajoutée à la fin.

clearOptions

Efface toutes les options d’un contrôle de groupe d’options.

Xrm.Page.getControl(arg).clearOptions()

removeOption

Supprime une option du contrôle de groupe d’options.

Xrm.Page.getControl(arg).removeOption(number)
  • Arguments
    Type: Nombre : valeur de l’option à supprimer.

setFocus

Définit le focus sur le contrôle.

Xrm.Page.getControl(arg).setFocus()

ShowTime

Utilisez setShowTime pour spécifier si un contrôle de date doit indiquer la partie horaire dans la date et utilisez getShowTime pour déterminer si une partie horaire de la date est actuellement affichée.

getShowTime

Déterminez si un contrôle de date affiche la partie horaire d'une date.

Types de contrôle : contrôle standard pour les attributs datetime.

var showsTime = Xrm.Page.getControl(arg).getShowTime();

Remarques

Cette méthode a été introduite dans Mise à jour 1 de Microsoft Dynamics CRM Online 2015.

setShowTime

Spécifiez si un contrôle de date doit afficher la partie heure d’une date.

Types de contrôle : contrôle standard pour les attributs datetime.

Xrm.Page.getControl(arg).setShowTime(bool)

Remarques

Cette méthode est uniquement disponible pour Entités mises à jour. Cette méthode affiche ou masque le composant temps d'un contrôle de date où l'attribut utilise le format DateAndTime. Cette méthode n'aura aucun effet si le format DateOnly est utilisé.

Méthodes de contrôle SubGrid

Pour les versions antérieures à Mise à jour 1 de Microsoft Dynamics CRM Online 2015, la seule méthode disponible pour un contrôle de sous-grille est refresh. Avec Mise à jour 1 de CRM Online 2015, il existe de nouvelles fonctions que vous pouvez utiliser.Pour plus d'informations :Méthodes et objets de grille (lecture seule) (référence côté client)

refresh

Actualise les données affichées dans une sous-grille.

Xrm.Page.getControl(arg).refresh()

Note

La méthode d'actualisation n'est pas disponible dans le formulaire Événement OnLoad car les sous-grilles se chargent de manière asynchrone. Avec la sous-grille Événement OnLoad présentée dans Mise à jour 1 de CRM Online 2015, vous pouvez désormais détecter si la sous-grille est chargée et utiliser cette méthode avec des gestionnaires d'événements pour l'événement.

Visible

Détermine quels contrôles sont visibles et les affiche ou les masque à l’aide des méthodes getVisible et setVisible.

getVisible

Retourne une valeur qui indique si le contrôle est actuellement visible.

Note

Si la section ou l’onglet contenant(e) de ce contrôle n’est pas visible, cette méthode peut toujours retourner la valeur true. Pour vérifier que le contrôle est visible, vous devez également activer la visibilité des éléments contenants.

Xrm.Page.getControl(arg).getVisible()
  • Valeur renvoyée
    Type : Booléen.True si le contrôle est visible ; sinon, false.

setVisible

Définit une valeur qui indique si le contrôle est visible.

Xrm.Page.getControl(arg).setVisible(bool)
  • Arguments
    Type : Booléen.True si le contrôle doit être visible ; sinon, false.

Note

Si vous pouvez afficher de manière sélective les champs aux utilisateurs dans le code qui s’exécute dans l’événement Onload, nous vous recommandons de configurer les champs pour qu’ils ne soient pas visibles par défaut, puis d’utiliser setVisible(true) pour les afficher lorsque les conditions sont réunies. L’utilisation de setVisible(false) pour masquer les champs dans l’événement Onload peut entraîner le bref affichage du champ à l’utilisateur avant d’être masqué.

Si vous masquez un plus grand nombre de champs avec setVisible(false), regardez si vous pouvez les regrouper en onglets ou sections, et masquez l’onglet ou la section plutôt que les champs séparément. Cela peut améliorer les performances.

Méthodes relatives aux contrôles de ressources Web et IFRAME

Utilisez ces méthodes pour interagir avec les contrôles de ressources Web et IFRAME.

Données

Les ressources Web ont un paramètre de chaîne de requête spécial nommé data pour passer les données personnalisées. Les méthodes getData et setData fonctionnent uniquement pour les ressources Web Silverlight ajoutées à un formulaire.Pour plus d'informations :Transmission des données depuis un formulaire vers une ressource Web Silverlight intégrée

Pour les ressources Web de page Web (HTML), le paramètre des données peut être extrait de la méthode getSrc ou de l’ensemble en utilisant la méthode setSrc.

Note

Les méthodes getData et setData ne sont pas prises en charge par le centre de services interactifs.

getData

Retourne la valeur du paramètre de chaîne de requête de données passé à une ressource Web Silverlight.

Xrm.Page.getControl(arg).getData()
  • Valeur renvoyée
    Type : Chaîne. Valeur de données passée à la ressource Web Silverlight.

setData

Définit la valeur du paramètre de chaîne de requête de données passé à une ressource Web Silverlight.

Xrm.Page.getControl(arg).setData(string)
  • Arguments
    Type : Chaîne. Valeur de données à passer à la ressource Web Silverlight.

getInitialUrl

Retourne l’URL par défaut pour laquelle un contrôle IFRAME est configuré pour l’affichage. Cette méthode est disponible pour les ressources Web.

Xrm.Page.getControl(arg).getInitialUrl()
  • Valeur renvoyée
    Type : Chaîne. URL initiale.

getObject

Retourne l’objet du formulaire qui représente ou une ressource Web ou un IFRAME.

Xrm.Page.getControl(arg).getObject()
  • Valeur renvoyée
    Type : Objet. Détermine quel objet dépend du type de contrôle.

    Un IFRAME retourne l’élément IFrame du modèle DOM (Document Object Model).

    Une ressource Web Silverlight retournera l’élément Objet du modèle DOM représentant le plug-in Silverlight incorporé.

Src

Les IFRAMES et les ressources Web contiennent une propriété src pour définir les éléments à afficher dans la fenêtre incorporée. Vous pouvez obtenir ou modifier la propriété src en utilisant les méthodes getSrc et setSrc.

getSrc

Retourne l’URL actuelle en cours d’affichage dans une ressource Web ou un IFRAME.

Xrm.Page.getControl(arg).getSrc()
  • Valeur renvoyée
    Type : Chaîne.URL représentant la propriété src de la ressource Web ou de l’IFRAME.

setSrc

Définit l’URL à afficher dans une ressource Web ou un IFRAME.

Xrm.Page.getControl(arg).setSrc(string)
  • Arguments
    Type : Chaîne : URL

Voir aussi

Référence par programmation côté client
Référence rapide des scripts de formulaires
Xrm.Page.ui (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