Del via

Xrm.Page.ui (klientsidereference)

  • Artikel

 

Udgivet: januar 2017

Gælder for: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Xrm.Page.ui indeholder egenskaber og metoder til at hente oplysninger om brugergrænsefladen samt samlinger for flere underkomponenter i formularen.

Egenskaber og metoder for Xrm.Page.ui

  • Luk
    Metode til at lukke formularen.

  • kontrolelementer
    En samling af alle kontrolelementer på siden.

  • formSelector
    Brug metoden formSelector.getCurrentItem til at hente oplysninger om den formular, der bruges i øjeblikket, og den formSelector.items-samling, der indeholder oplysninger om alle de formularer, der er tilgængelige for brugeren.

  • getCurrentControl
    Metode til at få det kontrolelementobjekt, der i øjeblikket har fokus på formularen.

    Bemærk

    Denne metode blev afviklet i Opdateringspakke 2 til Microsoft Dynamics CRM 2013.

  • getFormType
    Metode til at få formularkonteksten for posten.

  • navigation.items
    En samling af alle navigationselementer på siden.

  • Formularmeddelelse
    Brug setFormNotification til at vise meddelelser på formularniveau og clearFormNotification til at fjerne meddelelser.

  • quickForms
    En samling af alle kontrolelementer til hurtig visning på siden.

  • refreshRibbon
    Metode til at få båndet til at reevaluere data, der styrer, hvad der vises i det.

  • faner
    En samling af alle fanerne på siden.

  • ViewPort-metoder
    ViewPort er området af siden, der indeholder formulardata. Det svarer til brødteksten i formularen og omfatter ikke områderne for navigation, sidehoved, sidefod eller formularassistenten på siden. Brug metoderne getViewPortHeight og getViewPortWidth til at få den aktuelle størrelse på ViewPort.

Luk

Metode til at lukke formularen.

Xrm.Page.ui.close()

Bemærkninger:

HTML Window.close-metoden undertrykkes. Hvis du vil lukke et formularvindue, skal du bruge denne metode. Hvis der er ændringer i formularen, som ikke er gemt, bliver brugeren spurgt, om ændringerne skal gemmes, før vinduet lukkes.

Med Microsoft Dynamics 365 til tablets efterligner denne metode funktionsmåden for knapperne til baglæns navigering.

kontrolelementer

En samling af alle kontrolelementer på siden.

Se Grupper (klientsidereference) for at få oplysninger om metoderne til indsamling, og Kontrolelementet Xrm.Page.ui (klientsidereference) for at få oplysninger om kontrolobjekterne i samlingen.

formSelector

Brug metoden formSelector.getCurrentItem til at hente oplysninger om den formular, der bruges i øjeblikket, og den formSelector.items-samling, der indeholder oplysninger om alle de formularer, der er tilgængelige for brugeren.

Bemærk

formSelectoritems-samlingen findes ikke, og formSelector.getCurrentItem-metode understøttes ikke for Dynamics 365-mobilklienter (telefoner og tablets) den og interaktive tjenestehub.

formSelector.getCurrentItem

Metode til at returnere en reference til den formular, der vises i øjeblikket.

Bemærk

Når kun én formular er tilgængelig, returnerer denne metode null.

  • Returværdi
    Type:Objekt

formSelector.items

En samling af alle de formularelementer, der er tilgængelige for den aktuelle bruger.

Bemærk

Kun formularer, som deler en tilknytning med en af brugerens tilknytningsroller, er tilgængelige i denne samling.

Se Grupper (klientsidereference) for at få oplysninger om metoderne til indsamling, og Xrm.Page.ui.formSelector-element (klientsidereference) for at få oplysninger om elementerne i samlingen.

getCurrentControl

Metode til at få det kontrolelementobjekt, der i øjeblikket har fokus på formularen. Webressource- og IFRAME-kontrolelementer returneres ikke af denne metode.

Bemærk

Denne metode blev afviklet i Opdateringspakke 2 til Microsoft Dynamics CRM 2013.

Denne metode returnerer ikke en reference til det aktuelle objekt, hvis det sidste felt, brugeren redigerede, var en boolesk attribut, der er formateret som en alternativknap eller et afkrydsningsfelt. Denne metode returnerer heller ikke en reference med det samme efter brug af Xrm.Page.ui-kontrolelementets metode setFocus.

Xrm.Page.ui.getCurrentControl()
  • Returværdi
    Type:Objekt

getFormType

Metode til at få formularkonteksten for posten.

Xrm.Page.ui.getFormType()

  • Returværdi
    Type:Nummer

    I følgende tabel vises de formulartyper, der svarer til den returnerede værdi.

    Værdi

    Formulartype

    0

    Udefineret

    1

    Opret

    2

    Opdatering

    3

    Skrivebeskyttet

    4

    Deaktiveret

    6

    Masseredigering

    Bemærk

    Formulerer til hurtig oprettelse returnerer 1. Værdien 5 blev brugt til en tidligere type formular til hurtig oprettelse, der blev fjernet.

En samling af alle navigationselementer på siden.

Bemærk

Denne samling findes ikke med Microsoft Dynamics 365 til tablets.

Se Grupper (klientsidereference) for at få oplysninger om metoderne til indsamling, og Xrm.Page.ui.navigation-element (klientsidereference) for at få oplysninger om elementerne i samlingen.

Formularmeddelelse

Brug setFormNotification til at vise meddelelser på formularniveau og clearFormNotification til at fjerne meddelelser.

clearFormNotification

Brug denne metode for at fjerne meddelelser for formularniveau.

Xrm.Page.ui.clearFormNotification(uniqueId)

  • Parametre

    • uniqueId
      Type: Streng. Et entydigt id for den meddelelse, der bruges sammen med setFormNotification til at angive meddelelsen.

  • Returværdi
    Type: Boolesk. Sand, hvis metoden lykkedes, ellers falsk.

  • Bemærkninger
    Denne metode er kun tilgængelig for Opdaterede objekter.

setFormNotification

Brug denne metode for at vise meddelelser for formularniveau. Du kan vise et vilkårligt antal meddelelser, og de vil blive vist, indtil de fjernes ved hjælp af clearFormNotification. Højden af meddelelsesområdet er begrænset, så hver ny meddelelse vil blive føjet til toppen. Brugerne kan rulle ned for at få vist ældre meddelelser, der endnu ikke er fjernet.

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

  • Parametre

    • message
      Type: Streng. Teksten i meddelelsen.

    • level
      Type: Streng. Niveau for meddelelsen.

      Niveauet definerer, hvordan meddelelsen vises.

      • ERROR: Meddelelse anvender ikonet for systemfejl.

      • WARNING: Meddelelse anvender ikonet for advarselsikon.

      • INFO: Meddelelse bruger oplysningsikonet.

    • uniqueId
      Type: Streng. Et entydigt id for den meddelelse, der bruges sammen med clearFormNotification til at fjerne meddelelsen.

  • Returværdi
    Type: Boolesk. Sand, hvis metoden lykkedes, ellers falsk.

  • Bemærkninger
    Denne metode er kun tilgængelig for Opdaterede objekter.

quickForms

En samling af alle kontrolelementer til hurtiv visning i en formular, der bruger den nye funktion til gengivelse af formularer (også kaldet "turboformularer"). Se Xrm.Page.ui quickForms (klientsidereference) for at få oplysninger om de understøttede metoder og egenskaber for denne samling og objekterne i samlingen.

refreshRibbon

Metode til at få båndet til at reevaluere data, der styrer, hvad der vises i det.

Xrm.Page.ui.refreshRibbon()

  • Returværdi
    Type: Ingen

    Bemærkninger: Denne funktion anvendes typisk, når en <EnableRule> (RibbonDiffXml) på båndet afhænger af en værdi i formularen. Når koden ændrer en værdi, der bruges af en regel, kan du bruge denne metode til at tvinge båndet til at evaluere data i formularen, så reglen kan anvendes.

faner

En samling af alle fanerne på siden.

Se Grupper (klientsidereference) for at få oplysninger om metoderne til indsamling, og Xrm.Page.ui-fane (klientsidereference) for at få oplysninger om elementerne i samlingen.

ViewPort-metoder

ViewPort er området af siden, der indeholder formulardata. Det svarer til brødteksten i formularen og omfatter ikke områderne for navigation, sidehoved, sidefod eller formularassistenten på siden. Brug metoderne getViewPortHeight og getViewPortWidth til at få den aktuelle størrelse på ViewPort.

Bemærk

Disse metoder fungerer ikke sammen med Microsoft Dynamics 365 til tablets.

getViewPortHeight

Metode til at få visningsportens højde i pixel.

Xrm.Page.ui.getViewPortHeight()
  • Returværdi
    Type:Nummer

getViewPortWidth

Metode til at få visningsportens bredde i pixel.

Xrm.Page.ui.getViewPortWidth()
  • Returværdi
    Type:Nummer

Se også

Programmeringsreference på klientsiden
Formularscripter - hurtig henvisning
Skriv kode til Microsoft Dynamics 365-formularer
Bruge Xrm.Page-objektmodel
Xrm.Page.data.entity (klientsidereference)

Microsoft Dynamics 365

© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret