Delen via

Xrm.Page.ui (clientreferentie)

  • Artikel

 

Gepubliceerd: november 2016

Is van toepassing op: Dynamics CRM 2015

Xrm.Page.ui bevat eigenschappen en methoden om informatie over de gebruikersinterface op te halen, alsmede verzamelingen voor verschillende subonderdelen van het formulier.

Eigenschappen en methoden van Xrm.Page.ui

  • Sluiten
    Methode om het formulier te sluiten.

  • besturingselementen
    Een verzameling van alle besturingselementen op de pagina.

  • formSelector
    Gebruik de methode formSelector.getCurrentItem om informatie op te halen over het formulier dat momenteel wordt gebruikt en over de formSelector.items-verzameling die informatie bevat over alle formulieren die beschikbaar zijn voor de gebruiker.

  • getCurrentControl
    Methode voor het ophalen van het besturingselementobject dat momenteel op het formulier de focus heeft.

    Notitie

    Deze methode is afgeschaft in Updatepakket 2 voor Microsoft Dynamics CRM 2013.

  • getFormType
    Methode om de formuliercontext voor de record op te halen.

  • navigation.items
    Een verzameling van alle navigatie-items op de pagina.

  • Formuliermelding
    Gebruik setFormNotification om niveaumeldingen voor het formulier weer te geven en clearFormNotification om meldingen te verwijderen.

  • refreshRibbon
    Methode om het lint gegevens opnieuw te laten evalueren die bepalen wat wordt weergegeven.

  • tabbladen
    Een verzameling van alle tabbladen op de pagina.

  • Viewportmethoden
    De ViewPort is het gebied van de pagina die formuliergegevens bevat. Het komt overeen met de tekst van het formulier en omvat niet de navigatie, kop- of voettekst, formulierhulpgebieden van de pagina. Gebruik methoden de getViewPortHeight en getViewPortWidth om de grootte van de ViewPort op te halen.

Sluiten

Methode om het formulier te sluiten.

Xrm.Page.ui.close()

Opmerkingen:

De HTML-methode Window.close wordt onderdrukt. Als u een formuliervenster wilt sluiten, moet u deze methode gebruiken. Als er wijzigingen in het formulier zijn die niet zijn opgeslagen, wordt de gebruiker gevraagd of deze de wijzigingen wil opslaan alvorens het venster te sluiten.

Met Microsoft Dynamics CRM voor tablets bootst deze methode het gedrag van de navigatieknop Terug na.

besturingselementen

Een verzameling van alle besturingselementen op de pagina.

Zie Verzamelingen (clientreferentie) voor informatie over de verzamelingmethoden en Xrm.Page.ui control (referentie aan de clientzijde) voor informatie over de besturingselementobjecten in de verzameling.

formSelector

Gebruik de methode formSelector.getCurrentItem om informatie op te halen over het formulier dat momenteel wordt gebruikt en over de formSelector.items-verzameling die informatie bevat over alle formulieren die beschikbaar zijn voor de gebruiker.

Notitie

De verzameling formSelectoritems bestaat niet en de methode formSelector.getCurrentItem werkt niet met Microsoft Dynamics CRM voor tablets.

formSelector.getCurrentItem

Methode om een verwijzing te retourneren naar het formulier dat momenteel wordt weergegeven.

Notitie

Wanneer slechts één formulier beschikbaar is, retourneert deze methode null.

  • Retourwaarde
    Type:Object

formSelector.items

Een verzameling van alle formulieritems die toegankelijk zijn voor de huidige gebruiker.

Notitie

Alleen formulieren die een koppeling met een van de beveiligingsrollen van de gebruiker delen zijn beschikbaar in deze verzameling.

Zie Verzamelingen (clientreferentie) voor informatie over de verzamelingmethoden en Xrm.Page.ui.formSelector-item (clientreferentie) voor informatie over de items in de verzameling.

getCurrentControl

Methode voor het ophalen van het besturingselementobject dat momenteel op het formulier de focus heeft. Webresource- en IFRAME-besturingselementen worden niet geretourneerd met deze methode.

Notitie

Deze methode is afgeschaft in Updatepakket 2 voor Microsoft Dynamics CRM 2013.

Deze methode retourneert geen verwijzing naar het huidige besturingselement als het als laatste door de gebruiker bewerkte veld een Boole-kenmerk was dat als keuzerondje of selectievakje is opgemaakt. Deze methode retourneert ook geen verwijzing direct na het gebruik van het besturingselement Xrm.Page.ui van de methode setFocus.

Xrm.Page.ui.getCurrentControl()
  • Retourwaarde
    Type:Object

getFormType

Methode om de formuliercontext voor de record op te halen.

Xrm.Page.ui.getFormType()

  • Retourwaarde
    Type:Getal

    De onderstaande tabel toont de formuliertypen die overeenkomen met de retourwaarde.

    Waarde

    Formuliertype

    0

    Ongedefinieerd

    1

    Maken

    2

    Bijwerken

    3

    Alleen lezen

    4

    Uitgeschakeld

    5

    Snel maken (afgeschaft)

    6

    Bulkbewerking

    11

    Voor lezen geoptimaliseerd (afgeschaft)

    Notitie

    Formulieren voor snelle invoer retourneren 1. De waarde 5 werd gebruikt voor een ouder type formulier voor snelle invoer dat is verwijderd.

Een verzameling van alle navigatie-items op de pagina.

Notitie

Deze verzameling bestaat niet in Microsoft Dynamics CRM voor tablets.

Zie Verzamelingen (clientreferentie) voor informatie over de verzamelingmethoden en Xrm.Page.ui.navigation-item (clientreferentie) voor informatie over de items in de verzameling.

Formuliermelding

Gebruik setFormNotification om niveaumeldingen voor het formulier weer te geven en clearFormNotification om meldingen te verwijderen.

clearFormNotification

Gebruik deze methode om waarschuwingen op het niveau van het formulier te verwijderen.

Xrm.Page.ui.clearFormNotification(uniqueId)

  • Parameters

    • uniqueId
      Type:: Tekenreeks. Een unieke id voor het bericht dat wordt gebruikt met setFormNotification om de melding in te stellen.

  • Retourwaarde
    Type:: Boole-waarde. Waar als de methode is geslaagd, anders onwaar.

  • Opmerkingen
    Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

setFormNotification

Gebruik deze methode om waarschuwingen op het niveau van het formulier te weer te geven. U kunt een willekeurig aantal meldingen weergeven die worden weergegeven totdat ze worden verwijderd via clearFormNotification. De hoogte van het meldingsgebied is beperkt, dus elk nieuwe bericht wordt bovenaan toegevoegd. Gebruikers kunnen omlaag schuiven om oudere berichten te bekijken die nog niet zijn verwijderd.

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

  • Parameters

    • message
      Type:: Tekenreeks. De tekst van het bericht.

    • level
      Type:: Tekenreeks. Het niveau van het bericht.

      Het niveau bepaalt hoe het bericht wordt weergegeven.

      • ERROR : Melding gebruikt het foutpictogram van het systeem.

      • WARNING : Melding gebruikt het waarschuwingspictogram van het systeem.

      • INFO : Melding gebruikt het informatiepictogram van het systeem.

    • uniqueId
      Type:: Tekenreeks. Een unieke id voor het bericht dat wordt gebruikt met clearFormNotification om de melding te verwijderen.

  • Retourwaarde
    Type:: Boole-waarde. Waar als de methode is geslaagd, anders onwaar.

  • Opmerkingen
    Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

refreshRibbon

Methode om het lint gegevens opnieuw te laten evalueren die bepalen wat wordt weergegeven.

Xrm.Page.ui.refreshRibbon()

  • Retourwaarde
    Type: Geen

    Opmerkingen: Deze functie wordt meestal gebruikt wanneer een lint <EnableRule> (RibbonDiffXml) afhankelijk is van een waarde in het formulier. Nadat uw code een waarde heeft gewijzigd die wordt gebruikt door een regel, kunt u deze methode gebruiken om het lint te dwingen om de gegevens in het formulier opnieuw te beoordelen zodat de regel kan worden toegepast.

tabbladen

Een verzameling van alle tabbladen op de pagina.

Zie Verzamelingen (clientreferentie) voor informatie over de verzamelingmethoden en Tabblad Xrm.Page.ui (clientreferentie) voor informatie over de items in de verzameling.

Viewportmethoden

De ViewPort is het gebied van de pagina die formuliergegevens bevat. Het komt overeen met de tekst van het formulier en omvat niet de navigatie, kop- of voettekst, formulierhulpgebieden van de pagina. Gebruik methoden de getViewPortHeight en getViewPortWidth om de grootte van de ViewPort op te halen.

Notitie

Deze methoden werken niet met Microsoft Dynamics CRM voor tablets.

getViewPortHeight

Methode om de hoogte van de viewport in pixels op te halen.

Xrm.Page.ui.getViewPortHeight()
  • Retourwaarde
    Type:Getal

getViewPortWidth

Methode om de breedte van de viewport in pixels op te halen.

Xrm.Page.ui.getViewPortWidth()
  • Retourwaarde
    Type:Getal

Zie ook

Programmeerreferentie op de client
Beknopte naslag voor het opstellen van formulierscripts
Code schrijven voor Microsoft Dynamics CRM 2015-formulieren
Het objectmodel Xrm.Page gebruiken
Xrm.Page.data.entity (clientreferentie)

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht