Verwenden des Xrm.Page-Objektmodells
Veröffentlicht: Januar 2017
Gilt für: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Wenn Sie Formularskripts schreiben, interagieren Sie mit Objekten im Xrm.Page-Namespace, um die folgenden Aktionen auszuführen:
Abrufen oder Festlegen von Attributwerten.
Anzeigen und Ausblenden von Benutzeroberflächenelementen.
Verweisen auf mehrere Steuerelemente pro Attribut.
Zugreifen auf mehrere Formulare pro Entität.
Bearbeiten von Formularnavigationselementen.
Interagieren mit der Geschäftsprozessflusssteuerung.
Weitere Beispiele finden Sie unter Kurzübersicht zum Formularskripting.
In diesem Thema
Xrm.Page-Objekthierarchie
Ausführungskontext
Sammlungen
Objektbeschreibungen
Attribut
Kontext
Steuerelement
Entität
formSelector
Navigation
Prozess
Abschnitt
Phase
Schritt
Registerkarte
Xrm.Page-Objekthierarchie
Wie im folgenden Diagramm gezeigt, stellt Xrm.Page einen Namespacecontainer für drei Objekte zur Verfügung, die in der folgenden Tabelle beschrieben sind:
Objekt |
Beschreibung |
|---|---|
context |
Stellt Methoden zum Abrufen von Informationen bereit, die für eine Organisation, einen Benutzer oder Parameter spezifisch sind und an das Formular in einer Abfragezeichenfolge übergeben wurden. |
data |
Bietet Zugriff auf die Entitätsdaten und Methoden, um die Daten im Formular sowie in der Geschäftsprozessflusssteuerung zu verwalten. |
ui |
Enthält neben Sammlungen für verschiedene Unterkomponenten des Formulars Methoden zum Abrufen von Informationen zur Benutzeroberfläche. |
.jpeg "Xrm.Page-Objektmodell")
Ausführungskontext
Wenn Sie eine Funktion für einen Ereignishandler registrieren, haben Sie die Möglichkeit, ein Ausführungskontextobjekt als ersten Parameter an die Funktion zu übergeben. Dieses Objekt enthält Methoden, mit denen Sie Variablen verwalten können, die Sie für andere Ereignishandler und das bestimmte Ereignis freigeben möchten. Weitere Informationen finden Sie unter Ausführungskontext (clientseitige Referenz) und Ereignisargumente speichern (clientseitige Referenz).
Sammlungen
Die folgende Tabelle beschreibt die Sammlungen von Xrm.Page-Objektmodellen. Informationen zu den Methoden, die für Sammlungen verfügbar sind, finden Sie unter Sammlungen (clíentseitige Referenz).
Abholung |
Beschreibung |
|---|---|
attributes |
Die Xrm.Page.data.entity.attributes-Sammlung bietet Zugriff auf jedes Entitätsattribut, das im Formular verfügbar ist. Nur die Attribute, die Feldern entsprechen, die im Formular hinzugefügt wurden, sind verfügbar. |
controls |
Drei Objekte enthalten eine Sammlung von Steuerelementen:
|
navigation.items |
Die Xrm.Page.ui.navigation.items-Sammlung bietet Zugriff auf die Navigationselemente, die mithilfe des Navigationsbereichs des Formular-Editors definiert werden. Im Fall von TechNet: Aktualisierte Formulare navigieren Benutzer zu diesen mithilfe der Befehlsleiste. In TechNet: Klassische Formularesind diese auf der linken Seite des Formulars. |
formSelector.items |
Wenn für eine Entität mehrere Formulare bereitgestellt werden, können Sie jedem Formular Sicherheitsrollen zuordnen. Wenn die Sicherheitsrollen, die einem Benutzer zugeordnet sind, es diesem ermöglichen, mehr als ein Formular anzuzeigen, bietet die Xrm.Page.ui.formSelector.items-Sammlung Zugriff auf jede Formulardefinition, die für den Benutzer verfügbar ist. |
tabs |
Sie können jedes Formular organisieren, indem Sie eine oder mehrere Registerkarten verwenden. Die Xrm.Page.ui.tabs-Sammlung bietet Zugriff auf jede dieser Registerkarten. |
sections |
Sie können jede Registerkarte im Formular organisieren, indem Sie einen oder mehrere Abschnitte verwenden. Die Registerkarten-sections-Sammlung bietet Zugriff auf jeden dieser Abschnitte. |
Geschäftsprozessfluss-Sammlungen
Sammlungen für Phasen und Schritte in Xrm.Page.data.process basieren auf derselben Sammlungsstruktur, erlauben jedoch auch das Hinzufügen oder Entfernen von Sammlungen aus den Sammlungen.
Verwenden Sie die Prozess.getStages-Methode, um auf die Sammlung von Phasen zuzugreifen. Verwenden Sie die Phase.getSteps-Methode, um auf die Sammlung von Schritten zuzugreifen.
Objektbeschreibungen
Jedes Objekt besitzt verschiedene Möglichkeiten zum Abrufen von Daten, zum Abrufen oder Festlegen von Objekteigenschaften oder zum Ausführen von Aktionen:
Attribut
Jedes Attribut entspricht einem Entitätsattribut, das dem Formular als Feld hinzugefügt wurde. Im Allgemeinen stehen nur jene Entitätsattribute, die dem Formular als Feld hinzugefügt wurden, zur Verfügung. Jede Instanz eines Felds ist ein Steuerelement. Ein Feld kann in einem Formular mehrmals hinzugefügt werden, wodurch mehrere Steuerelemente erstellt werden, die auf das gleiche Attribut verweisen.
Hinweis
Zusammengesetzte Attribute weisen spezielles Verhalten auf.Weitere Informationen:Schreiben von Skripts für zusammengesetzte Attribute
Attribute werden nach Typ kategorisiert. Sie können den Typ eines Attributs feststellen, indem Sie die getAttributeType-Methode verwenden.
Alle Attribute haben zwar einige gebräuchliche Methoden gemeinsam, aber bestimmte Methoden sind nur für spezifische Attributtypen verfügbar. Weitere Informationen finden Sie unter Xrm.Page.data.entity-Attribut (clientseitige Referenz).
Hinweis
Attributtypinformationen stellen das Verhalten des Attributs im Formular dar. Sie entsprechen nicht unbedingt dem Feldtyp, der in der Anwendung oder in den AttributeMetadata-Typen definiert ist. Attribute eines bestimmten Feldtyps können sich abhängig von ihrer Formatierung unterschiedlich verhalten.
Die folgende Tabelle enthält die Attributtyp-Zeichenfolgenwerte, die für jeden Attributschematyp und jede Formatoption zu erwarten sind.
Anwendungsfeldtyp |
Format-Option |
Attributtyp |
|---|---|---|
Währung |
NA |
money |
Datum und Uhrzeit |
Datum und Uhrzeit, Nur Datum |
datetime |
Dezimalzahl |
NA |
decimal |
Gleitkommazahl |
NA |
double |
Suche |
NA |
lookup |
Mehrere Textzeilen |
NA |
memo |
Optionssatz |
NA |
optionset |
Einzelne Textzeile |
E-Mail, Text, Tickersymbol, URL, Telefon |
string |
Einzelne Textzeile |
Textbereich |
memo |
Status |
NA |
optionset |
Statusgrund |
NA |
optionset |
Zwei Optionen |
Zwei Optionsfelder, Kontrollkästchen, Liste |
boolean |
Ganze Zahl |
Keine, Dauer |
integer |
Ganze Zahl |
Sprache, Zeitzone |
optionset |
Kontext
Xrm.Page.context stellt Methoden zum Abrufen von Informationen bereit, die für eine Organisation, einen Benutzer oder Parameter spezifisch sind und an das Formular in einer Abfragezeichenfolge übergeben wurden. Weitere Informationen finden Sie unter Clientseitiger Kontext (clientseitige Referenz).
Steuerelement
Stellt ein HTML-Element dar, das im Formular vorhanden ist. Einige Steuerelemente sind an ein spezifisches Attribut gebunden, während andere ungebundene Steuerelemente darstellen können, z. B. einen IFRAME, eine Webressource oder ein Unterraster, der/die/das für das Formular hinzugefügt wurde.
Verwenden Sie spezifische Steuerelementnamen im Code für die IFrame-, Webressourcen- und Unterraster-Steuerelemente. Diese Steuerelemente sind nicht an ein Attribut gebunden. Vermeiden Sie es, spezifische Steuerelementnamen im Code zu verwenden, wenn das Steuerelement an ein Attribut gebunden ist. Wenn mehrere Steuerelemente an ein Attribut gebunden sind, werden die Steuerelementnamen zur Laufzeit bestimmt und können abhängig davon, wo sich das Steuerelement im Formular befindet, variieren.
Für die meisten Aufgaben im Zusammenhang mit Steuerelementen, die an Attribute gebunden sind, greifen Sie auf die Steuerelemente zu, indem Sie die Sammlung von Attributsteuerelementen oder die Sammlung von Steuerelementen eines Abschnitts verwenden. Statt namentlich auf ein Steuerelement zu verweisen, wird ein Verweis darauf basierend auf dem Kontext der Sammlung erstellt. In diesem Fall ist der Name nicht wichtig. Im Beispiel für das Attribut Steuerelemente finden Sie Informationen zum Erstellen von Funktionen, mit denen Aktionen für alle Steuerelemente, die an ein bestimmtes Attribut gebunden sind, ausgeführt werden können.
Hinweis
Zusammengesetzte Attribute weisen spezielles Verhalten auf.Weitere Informationen:Schreiben von Skripts für zusammengesetzte Attribute.
Hinweis
Bei der Entwicklung der meisten Skripts außerhalb von Microsoft Dynamics 365 sind es die Entwickler u. U. gewöhnt, mithilfe der document.getElementById-Methode auf Seitenelemente zu verweisen. Für Microsoft Dynamics 365-Formularskripts wird diese Methode nicht unterstützt. Es ist wichtig, zu erkennen, dass das Attribut die Daten speichert, und dass das Steuerelement einfach für die Darstellung des Attributs im Formular vorhanden ist. Bei Steuerelementen, die an Attribute gebunden sind, müssen Sie unter Umständen Ihre gewohnte Art, wie Sie auf Daten in einem Formular zugreifen, anpassen.
Steuerelemente werden nach Typ kategorisiert. Sie können den Typ eines Steuerelements feststellen, indem Sie die 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType-Methode verwenden. Bestimmte Steuerungsmethoden sind nur für spezifische Steuerelementtypen verfügbar. Beispielsweise ist die 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_addOption-Methode nur für Steuerelemente verfügbar, die als Optionssätze dargestellt werden. Weitere Informationen finden Sie unter Xrm.Page.ui-Steuerelement (clientseitige Referenz).
Entität
Xrm.Page.data.entity enthält Methoden zum Abrufen von Informationen, die für den auf der Seite angezeigten Datensatz, die save-Methode und eine Sammlung aller im Formular enthaltenen Attribute spezifisch sind. Weitere Informationen finden Sie unter Xrm.Page.data.entity (clientseitige Referenz).
formSelector
Xrm.Page.ui.formSelector enthält eine Elementsammlung, die Funktionen zum Abfragen der Formulare bereitstellt, die für den aktuellen Benutzer verfügbar sind. Verwenden Sie die bcf42b09-b672-4f4b-b866-ea7b24cc3ae0#BKMK_navigate-Methode, um das aktuelle Formular zu schließen und ein anderes zu öffnen. Weitere Informationen finden Sie unter Xrm.Page.ui.formSelector-Element (clientseitige Referenz).
Navigation
Enthält keine Methoden. Bietet Zugriff auf die Navigationselemente über die Elementsammlung.
Prozess
Enthält Methoden, um Eigenschaften eines Geschäftsprozessflusses abzurufen.Weitere Informationen:Prozessmethoden
Abschnitt
Ein Abschnitt enthält Methoden zum Verwalten seiner Darstellung und zum Zugreifen auf die Registerkarte, die den Abschnitt umfasst. Ein Abschnitt bietet auch Zugriff auf die darin enthaltenen Steuerelemente über eine Sammlung von Steuerelementen.Weitere Informationen:Xrm.Page.ui-Abschnitt (clientseitige Referenz)
Phase
Jedes Prozess hat eine Sammlung von Phasen, auf die mithilfe der Prozess-getStages-Methode zugegriffen werden kann.
Eine Phase ist die aktive Phase.Weitere Informationen:Struktur des Geschäftsprozessflusses
Schritt
Schritte repräsentieren einzelne Elemente von Daten, die während eines Phase gesammelt werden. Jede Phase hat eine Sammlung von Schritten, auf die mithilfe der Phase-getSteps-Methode zugegriffen werden kann.Weitere Informationen:Struktur des Geschäftsprozessflusses
Sie können auf ein Schrittsteuerelement in der aktiven Phase der Geschäftsprozessflusssteuerung zugreifen, indem Sie auf den Steuernamen mit dem speziellen Präfix "header_process_ spezielle*<control name>*" verweisen. Beispielsweise zum Ausblenden des Schritts, der das Attribut purchaseprocess darstellt, verwenden Sie Folgendes:
Xrm.Page.getControl("header_process_purchaseprocess").setVisible(false);
Registerkarte
Eine Registerkarte ist eine Gruppe von Abschnitten auf einer Seite. Sie enthält Methoden, um die Darstellung der Registerkarte zu ändern. Sie greifen auf Abschnitte in der Registerkarte über die Sammlung von Abschnitten zu. Weitere Informationen finden Sie unter Xrm.Page.ui.tab (clientseitige Referenz).
Siehe auch
Kurzübersicht zum Formularskripting
Schreiben und Debuggen von Skripts für Dynamics 365 für Smartphones und Tablets
Schreiben von Code für Microsoft Dynamics 365-Formulare
Schreiben von Skripts für zusammengesetzte Attribute
Schreiben von Skripts für Geschäftsprozessflüsse
Verwendung von JavaScript mit Microsoft Dynamics 365
Cclientseitige Programmierreferenz
Cclientseitige Programmierreferenz
JavaScript-Bibliotheken für Microsoft Dynamics 365
Anpassen von Entitätsformularen
Microsoft Dynamics 365
© 2017 Microsoft. Alle Rechte vorbehalten. Copyright