Xrm.Utility (clientreferentie)

 

Gepubliceerd: januari 2017

Is van toepassing op: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Het Xrm.Utility-object biedt een container voor nuttige functies die niet onmiddellijk verband houden met de huidige pagina.

Deze functies zijn beschikbaar op elke toepassingspagina die scriptgebruik ondersteunt. U kunt ze gebruiken in formulierscripts of in lintopdrachten. Voor HTML-webresources zijn zij beschikbaar wanneer u de pagina ClientGlobalContext.js.aspx opneemt. Zie Functie GetGlobalContext en ClientGlobalContext.js.aspx (clientreferentie) voor meer informatie.

Functies

• Dialoogvensters
  Gebruik alertDialog- en confirmDialog-weergaveberichten voor gebruikers en stel code in die wordt uitgevoerd op basis van hun reactie. Deze functies moeten worden gebruikt met mobiele Dynamics 365-clients (telefoons en tablets) in plaats van met de methoden window.alert en window.confirm.

• Systeemeigen apparaatmogelijkheden (mobiele clients van Dynamics 365)
  Gebruik getBarcodeValue en getCurrentPosition om de systeemeigen apparaatmogelijkheden van mobiele apparaten te gebruiken om de streepjescodewaarde of de huidige positie van het apparaat op te halen.

• isActivityType
  Bepaal of een entiteit een activiteitsentiteit is.

• openEntityForm
  Opent een entiteitsformulier.

• openQuickCreate
  Gebruik voor Update 1 voor Microsoft Dynamics CRM Online 2015 of later deze functie om een formulier voor snelle invoer te maken te openen. U kunt deze functie gebruiken voor het instellen van standaardwaarden met kenmerktoewijzingen of voor specifieke kenmerken. Als de gebruiker de record opslaat, kunt u een verwijzing naar de gemaakte record vastleggen.

• openWebResource
  Opent een HTML-webresource.

Dialoogvensters

Er zijn twee typen dialoogvensters: alertDialog en confirmDialog. Deze zijn bedoeld om te gebruiken met scripts die werken met mobieleDynamics 365-clients (telefoons en tablets). Mobiele Dynamics 365-clients staan niet het gebruik toe van JavaScript-functies die de stroom van code blokkeren, zoals window.alert en window.confirm. Gebruik deze methoden in plaats van die methoden wanneer u een bericht moet weergeven aan de gebruiker. Het belangrijkste verschil is dat deze methoden geen code blokkeren totdat een gebruiker ze sluit. Zij bevatten een parameter voor een callbackfunctie om aan te geven welke code moet worden uitgevoerd afhankelijk van de respons van de gebruiker.

Notitie

In mobiele Dynamics 365-clients (telefoons en tablets) wordt elk gebruik van de methode window.alert genegeerd om Xrm.Utility.alertDialog te gebruiken zonder callback. Hiermee wordt het bericht weergegeven maar wordt de uitvoering van code niet geblokkeerd zoals bij window.alert. Deze toewijzing van window.alert aan Xrm.Utility.alertDialog in mobiele Dynamics 365-clients is afgeschaft en wordt verwijderd in de volgende hoofdversie. U moet eventuele bestaande code migreren om Xrm.Utility.alertDialog te gebruiken in plaats van window.alert.

alertDialog

Hiermee wordt een dialoogvenster weergegeven dat een door de toepassing gedefinieerd bericht bevat.

Xrm.Utility.alertDialog(message,onCloseCallback)

• Parameters

  Naam	Type	Vereist	Beschrijving
  bericht	Tekenreeks	Ja	De tekst van het bericht dat moet worden weergegeven in het dialoogvenster.
  onCloseCallback	Functie	Nee	Een functie die moet worden uitgevoerd als op de knop OK wordt geklikt.

• Opmerkingen
  Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

confirmDialog

Hiermee wordt een bevestigingsvenster weergegeven dat een optioneel bericht alsmede de knoppen OK en Annuleren bevat.

Xrm.Utility.confirmDialog(message,yesCloseCallback,noCloseCallback)

• Parameters

  Naam	Type	Vereist	Beschrijving
  bericht	Tekenreeks	Ja	De tekst van het bericht dat moet worden weergegeven in het dialoogvenster
  yesCloseCallback	Functie	Nee	Een functie die moet worden uitgevoerd als op de knop OK wordt geklikt.
  noCloseCallback	Functie	Nee	Een functie die moet worden uitgevoerd als op de knop Annuleren wordt geklikt.

• Opmerkingen
  Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

Systeemeigen apparaatmogelijkheden (mobiele clients van Dynamics 365)

Gebruik deze methoden voor Dynamics 365 voor telefoons- en Dynamics 365 voor tablets-clients om de gebruikerservaring voor mobiele bedrijfsgebruikers in verkoop, fieldservice en andere gebieden uit te breiden.

Notitie

Deze methoden werden geïntroduceerd in Update voor Dynamics 365 (online en on-premises) - december 2016.

getBarcodeValue

Retourneert de streepjescode-informatie, zoals een productnummer, gescand met de apparaatcamera.

Xrm.Utility.getBarcodeValue().then(successCallback, errorCallback)

• Parameters

  Naam	Type	Vereist	Beschrijving
  successCallback	Functie	Ja	Een functie om aan te roepen wanneer de streepjescodewaarde wordt geretourneerd.
  errorCallback	Functie	Ja	Een functie die moet worden aangeroepen als de bewerking is mislukt. Er wordt een foutobject met de eigenschap message doorgegeven waarmee de foutdetails worden beschreven.

• Opmerkingen
  De methode getBarcodeValue werkt alleen als de mobiele clients van Dynamics 365 toegang hebben tot uw apparaatcamera, die standaard is ingeschakeld.

• Voorbeeld
  De volgende voorbeeldcode laat zien u hoe u deze methode moet gebruiken.

  Xrm.Utility.getBarcodeValue().then(
      function (result) {
          Xrm.Utility.alertDialog("Barcode value: " + result);
      },
      function (error) {
          Xrm.Utility.alertDialog(error.message);
      })
  

getCurrentPosition

Retourneert de huidige locatie met de geolocatiemogelijkheid van het apparaat.

Xrm.Utility.getCurrentPosition().then(successCallback, errorCallback)

• Parameters

  Naam	Type	Vereist	Beschrijving
  successCallback	Functie	Ja	Een functie om aan te roepen wanneer informatie over de huidige geolocatie wordt geretourneerd. Een geolocatieobject met de volgende kenmerken wordt doorgegeven aan de functie. coords: bevat een verzameling geografische coördinaten met de relevante nauwkeurigheid en een aantal andere, optionele kenmerken, zoals hoogte en snelheid. timestamp: dit is de tijd waarop het object is verkregen en deze wordt weergegeven als DOMTimeStamp.
  errorCallback	Functie	Ja	Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven: code: getal. De foutcode. message: tekenreeks. Gelokaliseerd bericht waarin de foutdetails worden beschreven. Als de instelling voor gebruikerslocatie niet op uw mobiele apparaat is ingeschakeld, wordt in het foutbericht hetzelfde aangegeven. Als u een eerdere versie van de mobile client van Dynamics 365 gebruikt of als de functie voor geolocatie niet beschikbaar is op uw mobiele apparaat, wordt null doorgegeven aan de fout-callback.

• Opmerkingen
  De methode getCurrentPosition werkt alleen als de functie voor geolocatie op uw apparaat is ingeschakeld en de mobiele clients van Dynamics 365 toegang hebben tot de apparaatlocatie, wat standaard niet het geval is.

• Voorbeeld
  De volgende voorbeeldcode laat zien u hoe u deze methode moet gebruiken.

  Xrm.Utility.getCurrentPosition().then
      (function (location) {
          Xrm.Utility.alertDialog("Latitude: " + location.coords.latitude +
             ", Longitude: " + location.coords.longitude);
      },
      function (error) {
          Xrm.Utility.alertDialog(error.message);
      })
  

isActivityType

Bepaal of een entiteit een activiteitsentiteit is.

Xrm.Utility.isActivityType(entityName)

• Parameter

  Naam	Type	Vereist	Beschrijving
  entityName	Tekenreeks	Ja	De logische naam van een entiteit.

• Retourwaarde

  Type	Beschrijving
  Boolean	Waar als de entiteit een activiteitsentiteit is, anders onwaar.

openEntityForm

Opent een entiteitsformulier voor een nieuwe of bestaande entiteitsrecord met de optie die u instelt als parameters.

Xrm.Utility.openEntityForm(name,id,parameters,windowOptions)

• Parameters

  Naam	Type	Vereist	Beschrijving
  naam	Tekenreeks	Ja	De logische naam van de entiteit.
  id	Tekenreeks	Nee	De tekenreeksweergave van een unieke id of de te openen record in het formulier. Als deze niet ingesteld, wordt een formulier voor het maken van een nieuwe record geopend.
  parameters	Object	Nee	Een woordenlijstobject dat extra parameters doorgeeft aan het formulier. Ongeldige parameters veroorzaken een fout. Geldige extra querytekenreeksparameters zijn: Formulier-id: Om de id-waarde in te stellen van het hoofdformulier dat moet worden gebruikt als er meer dan één formulier beschikbaar is. De parameter is formid. Standaardveld-id's: Voor het instellen van standaardwaarden voor een nieuw recordformulier. Zie Veldwaarden instellen via parameters die worden doorgegeven aan een formulier voor meer informatie. De parameters navbar en cmdbar beschreven in Querytekenreeksparameters voor de Main.aspx-pagina. Aangepaste tekenreeksparameters: Een formulier kan worden geconfigureerd om de aangepaste tekenreeksparameters te accepteren. Zie Een formulier configureren om aangepaste querytekenreeksparameters te accepteren voor meer informatie.
  windowOptions	Object	Nee	Gebruik voor Update 1 voor Microsoft Dynamics CRM Online 2015 of later deze optionele parameter in de webtoepassing om te bepalen hoe het formulier wordt geopend. U kunt een formulier in een nieuw venster openen door een woordenlijstobject door te geven waarvoor een booleaanse eigenschap openInNewWindow is ingesteld op true. Deze parameter wordt genegeerd mobiele Dynamics 365-clients (telefoons en tablets).

• Opmerkingen
  Het gebruik van deze functie helpt ervoor te zorgen dat gebruikers niet worden gevraagd zich opnieuw aan te melden onder bepaalde omstandigheden.

• Voorbeelden
  Een nieuwe accountrecord openen met het standaardformulier

  Xrm.Utility.openEntityForm("account");
  

  Een bestaande accountrecord openen met het standaardformulier

  Xrm.Utility.openEntityForm("account","A85C0252-DF8B-E111-997C-00155D8A8410");
  

  Een nieuwe accountrecord openen met een bepaald formulier en met instelling van standaardwaarden

  var parameters = {};
  parameters["formid"] = "b053a39a-041a-4356-acef-ddf00182762b";
  parameters["name"] = "Test";
  parameters["telephone1"] = "(425) 555-1234";
  Xrm.Utility.openEntityForm("account", null, parameters);
  

  Een nieuwe accountrecord openen met het standaardformulier in een nieuw venster

  var windowOptions = {
   openInNewWindow: true
  };
  Xrm.Utility.openEntityForm("account",null,null,windowOptions);
  

openQuickCreate

Gebruik voor Update 1 voor Microsoft Dynamics CRM Online 2015 of later deze functie om een formulier voor snelle invoer te maken te openen. U kunt deze functie gebruiken voor het instellen van standaardwaarden met kenmerktoewijzingen of voor specifieke kenmerken. Als de gebruiker de record opslaat, kunt u een verwijzing naar de gemaakte record vastleggen.

Xrm.Utility.openQuickCreate(entityLogicalName,createFromEntity,parameters).then(successCallback, errorCallback);

• Parameters

  Naam	Type	Vereist	Beschrijving
  entityLogicalName	Tekenreeks	Ja	De logische naam van de te maken entiteit.
  createFromEntity	Opzoeken	Nee	Geeft een record aan die standaardwaarden verstrekt op basis van toegewezen kenmerkwaarden. Een opzoekobject heeft de volgende String-eigenschappen: entityType: de logische naam van de entiteit. id: een tekenreeksweergave van een GUID-waarde voor de record. name: de primaire kenmerkwaarde van de record.
  parameters	Object	Nee	Een woordenlijstobject dat extra querytekenreeksparameters doorgeeft aan het formulier. Ongeldige querytekenreeksparameters veroorzaken een fout. Geldige extra querytekenreeksparameters zijn: Standaardveld-id's: Voor het instellen van standaardwaarden voor een nieuw recordformulier. Zie Veldwaarden instellen via parameters die worden doorgegeven aan een formulier voor meer informatie. Aangepaste tekenreeksparameters: Een formulier kan worden geconfigureerd om de aangepaste tekenreeksparameters te accepteren. Zie Een formulier configureren om aangepaste querytekenreeksparameters te accepteren voor meer informatie.
  successCallback	Functie	Nee	De functie die wordt aangeroepen als een record wordt gemaakt. Aan deze functie wordt een object doorgegeven als een parameter. Dit object bevat een eigenschap savedEntityReference met de volgende eigenschappen om de gemaakte record te identificeren: entityType: de logische naam van de entiteit. id: een tekenreeksweergave van een GUID-waarde voor de record. name: de primaire kenmerkwaarde van de gemaakte record.
  errorCallback	Functie	Nee	Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven: errorCode: Number. De foutcode. bericht: String. Een gelokaliseerd foutbericht.

• Opmerkingen
  Deze functie is alleen beschikbaar voor Update 1 voor Microsoft Dynamics CRM Online 2015 of later.

  Er geldt een limiet van 10 geneste formulieren voor snelle invoer in de webtoepassing. Als deze limiet wordt overschreden, wordt met deze functie het complete entiteitsformulier geopend in plaats van het formulier voor snelle invoer.

• Voorbeeld
  Als deze code wordt uitgevoerd in een entiteitsformulier voor accounts, wordt een formulier voor snelle invoer gemaakt om een nieuwe onderliggende account te maken waarvoor een standaardnaam is ingesteld die de naam van de bovenliggende account bevat.

  var thisAccount = {
      entityType: "account",
      id: Xrm.Page.data.entity.getId()
  };
  var callback = function (obj) {
      console.log("Created new " + obj.savedEntityReference.entityType + " named '" + obj.savedEntityReference.name + "' with id:" + obj.savedEntityReference.id);
  }
  var setName = { name: "Child account of " + Xrm.Page.getAttribute("name").getValue() };
  Xrm.Utility.openQuickCreate("account", thisAccount, setName).then(callback, function (error) {
      console.log(error.message);
  });
  

  Als deze code wordt uitgevoerd met ontwikkelingshulpmiddelen voor de browser (F12-hulpmiddelen) geeft het volgende de uitvoer naar de console aan als de code wordt uitgevoerd in de context van een account met met naam 'A. Datum Corporation (sample)' en de gebruiker de standaardnaam die is ingesteld voor de nieuwe onderliggende account niet heeft gewijzigd.

  Created new account named 'Child account of A. Datum Corporation (sample)' with id:{1D4BFF87-E8C5-E411-80CF-00155DB58496}
  

openWebResource

Opent een HTML-webresource.

Notitie

Deze functie wordt niet ondersteund voor de mobiele Dynamics 365-clients (telefoons en tablets) en de interactieve servicehub.

Xrm.Utility.openWebResource(webResourceName,webResourceData,width, height)

• Parameters

  Naam	Type	Vereist	Beschrijving
  webResourceName	Tekenreeks	Ja	De naam van de HTML-webresource die moet worden geopend.
  webResourceData	Tekenreeks	Nee	Gegevens die in de gegevensparameter moeten worden doorgegeven.
  width	Nummer	Nee	De breedte van het te openen venster in pixels.
  height	Nummer	Nee	De hoogte van het te openen venster in pixels.

• Retourwaarde
  Vensterobject.

• Opmerkingen
  Een HTML-webresource kan de parameterwaarden accepteren die zijn beschreven in Geef parameters door aan HTML webresources. Deze functie zorgt alleen voor het doorgeven van de optionele gegevensparameter. Als u waarden wilt doorgeven voor andere geldige parameters, moet u deze toevoegen aan de aan de parameter webResourceName.

• Voorbeelden
  Open een HTML-webresource genaamd "new_webResource.htm"

  Xrm.Utility.openWebResource("new_webResource.htm");
  

  Open een HTML-webresource met een enkel gegevensitem voor de gegevensparameter

  Xrm.Utility.openWebResource("new_webResource.htm","dataItemValue");
  

  Open een HTML-webresource die meerdere waarde doorgeeft via de gegevensparameter

  var customParameters = encodeURIComponent("first=First Value&second=Second Value&third=Third Value");
  Xrm.Utility.openWebResource("new_webResource.htm",customParameters);
  

  Notitie

  Deze waarden moeten wordt opgehaald uit de waarde van de gegevensparameter in de HTML-webresource. Zie Voorbeeld: Meerdere waarden aan een webresource doorgeven met de gegevensparameter voor meer informatie

  Open een HTML-webresource met de parameters die worden verwacht door HTML-webresources

  Xrm.Utility.openWebResource("new_webResource.htm?typename=account&userlcid=1033");
  

  Zie Geef parameters door aan HTML webresources voor meer informatie.

  Open een HTML-webresource, waarbij de hoogte en breedte worden ingesteld

  Xrm.Utility.openWebResource("new_webResource.htm", null, 300,300);
  

Zie ook

Programmeerreferentie op de client
Formulieren, weergaven, dialogen en rapporten met een URL openen
Veldwaarden instellen via parameters die worden doorgegeven aan een formulier
Een formulier configureren om aangepaste querytekenreeksparameters te accepteren
Beknopte naslag voor het opstellen van formulierscripts
Code schrijven voor Microsoft Dynamics 365-formulieren
Het objectmodel Xrm.Page gebruiken

Microsoft Dynamics 365

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht