Het objectmodel Xrm.Page gebruiken
Gepubliceerd: november 2016
Is van toepassing op: Dynamics CRM 2015
Als u formulierscripts schrijft, werkt u met objecten in de Xrm.Page-naamruimte om de volgende stappen uit te voeren:
Kenmerkwaarden instellen of ophalen.
Weergeven en verbergen van gebruikersinterface-elementen.
Meerdere besturingselementen per kenmerk raadplegen.
Toegang tot meerdere formulieren per entiteit.
Formuliernavigatie-items manipuleren.
Interactie onderhouden met de bedrijfsprocesstroombesturing.
Voor meer voorbeelden, zie Beknopte naslag voor het opstellen van formulierscripts.
In dit onderwerp
Xrm.Page object-hiërarchie
Uitvoeringscontext
Collections
Objectbeschrijvingen
kenmerk
context
Besturingselement
entiteit
formSelector
navigatie
proces
Sectie
fase
stap
tabblad
Xrm.Page object-hiërarchie
Zoals weergegeven in het volgende diagram, biedt Xrm.Page een naamruimtecontainer voor drie objecten die in de volgende tabel worden beschreven:
Object |
Beschrijving |
|---|---|
context |
Methoden om informatie op te halen specifiek voor een organisatie, een gebruiker, of parameters die zijn doorgestuurd naar het formulier in een querytekenreeks. |
data |
Biedt toegang tot de entiteitgegevens en methoden voor het beheren van de gegevens in het formulier alsmede in de bedrijfsprocesstroombesturing |
ui |
Bevat methoden om informatie over de gebruikersinterface op te halen, naast verzamelingen voor verschillende subonderdelen van het formulier. |
.jpeg "Xrm.Page-objectmodel")
Uitvoeringscontext
Wanneer u voor een gebeurtenismanager een functie registreert, kunt u een object van de uitvoeringscontext als eerste parameter invoeren voor de functie. Dit object bevat methoden die u in staat stellen om variabelen te beheren die u wilt delen met andere gebeurtenishandlers en het evenement opslaan. Zie voor meer informatie Uitvoeringscontext (clientreferentie) en Argumenten van gebeurtenis Opslaan (clientreferentie).
Collections
De volgende tabel beschrijft de Xrm.Page objectmodelverzamelingen. Zie Verzamelingen (clientreferentie) voor informatie over de methoden die beschikbaar zijn voor verzamelingen.
Afhalen |
Beschrijving |
|---|---|
attributes |
De Xrm.Page.data.entity.attributes verzameling biedt toegang tot elk entiteitkenmerk die op het formulier beschikbaar is. Alleen de kenmerken die op velden die in het formulier worden toegevoegd zijn beschikbaar. |
controls |
Drie objecten bevatten een besturingselementenverzameling:
|
navigation.items |
De Xrm.Page.ui.navigation.items verzameling biedt toegang tot navigatie-items die met het navigatiegebied van de formuliereneditor zijn gedefinieerd. Met TechNet: Bijgewerkte formulieren navigeren mensen hiernaar met de opdrachtbalk. In TechNet: Klassieke formulieren bevinden deze zich aan de linkerzijde van het formulier. |
formSelector.items |
Als er meerdere formulieren voor een entiteit zijn geleverd, kunt u elk formulier met beveiligingsrollen koppelen. Als de beveiligingsrollen die zijn gekoppeld aan een gebruiker ze in staat stellen om meer dan een formulier te zien, biedt de Xrm.Page.ui.formSelector.items verzameling toegang tot iedere formulierdefinitie die beschikbaar is voor die gebruiker. |
tabs |
U kunt elk formulier organiseren door een of meer tabbladen te gebruiken. De Xrm.Page.ui.tabs verzameling biedt toegang tot elk van deze tabbladen. |
sections |
U kunt elk formuliertabblad organiseren door een of meer secties te gebruiken. Het tabblad sections verzameling biedt toegang tot elk van deze secties. |
Bedrijfsprocesstroomverzameling
Verzamelingen voor fasen en stappen binnen Xrm.Page.data.process zijn gebaseerd op dezelfde verzamelingstructuur maar maken ook het toevoegen of verwijderen van items uit de verzamelingen mogelijk.
Gebruik de methode proces.getStages om toegang te verkrijgen tot de verzameling van fasen. Gebruik de methode fase.getSteps om toegang te verkrijgen tot de verzameling van stappen.
Objectbeschrijvingen
Elk object bevat diverse methoden om gegevens op te halen, objecteigenschappen toe te voegen of in te stellen, of acties uit te voeren:
kenmerk
Elk kenmerk komt overeen met een entiteitkenmerk dat als een veld aan het formulier is toegevoegd. Meestal zijn alleen die kenmerken beschikbaar die als een veld aan het formulier zijn toegevoegd. Elk exemplaar van een veld is een besturingselement. Een veld kan meer dan één keer aan een formulier worden toegevoegd, waardoor meerdere besturingselementen worden gemaakt die naar hetzelfde kenmerk verwijzen.
Notitie
Samengestelde kenmerken hebben speciale gedragingen.Meer informatie:Scripts schrijven voor samengestelde kenmerken
Kenmerken worden ingedeeld op type. U kunt het type van een kenmerk definiëren door de getAttributeType of andere methode te gebruiken.
Hoewel alle kenmerken enkele gemeenschappelijke methoden delen, zijn bepaalde methoden alleen beschikbaar voor specifieke kenmerktypen. Zie Xrm.Page.data.entity attribute (clientreferentie) voor meer informatie.
Notitie
Kenmerktype-informatie is het gedrag van het kenmerk in het formulier. Dit komt niet noodzakelijk overeen met het veldtype dat is opgegeven in de toepassing of de AttributeMetadata types. Kenmerken van een bepaald veldtype kunnen zich verschillend gedragen op basis van hoe ze zijn geformatteerd.
De onderstaande tabel toont de kenmerktekenreekswaarden die voor elk type kenmerkschema en indelingoptie zijn te verwachten.
Type applicatieveld |
Indelingsoptie |
Type kenmerk |
|---|---|---|
Valuta |
NA |
money |
Datum en tijd |
Datum en tijd, alleen datum |
datetime |
Decimaal getal |
NA |
decimal |
Drijvendekommagetal |
NA |
double |
Opzoeken |
NA |
lookup |
Meerdere tekstregels |
NA |
memo |
Optieset |
NA |
optionset |
Eén tekstregel |
E-mail, tekst, Beurssymbool, URL, Telefoon |
string |
Eén tekstregel |
Tekstgebied |
memo |
Status |
NA |
optionset |
Reden van status |
NA |
optionset |
Twee opties |
Twee Keuzerondjes, Selectievakje, Lijst |
boolean |
Geheel getal |
Geen, Duur |
integer |
Geheel getal |
Taal, tijdzone |
optionset |
context
Xrm.Page.context biedt methoden om informatie op te halen specifiek voor een organisatie, een gebruiker, of parameters die zijn doorgestuurd naar het formulier in een querytekenreeks. Zie Clientcontext (clientreferentie) voor meer informatie.
Besturingselement
Vertegenwoordigt een HTML-element op het formulier. Sommige besturingselementen zijn gekoppeld aan een specifiek kenmerk, terwijl anderen ongebonden besturingselementen zijn zoals een IFRAME, Webresource of een subraster dat is toegevoegd aan het formulier.
Gebruik specifieke namen voor de besturingselementen in uw code voor IFRAME, Webresource en subrasterbesturingselementen. Deze besturingselementen zijn niet gekoppeld aan een kenmerk. Vermijd het toevoegen van specifieke besturingselementnamen in de code wanneer het besturingselement aan een kenmerk is gekoppeld. Als er meerdere besturingselementen aan een kenmerk zijn gekoppeld, worden de besturingselementnamen bepaald tijdens uitvoeringstijd en kunnen ze verschillen afhankelijk van waar het besturingselement in het formulier is te vinden.
Voor de meeste taken met betrekking tot kenmerkafhankelijke besturingselementen, kunt u de besturingselementen van de verzameling kenmerkbesturingselementen gebruiken of de besturingselementenverzameling van een sectie gebruiken. In plaats van naar een besturingselement te verwijzen op basis van de naam, moet u ernaar verwijzen op basis van de context van de verzameling. In dit geval, maakt de naam niet uit. Zie het voorbeeld voor het kenmerk besturingselementen voor een manier om functies te maken om acties uit te voeren voor alle besturingselementen die aan een specifiek kenmerk zijn gekoppeld.
Notitie
Samengestelde kenmerken hebben speciale gedragingen.Meer informatie:Scripts schrijven voor samengestelde kenmerken.
Notitie
Voor het meeste scriptontwikkelwerk buiten Microsoft Dynamics 365, kunnen ontwikkelaars gewend zijn aan het verwijzen naar pagina-elementen met de methode document.getElementById. Voor Microsoft Dynamics 365 formulierscripts wordt deze methode niet ondersteund. Het is belangrijk om er rekening mee te houden dat het kenmerk de gegevens opslaat en het besturingselement alleen de presentatie van het kenmerk op het formulier is. Voor besturingselementen die zijn gekoppeld aan kenmerken moet u eventueel de manier waarop u normaal gesproken toegang krijgt tot gegevens op een formulier wijzigen.
Besturingselementen worden ingedeeld op type. U kunt het type van een besturingselement definiëren door de getControlType of andere methode te gebruiken. Bepaalde besturingstypemethoden zijn alleen beschikbaar voor specifieke typen besturingselementen. Bijvoorbeeld, de methode addOption is alleen beschikbaar voor besturingselementen die als optiesets worden weergegeven. Zie Xrm.Page.ui control (referentie aan de clientzijde) voor meer informatie.
entiteit
Xrm.Page.data.entity biedt methoden om informatie op te halen die specifiek zijn voor het weergegeven record op de pagina, de save methode, en een verzameling van alle kenmerken toegevoegd aan het formulier. Zie Xrm.Page.data.entity (clientreferentie) voor meer informatie.
formSelector
De Xrm.Page.ui.formSelector bevat een itemverzameling die mogelijkheden biedt op een query te maken voor formulieren voor de huidige gebruiker. Gebruik de navigate methode om het huidige formulier te sluiten en ander te openen. Zie Xrm.Page.ui.formSelector-item (clientreferentie) voor meer informatie.
navigatie
Bevat geen methoden. Biedt toegang tot de navigatie-items door de itemsverzameling.
proces
Bevat methoden om eigenschappen van een bedrijfsprocesstroom op te halen.Meer informatie:Procesmethoden
Sectie
Een sectie bevat methoden voor het beheren van hoe het wordt weergegeven naast de toegang tot het tabblad dat de sectie bevat. Een sectie biedt ook toegang tot de besturingselementen hierin via een besturingselementenverzameling.Meer informatie:Sectie Xrm.Page.ui (clientreferentie)
fase
Elke proces heeft een verzameling van stappen waartoe toegang kan worden verkregen via de methode getStages voor het proces.
Eén fase is de actieve fase.Meer informatie:Structuur van bedrijfsprocesstromen
stap
Stappen vertegenwoordigen afzonderlijke gegevensitems die moeten worden verzameld tijdens een fase. Elke fase heeft een verzameling van stappen waartoe toegang kan worden verkregen via de methode getSteps voor de fase.Meer informatie:Structuur van bedrijfsprocesstromen
U kunt toegang verkrijgen tot een stapbesturingselement binnen de actieve fase van een bedrijfsprocesstroombesturing door te verwijzen naar de besturingselementnaam met het speciale voorvoegsel "header_process_<besturingselementnaam>". Als u bijvoorbeeld de stap wilt verbergen die het kenmerk purchaseprocess vertegenwoordigt, gebruikt u het volgende:
Xrm.Page.getControl("header_process_purchaseprocess").setVisible(false);
tabblad
Een tabblad is een groep secties op een pagina. Het bevat methoden om de weergave van het tabblad te wijzigen. U hebt toegang tot secties op het tabblad door de sectieverzameling. Zie Tabblad Xrm.Page.ui (clientreferentie) voor meer informatie.
Zie ook
Beknopte naslag voor het opstellen van formulierscripts
Scripts voor CRM voor tablets schrijven en er fouten in opsporen
Code schrijven voor Microsoft Dynamics CRM 2015-formulieren
Scripts schrijven voor samengestelde kenmerken
Scripts schrijven voor bedrijfsprocesstromen
JavaScript gebruiken met Microsoft Dynamics CRM 2015
Voorbeeld: Afhankelijke OptionSets maken (selectielijsten)
Programmeerreferentie op de client
Programmeerreferentie op de client
JavaScript-bibliotheken voor Microsoft Dynamics CRM 2015
Entiteitformulieren aanpassen
© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht