Bruge Xrm.Page-objektmodel
Udgivet: januar 2017
Gælder for: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Når du skriver formularscripts, kan du interagere med objekter i navneområdet Xrm.Page til at udføre følgende handlinger:
Hente eller angive værdier for attributten.
Vise og skjule elementer i brugergrænsefladen.
Referere til flere kontrolelementer pr. attribut.
Få adgang til flere formularer pr. objekt.
Manipulere formularnavigationselementer.
Arbejde med styring af forretningsprocesforløbet.
Du kan finde flere eksempler under Formularscripter - hurtig henvisning
Dette emne indeholder
Xrm.Page-objekthierarki
Kontekst for udførelse
Samlinger
Objektbeskrivelser
attribut
kontekst
kontrolelement
objekt
formSelector
navigation
proces
Sektion
fase
Trin
fane
Xrm.Page-objekthierarki
Som vist i følgende diagram giver Xrm.Page en navneområde-beholder til tre objekter, der er beskrevet i følgende tabel:
Objekt |
Beskrivelse |
|---|---|
context |
Indeholder metoder til at hente oplysninger, der er specifikke for en organisation, en bruger eller parametre, der blev sendt til formularen i en forespørgselsstreng. |
data |
Giver adgang til objektdataene og -metoderne til håndtering af data i formularen samt i styringen af forretningsprocesforløbet |
ui |
Indeholder metoder til at hente oplysninger om brugergrænsefladen, ud over samlinger for flere underkomponenter i formularen. |
.jpeg "Xrm.Page-objektmodel")
Kontekst for udførelse
Du har mulighed for at overføre et objekt til udførelse af kontekst som den første parameter til funktionen, når du registrerer en funktion til en hændelseshandler. Dette objekt indeholder metoder, der gør det muligt at administrere variabler, du vil dele med andre hændelseshandlere, og gemme hændelsen. Du kan finde flere oplysninger i Kontekst for udførelse (klientsidereference) og Gemme hændelsesargumenter (klientsidereference).
Samlinger
I følgende tabel beskrives Xrm.Page-objektmodelsamlingerne. Se Grupper (klientsidereference) for at få oplysninger om de tilgængelige metoder for samlinger.
Afhentning |
Beskrivelse |
|---|---|
attributes |
Samlingen Xrm.Page.data.entity.attributes giver adgang til hver objektattribut, der er tilgængelig i formularen. Der findes kun de attributter, der svarer til felter, der er føjet til formularen. |
controls |
Tre objekter indeholder en samling af kontrolelementer:
|
navigation.items |
Samlingen Xrm.Page.ui.navigation.items giver adgang til navigationselementer, der er defineret ved hjælp af navigationsområdet i formulareditoren. Med TechNet: Opdaterede formularer navigerer folk til disse ved hjælp af kommandolinjen. I TechNet: Klassiske formularer findes disse på venstre side af formularen. |
formSelector.items |
Når der findes flere formularer for et objekt, kan du knytte hver formular til sikkerhedsroller. Når de sikkerhedsroller, der er knyttet til en bruger, giver dem mulighed for at se mere end én formular, giver samlingen Xrm.Page.ui.formSelector.items adgang til hver formulardefinition, der er tilgængelig for denne bruger. |
tabs |
Du kan organisere hver formular ved hjælp af en eller flere faner. Samlingen Xrm.Page.ui.tabs giver adgang til hver af disse faner. |
sections |
Du kan organisere hver formularfane ved hjælp af et eller flere afsnit. Fanesamlingen sections giver adgang til hver af disse sektioner. |
Samlinger af forretningsprocesforløb
Samlinger til faser og trin i Xrm.Page.data.process er baseret på den samme samlingsstruktur, men kan også bruges til at tilføje eller fjerne elementer fra samlinger.
Brug proces.getStages-metoden til at få adgang til samlingen af faser. Brug fase.getSteps-metoden til at få adgang til samlingen af trin.
Objektbeskrivelser
Hvert objekt har flere metoder til at hente data, hente eller angive objektegenskaber eller udføre handlinger:
attribut
Hver attribut svarer til en objektattribut, der er blevet føjet til formularen som et felt. Generelt er kun de objektattributter, der er føjet til formularen som et felt, tilgængelige. Hver forekomst af et felt er et kontrolelement. Et felt kan føjes til en formular mere end én gang, hvilket skaber flere kontrolelementer, der refererer til den samme attribut.
Bemærk
Sammensatte attributter har særlige funktioner.Flere oplysninger:Skrive scripts for sammensatte attributter
Attributter er kategoriseret efter type. Du kan bestemme typen af en attribut ved hjælp af metoden getAttributeType.
Alle attributter deler nogle almindelige metoder, men visse metoder er kun tilgængelig for specifikke attributtyper. Du kan finde flere oplysninger under Attributten Xrm.Page.data.entity (klientsidereference).
Bemærk
Attributtypeoplysninger repræsenterer funktionsmåden for attributten i formularen. Det svarer ikke nødvendigvis til felttypen, der er defineret i programmet eller AttributeMetadata-typerne. Attributter for en bestemt felttype kan fungere anderledes, alt efter hvordan de er formateret.
I følgende tabel vises attributtypens strengværdier, der kan forventes, for hver type af attributskematype og formateringsindstilling.
Programfelttype |
Formateringsindstilling |
Attributtype |
|---|---|---|
Valuta |
I/T |
money |
Dato og klokkeslæt |
Dato og klokkeslæt, Kun dato. |
datetime |
Decimaltal |
I/T |
decimal |
Flydende tal |
I/T |
double |
Opslag |
I/T |
lookup |
Flere linjers tekst |
I/T |
memo |
Grupperet indstilling |
I/T |
optionset |
Enkelt tekstlinje |
E-mail, tekst, Ticker Symbol, URL-adresse, telefon |
string |
Enkelt tekstlinje |
Tekstområde |
memo |
Status |
I/T |
optionset |
Statusårsag |
I/T |
optionset |
To indstillinger |
To alternativknapper, afkrydsningsfelt, liste |
boolean |
Heltal |
Ingen, varighed |
integer |
Heltal |
Sprog, Tidszone |
optionset |
kontekst
Xrm.Page.context indeholder metoder til at hente oplysninger, der er specifikke for en organisation, en bruger eller parametre, der blev sendt til formularen i en forespørgselsstreng. Du kan finde flere oplysninger under Klientsidekontekst (klientsidereference).
kontrolelement
Repræsenterer et HTML-element, der findes i formularen. Nogle kontrolelementer er bundet til en bestemt attribut, mens andre kan repræsentere ubundne kontrolelementer som en IFRAME, webressource eller et undergitter, der er blevet føjet til formularen.
Brug navne på bestemte kontrolelementer i programkoden til IFrame, webressource og kontrolelementer i et undergitter. Disse kontrolelementer er ikke bundet til en attribut. Undgå også navne på bestemte kontrolelementer i koden, når kontrolelementet er bundet til en attribut. Når flere kontrolelementer er bundet til en attribut, bestemmes navnene på kontrolelementerne under kørslen og kan variere, afhængigt af hvor objektet er placeret i formularen.
For de fleste opgaver, der er relateret til attributbundne kontrolelementer, får du adgang til kontrolelementer ved hjælp af samlingen af attributkontrolelementer eller gennem samlingen af kontrolelementer i et afsnit. I stedet for at referere til et kontrolelement med navnet får du en henvisning til det baseret på konteksten i samlingen. I dette tilfælde er navnet ikke vigtigt. Se eksemplet, der er fundet for attributten kontrolelementer, efter en måde at oprette funktioner på for at udføre handlinger på tværs af alle de kontrolelementer, der er bundet til en bestemt attribut.
Bemærk
Sammensatte attributter har særlige funktioner.Flere oplysninger:Skrive scripts for sammensatte attributter.
Bemærk
For det meste scriptudviklingsarbejde uden for Microsoft Dynamics 365 kan udviklere være vant til at referere til sideelementer ved hjælp af metoden document.getElementById. For Microsoft Dynamics 365-formularscripts understøttes denne metode ikke. Det er vigtigt at vide, at attributten gemmer data, og kontrolelementet er blot præsentationen af attributten i formularen. I forbindelse med kontrolelementer, der er bundet til attributter, skal du muligvis justere den måde, du vant til at få adgang til data på i formularen.
Kontrolelementer er kategoriseret efter type. Du kan bestemme typen af et kontrolelement ved hjælp af metoden 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType. Bestemte kontrolelementmetoder er kun tilgængelige for bestemte typer af kontrolelementer. Metoden 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_addOption er f.eks. kun tilgængelig for kontrolelementer, der præsenteres som grupperede indstillinger. Du kan finde flere oplysninger under Kontrolelementet Xrm.Page.ui (klientsidereference).
objekt
Xrm.Page.data.entity indeholder metoder til at hente specifikke oplysninger om den post, der vises på siden, metoden save og en samling af alle de attributter, der er medtaget i formularen. Du kan finde flere oplysninger under Xrm.Page.data.entity (klientsidereference).
formSelector
Xrm.Page.ui.formSelector indeholder en samling af elementer, der indeholder funktioner til at forespørge på de formularer, der er tilgængelige for den aktuelle bruger. Brug metoden bcf42b09-b672-4f4b-b866-ea7b24cc3ae0#BKMK_navigate til at lukke den aktuelle formular og åbne en anden. Du kan finde flere oplysninger under Xrm.Page.ui.formSelector-element (klientsidereference).
navigation
Indeholder ingen metoder. Giver adgang til navigationselementer gennem samlingen af elementer.
proces
Indeholder metoder til at hente egenskaberne for en forretningsproces.Flere oplysninger:Procesmetoder
Sektion
En sektion indeholder metoder til at styre, hvordan det ser ud udover at få adgang til den fane, der indeholder sektionen. En sektion giver også adgang til objekter i den via en samling af objekter.Flere oplysninger:Sektionen Xrm.Page.ui (klientsidereference)
fase
Hver proces har en samling af faser, som du kan få adgang til ved hjælp af getStages-procesmetoden.
Én fase er den aktive fase.Flere oplysninger:Strukturen af forretningsprocesforløb
Trin
Trin repræsenterer individuelle elementer af data, der skal indsamles under en fase. Hver fase har en samling af trin, som du kan få adgang til ved hjælp af getSteps-trinmetoden.Flere oplysninger:Strukturen af forretningsprocesforløb
Du kan få adgang til et trinkontrolelement i den aktive fase for styringen af forretningsprocesforløbet ved at referere til navnet på kontrolelementet med det særlige præfiks "header_process_<kontrolelementnavn>". Hvis du f.eks. vil skjule de trin, der repræsenterer attributten purchaseprocess, skal du bruge følgende:
Xrm.Page.getControl("header_process_purchaseprocess").setVisible(false);
fane
En fane er en gruppe af sektioner på en side. Den indeholder metoder til at ændre præsentationen på fanen. Du skal have adgang til sektioner i fanen gennem samlingen af sektioner. Du kan finde flere oplysninger under Xrm.Page.ui-fane (klientsidereference).
Se også
Formularscripter - hurtig henvisning
Skrive eller rette fejl i scripts til Dynamics 365 til telefoner og tablets
Skriv kode til Microsoft Dynamics 365-formularer
Skrive scripts for sammensatte attributter
Skrive scripts til forretningsprocesforløb
Bruge JavaScript med Microsoft Dynamics 365
Programmeringsreference på klientsiden
Programmeringsreference på klientsiden
JavaScript-biblioteker til Microsoft Dynamics 365
Tilpasning af objektformularer
Microsoft Dynamics 365
© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret