Freigeben über

Xrm.Page.ui (clientseitige Referenz)

  • Artikel

 

Veröffentlicht: Januar 2017

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

Xrm.Page.ui enthält Eigenschaften und Methoden zum Abrufen von Informationen zur Benutzeroberfläche sowie Sammlungen für verschiedene Unterkomponenten des Formulars.

Xrm.Page.ui-Eigenschaften und -Methoden

  • Schließen
    Methode zum Schließen des Formulars

  • Steuerelemente
    Eine Sammlung aller Steuerelemente auf der Seite.

  • formSelector
    Verwenden Sie die formSelector.getCurrentItem-Methode, um Informationen zum derzeit verwendeten Formular und die formSelector.items-Sammlung zu erhalten, die Informationen zu allen Formularen enthält, die für den Benutzer verfügbar sind.

  • getCurrentControl
    Methode, um das Steuerobjekts abzurufen, das im Formular den Fokus hat.

    Hinweis

    Diese Methode war in Updaterollup 2 für Microsoft Dynamics CRM 2013 veraltet.

  • getFormType
    Methode, um den Formularkontexts für den Datensatztyp abzurufen.

  • navigation.items
    Eine Sammlung aller Navigationselemente auf der Seite.

  • Formularbenachrichtigung
    Verwenden Sie setFormNotification, um Benachrichtigungen auf Formularebene und clearFormNotification anzuzeigen, um Benachrichtigungen zu entfernen.

  • quickForms
    Eine Sammlung aller Steuerelemente für die Schnellansicht auf der Seite.

  • refreshRibbon
    Methode, um das Menüband zu veranlassen, die Daten neu zu bewerten, die steuern, was darin angezeigt wird.

  • Registerkarten
    Eine Sammlung aller Registerkarten auf der Seite.

  • ViewPort-Methoden
    ViewPort ist der Bereich der Seite, der die Formulardaten enthält. Es entspricht dem Text des Formulars und enthält nicht die Bereiche Navigation, Kopf- oder Fußzeile oder Formularassistent der Seite. Verwenden Sie die getViewPortHeight- und getViewPortWidth-Methode, um die aktuelle Größe von ViewPort abzurufen.

Schließen

Methode zum Schließen des Formulars

Xrm.Page.ui.close()

Anmerkungen:

Die Window.close-HTML -Methode wird unterdrückt. Um ein Formularfenster zu schließen, muss diese Methoden verwendet werden. Wenn nicht gespeicherte Änderungen im Formular vorhanden sind, wird der Benutzer gefragt, ob er die Änderungen speichern möchte, bevor das Fenster geschlossen wird.

Bei Microsoft Dynamics 365 für Tablets imitiert diese Methode das Verhalten der Rückwärtsnavigationsschaltfläche.

Steuerelemente

Eine Sammlung aller Steuerelemente auf der Seite.

Siehe Sammlungen (clíentseitige Referenz) für Informationen zu den Sammlungsmethoden und Xrm.Page.ui-Steuerelement (clientseitige Referenz) für Informationen zu den Steuerobjekte in der Sammlung.

formSelector

Verwenden Sie die formSelector.getCurrentItem-Methode, um Informationen zum derzeit verwendeten Formular und die formSelector.items-Sammlung zu erhalten, die Informationen zu allen Formularen enthält, die für den Benutzer verfügbar sind.

Hinweis

Die Sammlung formSelectorunditems ist nicht vorhanden und die Methode formSelector.getCurrentItem wird für mobile Clients von Dynamics 365 (Telefone und Tablets) und den interaktiven Servicehub nicht unterstützt.

formSelector.getCurrentItem

Methode, um einen Verweis auf das Formular zurückzugeben, das zurzeit angezeigt wird.

Hinweis

Wenn nur ein Formular verfügbar ist, gibt diese Methode null zurück.

  • Rückgabewert
    Typ:Objekt

formSelector.items

Eine Sammlung von Formularelementen, die für den aktuellen Benutzer verfügbar sind.

Hinweis

Nur Formulare, die einer Verknüpfung mit einer der Sicherheitsrollen des Benutzers gemeinsam haben, sind in dieser Sammlung verfügbar.

Siehe Sammlungen (clíentseitige Referenz) für Informationen zu den Sammlungsmethoden und Xrm.Page.ui.formSelector-Element (clientseitige Referenz) für Informationen zu den Elementen in der Sammlung.

getCurrentControl

Methode, um das Steuerobjekts abzurufen, das im Formular den Fokus hat. Webressource- und IFRAME-Kontrollen werden durch diese Methode nicht zurückgegeben.

Hinweis

Diese Methode war in Updaterollup 2 für Microsoft Dynamics CRM 2013 veraltet.

Diese Methode gibt keinen Verweis auf das aktuelle Steuerelement zurück, wenn das letzte das Feld, das vom Benutzer bearbeitet wurde, ein boolesches Attribut war, das als Optionsfeld oder als Kontrollkästchen formatiert wurde. Diese Methode gibt ebenfalls keinen Verweis zurück sofort nach der Verwendung der Xrm.Page.ui Steuerlement setFocus-Methode.

Xrm.Page.ui.getCurrentControl()
  • Rückgabewert
    Typ:Objekt

getFormType

Methode, um den Formularkontexts für den Datensatztyp abzurufen.

Xrm.Page.ui.getFormType()

  • Rückgabewert
    Typ:Nummer

    In der folgende Tabelle sind die Formulartypen aufgeführt, die dem Rückgabewert entsprechen.

    Wert

    Formulartyp

    0

    Nicht definiert

    1

    Erstellen

    2

    Aktualisieren

    3

    Schreibgeschützt

    4

    Deaktiviert

    6

    Massenbearbeitung

    Hinweis

    Schnellerfassungsformulare geben „1” zurück. Der Wert 5 wurde für einen früheren Typ von Schnellerfassungsformularen verwendet, der entfernt wurde.

Eine Sammlung aller Navigationselemente auf der Seite.

Hinweis

Diese Sammlung ist in Microsoft Dynamics 365 für Tablets nicht vorhanden.

Siehe Sammlungen (clíentseitige Referenz) für Informationen zu den Sammlungsmethoden und Xrm.Page.ui.navigation-Element (clientseitige Referenz) für Informationen zu den Elementen in der Sammlung.

Formularbenachrichtigung

Verwenden Sie setFormNotification, um Benachrichtigungen auf Formularebene und clearFormNotification anzuzeigen, um Benachrichtigungen zu entfernen.

clearFormNotification

Verwenden Sie diese Methode, um Formularebenenbenachrichtigungen zu entfernen.

Xrm.Page.ui.clearFormNotification(uniqueId)

  • Parameter

    • uniqueId
      Typ: Zeichenfolge. Ein eindeutiger Bezeichner für die Nachrich, die mit setFormNotification verwendet wird, um die Benachrichtigung festzulegen.

  • Rückgabewert
    Typ: Boolesch. "True", wenn Methode erfolgreich war, andernfalls "false".

  • Anmerkungen
    Diese Methode ist nur für Aktualisierte Entitäten verfügbar.

setFormNotification

Verwenden Sie diese Methode, um Formularebenenbenachrichtigungen anzuzeigen. Sie können eine beliebige Anzahl von Benachrichtigungen anzeigen, und sie werden angezeigt, bis sie mithilfe von clearFormNotification entfernt werden. Die Höhe des Infobereichs ist beschränkt, daher wird jede neue Nachricht oben hinzugefügt. Benutzer können einen Bildlauf nach unten durchführen, um ältere Nachrichten anzuzeigen, die noch nicht entfernt wurden.

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

  • Parameter

    • message
      Typ: Zeichenfolge. Der Text der Nachricht.

    • level
      Typ: Zeichenfolge. Die Ebene der Nachricht.

      Die Ebene definiert, wie die Meldung angezeigt wird.

      • ERROR : Benachrichtigung verwendet das Systemfehlersymbol.

      • WARNING : Benachrichtigung verwendet das Warnsymbol.

      • INFO : Benachrichtigung verwendet das Infosymbol.

    • uniqueId
      Typ: Zeichenfolge. Ein eindeutiger Bezeichner für die Nachrich, die mit clearFormNotification verwendet wird, um die Benachrichtigung zu entfernen.

  • Rückgabewert
    Typ: Boolesch. "True", wenn Methode erfolgreich war, andernfalls "false".

  • Anmerkungen
    Diese Methode ist nur für Aktualisierte Entitäten verfügbar.

quickForms

Eine Sammlung aller Steuerelemente für die Schnellansicht in einem Formular mithilfe des neuen Formularrenderingmoduls (auch als "Turbo-Formulare" bezeichnet). Informationen zu den unterstützten Eigenschaften und Methoden für diese Sammlung und Objekte in dieser Sammlung finden Sie unter Xrm.Page.ui quickForms (clientseitige Referenz)

refreshRibbon

Methode, um das Menüband zu veranlassen, die Daten neu zu bewerten, die steuern, was darin angezeigt wird.

Xrm.Page.ui.refreshRibbon()

  • Rückgabewert
    Typ: Keiner

    Anmerkungen: Diese Funktion wird normalerweise verwendet, wenn ein Menüband <EnableRule> (RibbonDiffXml) von einem Wert im Formular abhängt. Nachdem der Code sich ändert, der von einer Regel verwendet wird, verwenden Sie diese Methode, um das Menüband zu zwingen, die Daten im Formular neu zu bewerten, damit die Regel angewendet werden kann.

Registerkarten

Eine Sammlung aller Registerkarten auf der Seite.

Siehe Sammlungen (clíentseitige Referenz) für Informationen zu den Sammlungsmethoden und Xrm.Page.ui.tab (clientseitige Referenz) für Informationen zu den Elementen in der Sammlung.

ViewPort-Methoden

ViewPort ist der Bereich der Seite, der die Formulardaten enthält. Es entspricht dem Text des Formulars und enthält nicht die Bereiche Navigation, Kopf- oder Fußzeile oder Formularassistent der Seite. Verwenden Sie die getViewPortHeight- und getViewPortWidth-Methode, um die aktuelle Größe von ViewPort abzurufen.

Hinweis

Diese Methoden funktionieren nicht mit Microsoft Dynamics 365 für Tablets.

getViewPortHeight

Methode, um die Höhe des Viewports in Pixeln abzurufen.

Xrm.Page.ui.getViewPortHeight()
  • Rückgabewert
    Typ:Nummer

getViewPortWidth

Methode, um die Breite des Viewports in Pixeln abzurufen.

Xrm.Page.ui.getViewPortWidth()
  • Rückgabewert
    Typ:Nummer

Siehe auch

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

Microsoft Dynamics 365

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright