Freigeben über

Xrm.Page.ui quickForms (clientseitige Referenz)

  • Artikel

 

Veröffentlicht: Januar 2017

Gilt für: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Die Xrm.Page.ui.quickForms-Sammlung bietet Methoden für den Zugriff auf alle Steuerelemente für die Schnellansicht und die zugehörigen Steuerelemente in den Microsoft Dynamics 365-Formularen, wenn sie das neue Formularrenderingmodul verwenden (auch als "Turbo-Formulare" bezeichnet). Ein Steuerelement für die Schnellansicht ist ein Schnellansichtsformular, das zu einem Hauptformular in Microsoft Dynamics 365 hinzugefügt wurde, mit dem Sie die Informationen über einen verknüpften Entitätsdatensatz im Hauptformular anzeigen können. Daten in der zugehörigen Steuerelementen in einem Steuerelement für die Schnellansicht können nicht bearbeitet werden. Weitere Informationen über Steuerelemente für die Schnellansicht und Schnellansichtsformulare finden Sie in TechNet: Erstellen und Bearbeiten von Schnellansichtsformularen

Hinweis

Diese Funktion wurde mit CRM Online 2016-Update 1 und CRM 2016 Service Pack 1 (lokal) eingeführt.

Dieses Thema gilt nur, wenn Sie das neue Formularrenderingmodul in Dynamics 365 verwenden. Wenn Sie das alte Formularrendering (auch "Aktualisierungsformulare" genannt) in Dynamics 365 verwenden, können Sie auf das Steuerelement für die Schnellansicht und die zugehörigen Steuerelemente mithilfe des Standardsteuerelementobjekts zugreifen; siehe auch Xrm.Page.ui-Steuerelement (clientseitige Referenz).

Wichtig

Mit der Veraltungsankündigung der alten Formulare in Dynamics 365 müssen Sie bald die Verwendung des neuen Formularrenderingmoduls planen, wenn Sie das alte Formularrendering verwenden. Da es einen Unterschied beim Zugriff auf die Steuerelemente für die Schnellansicht im alten und neuen neue Formularrendering gibt, müssen Sie Ihren vorhandenen Code für die Steuerelemente für die Schnellansicht aktualisieren und testen, um die Methoden zu verwenden, die im vorliegenden Thema beschrieben werden, wenn Sie zum neuen Formularrenderingmodul wechseln. Weitere Informationen zur Veraltung des alten Formularrenderings finden Sie unter Entfernung der alten Formularrenderingoption

In diesem Thema

quickForms-Sammlungsmethoden

quickForms-Objektmethoden

quickForms-Sammlungsmethoden

Die quickForms-Sammlung bietet Zugriff auf alle Steuerelemente für die Schnellansicht im Formular. Die quickForms-Sammlung unterstützt alle Standardsammlungsmethoden in Dynamics 365. Siehe Sammlungen (clíentseitige Referenz)

Im folgenden Beispiel wird gezeigt, wie eine Instanz des Steuerelements für die Schnellansicht in der quickForms-Sammlung mithilfe der 9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get-Methode abgerufen wird, indem der Indexwert (ganze Zahl) oder der Name (Zeichenfolge) für die Instanz des Steuerelements für die Schnellansicht als Argument angegeben wird.

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

quickForms-Objektmethoden

Ein quickForms-Objekt stellt eine Instanz eines Steuerelements für die Schnellansicht dar. Folgende Methoden werden für die Instanzen des Steuerelements für die Schnellansicht in einem Formular unterstützt.

  • getControl

  • getControlType

  • getName

  • getParent

  • getVisible

  • Beschriftungsmethoden

  • isLoaded

  • Aktualisieren

getControl

Ruft die zugehörigen Steuerelemente in einem Steuerelement für die Schnellansicht ab.

quickViewControl.getControl()

Sie können auf ein einzelnes Steuerelement in der zugehörigen Sammlung von Steuerelementen zugreifen, indem Sie das Argument entweder als Name oder zugehörigen Indexwert des Steuerelements an ein Steuerelement für die Schnellansicht übergeben. Beispiel: quickViewControl.getControl("firstname") oder quickViewControl.getControl(0).

  • Rückgabewert
    Typ:-Objektsammlung, wenn Sie die Methode ohne Argument verwenden; Objekt, wenn Sie die Methode mit einem Argument verwenden.

  • Anmerkungen
    Nachdem Sie ein zugehöriges Steuerelement in einem Steuerelement für die Schnellansicht abgerufen haben, können Sie eine der Methoden verwenden, die für ein Dynamics 365-Steuerelement im zugehörigen Steuerelement unterstützt werden, das die zugehörigen Steuerelementdaten nicht ändert. Dies liegt daran, dass zugehörige Steuerelemente in einem Steuerelement für die Schnellansicht schreibgeschützt sind. Sie können beispielsweise Folgendes verwenden: quickViewControl.getControl(0).getAttribute() Weitere Informationen über die Methoden, die für ein Dynamics 365-Steuerelement unterstützt werden, finden Sie unter Xrm.Page.ui-Steuerelement (clientseitige Referenz)

    Wichtig

    51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute oder eine beliebige Datenmethode in einem zugehörigen Steuerelement funktionieren möglicherweise nicht mit dem Hauptformular f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent, da das gebundene Schnellansichtsformular beim Laden des Hauptformulars möglicherweise nicht vollständig geladen wurde. Sie müssen die isLoaded-Methode für die Instanz des Steuerelements für die Schnellansicht verwenden, um zu ermitteln, ob das gebundene Schnellansichtsformular vollständig geladen wurde. Weitere Informationen: isLoaded

    Die Art des Abrufens der zugehörigen Steuerelemente in einem Steuerelement für die Schnellansicht auf Formularen unterscheidet sich beim neuen Formularrenderingmodul von den Vorgängerformularen. Wenn Sie daher Vorgängerformulare verwenden und Code für zugehörige Steuerelemente in einem Steuerelement für die Schnellansicht haben, müssen Sie Ihren Code aktualisieren, wenn Sie sich entscheiden, das neue Formularrenderingmodul in Dynamics 365 zu verwenden.

getControlType

Gibt einen Zeichenfolgenwert zurück, der die Steuerelemente für die Schnellansicht kategorisiert.

quickViewControl.getControlType()

Für ein Steuerelement für die Schnellansicht gibt die Methode quickform zurück.

Für ein zugehöriges Steuerelement in einem Steuerelement für die Schnellansicht gibt die Methode die tatsächliche Kategorie des Steuerelements zurück. Weitere Informationen über andere mögliche Rückgabewerte finden Sie unter 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType.

getName

Gibt den Namen zurück, der dem Steuerelement für die Schnellansicht zugewiesen ist.

quickViewControl.getName()
  • Rückgabewert
    Typ: Zeichenfolge. Der Name des Steuerelements für die Schnellansicht.

getParent

Gibt einen Verweis auf das Abschnittsobjekt zurück, das das Steuerelement enthält.

Steuerelementtypen: Alle.

quickViewControl.getParent()

getVisible

Gibt einen Wert zurück, der angibt, ob das Steuerelement für die Schnellansicht derzeit angezeigt wird.

Hinweis

Wenn der beinhaltende Abschnitt oder die Registerkarte für dieses Steuerelement nicht angezeigt wird, kann diese Methode weiterhin true zurückgeben. So stellen Sie sicher, dass das Steuerelement tatsächlich angezeigt wird; Sie müssen auch die Sichtbarkeit der enthaltenden Elemente überprüfen.

quickViewControl.getVisible()
  • Rückgabewert
    Typ: Boolesch.True, wenn das Steuerelement für die Schnellansicht sichtbar ist, andernfalls false.

Beschriftungsmethoden

Abrufen oder Ändern der Beschriftung für ein Steuerelement für die Schnellansicht mit den getLabel- und setLabel-Methoden.

getLabel

Gibt die Beschriftung für das Steuerelement für die Schnellansicht zurück.

quickViewControl.getLabel()
  • Rückgabewert
    Typ: Zeichenfolge. Die Beschriftung des Steuerelements für die Schnellansicht.

setLabel

Legt die Beschriftung für das Steuerelement für die Schnellansicht fest.

quickViewControl.setLabel("label")
  • Argumente
    Typ: Zeichenfolge. Die neue Beschriftung des Steuerelements für die Schnellansicht.

isLoaded

Gibt zurück, ob die Datenbindung für die zugehörigen Steuerelemente in einem Steuerelement für die Schnellansicht abgeschlossen ist.

quickViewControl.isLoaded()

  • Rückgabewert
    Typ: Boolesch. "True" bedeutet, dass die Datenbindung für ein zugehöriges Steuerelement vollständig ist, andernfalls "false".

  • Anmerkungen
    Die Datenbindung für die zugehörigen Steuerelemente in einem Steuerelement für die Schnellansicht kann im Rahmen des Hauptformulars f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent nicht abgeschlossen sein, da das Schnellansichtsformular, an das das Steuerelement gebunden ist, möglicherweise nicht vollständig geladen wurde. Dies hat zum Ergebnis, dass 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute oder eine andere datenbezogene Methode in einem zugehörigen Steuerelement nicht funktioniert. Die isLoaded-Methode für das Steuerelement für die Schnellansicht hilft dabei, den Datenbindungsstatus des zugehörigen Steuerelements in einem Steuerelement für die Schnellansicht festzustellen.

Der folgende Beispielcode zeigt, wie Sie isLoaded-Methode verwenden können, um den Bindungsstatus zu überprüfen und anschließend den Wert des Attributs abzurufen, an das das zugehörige Steuerelement in einem Steuerelement für die Schnellansicht gebunden ist.

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;
    }    
}

Aktualisieren

Aktualisiert die Daten, die in einem Steuerelement für die Schnellansicht angezeigt werden.

quickViewControl.refresh()

Siehe auch

Cclientseitige Programmierreferenz
Kurzübersicht zum Formularskripting
Xrm.Page.ui (clientseitige Referenz)
Xrm.Page.ui-Steuerelement (clientseitige Referenz)
Schreiben von Code für Microsoft Dynamics 365-Formulare
Verwenden des Xrm.Page-Objektmodells

Microsoft Dynamics 365

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright