quickForms 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

La collection Xrm.Page.ui.quickForms fournit des méthodes pour accéder à tous les contrôles d'aperçu et aux contrôles constitutifs dans les formulaires Microsoft Dynamics 365 lors de l'utilisation du nouveau moteur de rendu de formulaire (également appelé « formulaires turbo »). Un contrôle d'aperçu est un formulaire d'aperçu ajouté à un formulaire principal dans Microsoft Dynamics 365 qui vous permet d'afficher des informations sur un enregistrement d'entité associé dans le formulaire principal. Il est impossible de modifier les données dans les constitutifs dans un contrôle d'aperçu. Pour plus d'informations sur les contrôles d'aperçu et les formulaires d'aperçu, voir TechNet : Créer et modifier des formulaires d'aperçu

Notes

Cette fonctionnalité a été introduite dans la mise à jour 1 de CRM Online 2016 et le Service Pack 1 de CRM 2016 (local).

Cette rubrique vous concerne uniquement si vous utilisez le nouveau moteur de rendu de formulaire dans Dynamics 365. Si vous utilisez le rendu de formulaire hérité (également appelé « formulaires d'actualisation ») dans Dynamics 365, vous pouvez accéder au contrôle de vue de rapide et à ses contrôles constitutifs à l'aide de l'objet de contrôle standard ; voir Contrôle Xrm.Page.ui (référence côté client).

Important

Avec l'annonce de l'obsolescence des formulaires hérités dans Dynamics 365, vous devrez bientôt prévoir d'utiliser le nouveau moteur de rendu de formulaires si vous utilisez l'ancien rendu. Comme il existe une différence entre la façon d'accéder aux contrôles d'aperçu de l'ancien et du nouveau rendu de formulaire, vous devrez mettre à jour et tester votre code existant en ciblant les contrôles d'aperçu pour qu'ils utilisent les méthodes décrites dans cette rubrique lorsque vous passerez au nouveau moteur de rendu de formulaire. Pour plus d'informations sur l'obsolescence de l'ancien rendu de formulaire, voir Suppression de l'option héritée de rendu de formulaire

Contenu de la rubrique

Méthodes de la collection quickForms

Méthodes d'objet quickForms

Méthodes de la collection quickForms

La collection quickForms permet d’accéder à tous les contrôles d'aperçu d'un formulaire. La collection quickForms prend en charge les méthodes standard des collections dans Dynamics 365. Voir Collections (référence côté client)

L'exemple suivant montre comment récupérer une instance de contrôle d'aperçu dans la collection quickForms à l'aide de la méthode 9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get en spécifiant la valeur de l'indice (entier) ou le nom (chaîne) de l'instance du contrôle d'aperçu en tant qu'argument.

quickViewControl = Xrm.Page.ui.quickForms.get(arg)

Méthodes d'objet quickForms

Un objet quickForms représente une instance de contrôle d'aperçu. Les méthodes suivantes sont prises en charge pour les instances de contrôle d'aperçu dans un formulaire.

  • getControl

  • getControlType

  • getName

  • getParent

  • getVisible

  • Méthodes d'étiquette

  • isLoaded

  • actualiser

getControl

Récupère les contrôles constitutifs dans un contrôle d'aperçu.

quickViewControl.getControl()

Vous pouvez accéder à un contrôle unique dans la collection de contrôles constitutifs en transmettant un argument comme étant le nom ou la valeur d'index du contrôle constitutif dans un contrôle d'aperçu. Par exemple : quickViewControl.getControl("firstname") ou quickViewControl.getControl(0)

  • Valeur renvoyée
    Type : Collection d'objets si vous utilisez la méthode sans argument ; objets si vous utilisez la méthode avec un argument.

  • Remarques
    Après avoir récupéré un contrôle constitutif dans un contrôle d'aperçu, vous pouvez utiliser l'une des méthodes prises en charge pour un contrôle Dynamics 365 sur le contrôle constitutif qui ne change pas les paramètres du contrôle constitutif. Cela découle du fait que les contrôles constitutifs dans un formulaire d'aperçu sont en lecture seule. Par exemple, vous pouvez utiliser : quickViewControl.getControl(0).getAttribute(). Pour plus d'informations sur les méthodes prises en charge pour un contrôle Dynamics 365, voir Contrôle Xrm.Page.ui (référence côté client)

    Important

    La méthode 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute ou n'importe quelle méthode associée aux données sur un contrôle constitutif peut ne pas fonctionner dans le formulaire principal f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent parce que le formulaire d'aperçu auquel il est lié peut ne pas s'être chargé complètement lorsque le formulaire principal s'est chargé. Vous devez utiliser la méthode isLoaded pour l'instance de contrôle d'aperçu pour déterminer si le formulaire d'aperçu s'est chargé complètement. Pour plus d'informations, voir isLoaded

    En outre, la façon de récupérer les contrôles constitutifs dans un contrôle d'aperçu sur des formulaires avec le nouveau moteur de rendu de formulaire est différente de celle des formulaires hérités. Ainsi, si vous utilisez les formulaires hérités et que vous avez du code qui cible des contrôles constitutifs dans un contrôle d'aperçu, vous devez mettre votre code à jour lorsque vous décidez d'utiliser le nouveau moteur de rendu de formulaire dans Dynamics 365.

getControlType

Renvoie une valeur chaîne qui classe les contrôles d'aperçu.

quickViewControl.getControlType()

Pour un contrôle d'aperçu, la méthode renvoie quickform.

Pour un contrôle constitutif dans un contrôle d'aperçu, la méthode renvoie la catégorie réelle du contrôle. Pour plus d’informations sur les autres valeurs de retour possibles, voir 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType.

getName

Renvoie le nom attribué au contrôle d'aperçu.

quickViewControl.getName()
  • Valeur renvoyée
    Type : Chaîne. Nom du contrôle d'aperçu.

getParent

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

Types de contrôle : tous.

quickViewControl.getParent()

getVisible

Retourne une valeur qui indique si le contrôle d'aperçu est actuellement visible.

Notes

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.

quickViewControl.getVisible()
  • Valeur renvoyée
    Type : Booléen.True si le contrôle d'aperçu est visible ; sinon, false.

Méthodes d'étiquette

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

getLabel

Retourne l’étiquette du contrôle d'aperçu.

quickViewControl.getLabel()
  • Valeur renvoyée
    Type : Chaîne. Étiquette du contrôle d'aperçu.

setLabel

Définit l’étiquette du contrôle d'aperçu.

quickViewControl.setLabel("label")
  • Arguments
    Type : Chaîne. Nouvelle étiquette du contrôle d'aperçu.

isLoaded

Indique si la liaison des données pour les contrôles constitutifs dans un contrôle d'aperçu est terminée.

quickViewControl.isLoaded()
  • Valeur renvoyée
    Type : Booléen. True indique que la liaison des données pour un contrôle constitutif est terminée ; sinon, false.

  • Remarques
    La liaison des données pour les contrôles constitutifs d'un contrôle d'aperçu peut ne pas être terminée pendant l'événement f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent du formulaire principal parce que le formulaire le formulaire principal auquel est lié le contrôle peut ne pas s'être chargé complètement. Par conséquent, l'utilisation de la méthode 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute ou d'une autre méthode associée aux données dans un contrôle constitutif peut ne pas fonctionner. La méthode isLoaded pour le contrôle d'aperçu permet de déterminer le statut de la liaison des données pour les contrôles constitutifs dans un contrôle d'aperçu.

L'exemple de code suivant montre comment utiliser la méthode isLoaded pour vérifier le statut de la liaison, puis récupérer la valeur de l'attribut auquel est lié le contrôle constitutif dans un contrôle d'aperçu.

function getAttributeValue() {
    var quickViewControl = Xrm.Page.ui.quickForms.get("<QuickViewControlName>");
    if (quickViewControl != undefined)
    {
        if (quickViewControl.isLoaded())
        {
            // Access the value of the attribute bound to the constituent control
            var myValue = quickViewControl.getControl(0).getAttribute().getValue();
            console.log(myValue);
            return;
        }
        else
        {
            // Wait for some time and check again
            setTimeout(getAttributeValue, 10);
        }
    }
    else
    {
        console.log("No data to display in the quick view control.");
        return;
    }    
}

actualiser

Actualise les données affichées dans un contrôle d'aperçu.

quickViewControl.refresh()

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)
Contrôle 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