Delen via

Xrm.Page.ui control (referentie aan de clientzijde)

  • Artikel

 

Gepubliceerd: januari 2017

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

Het object control biedt methoden om de weergave of het gedrag van een besturingselement te wijzigen en het overeenkomstige kenmerk te identificeren.

U hebt toegang tot besturingselementen door verzamelingen die de volgende gebruiken: Xrm.Page.ui.besturingselementen, Xrm.Page.ui Section.besturingselementen, of Xrm.Page.data.entity Attribute.besturingselementen. De Xrm.Page.getControl methode is door een snelkoppelingmethode tot Xrm.Page.ui.controls.get toegang te verkrijgen.

De syntaxisvoorbeelden in dit onderwerp laten zien hoe de methode Xrm.Page.getControl wordt gebruikt om een besturingselement te openen. Welk besturingselement hangt af van de argumenten die aan de methode worden gegeven. De parameter args om toegang te krijgen tot één besturingselement moet de naam van het besturingselement of de inhoudsopgave zijn.

Als een formulier een bedrijfsprocesstroombesturingselement in de kop- worden weergegeven, worden extra besturingselementen voor elk kenmerk zijn toegevoegd dat in de bedrijfsprocesstroom wordt weergegeven. Deze besturingselementen hebben een unieke naam die vergelijkbaar is met het volgende voorbeeld: header_process_<attribute name>.

Notitie

Alleen besturingselementen in de actieve fase van de bedrijfsprocesstroom kunnen op deze manier op naam worden geopend.

De besturingselementen die in de formulierkoptekst worden weergegeven zijn toegankelijk en een unieke naam hebben in de volgende gevallen: header_<attribute name>.

Voor besturingselementen die zijn gebonden aan kenmerken zijn het vaak voor toegankelijk met de verzameling Xrm.Page.data.entity Attribute.besturingselementen.

De aangepaste besturingselementen voor mobiele Dynamics 365-clients (telefoons en tablets) ondersteunen alle eigenschappen en methoden voor besturingselementen, behalve de volgende: Methoden voor automatisch aanvullen, getValue, Toetsdrukmethoden en Beheer van opzoekmethoden en evenementen.

Met de versie Update 1 voor Microsoft Dynamics CRM Online 2016 en Microsoft Dynamics CRM 2016 Service Pack 1 (on-premises) worden de volgende methoden nu ondersteund voor het timerbesturingselement in de nieuwe engine voor formulierweergave (ook wel "turboformulieren" genoemd): de methoden: getControlType, getName, getParent, Label, refresh en Zichtbaar.

Besturingselementeigenschappen en methoden

  • Methoden voor automatisch aanvullen
    Configureer de opties voor automatisch aanvullen in tekstbesturingselementen in Dynamics 365-formulieren. Deze methoden werden geïntroduceerd in Dynamics 365.

  • Uitgeschakeld
    Ontdek de status en in- of uitschakelen van besturingselementen met de methoden getDisabled en setDisabled.

  • getAttribute
    Haal het kenmerk op dat het besturingselement aan is verbonden.

  • getControlType
    Meer informatie over het type besturingselement.

  • getName
    Haal de naam van het besturingselement op.

  • getParent
    Haal het sectieobject op waarin het besturingselement is.

  • getValue
    Hiermee wordt de laatste waarde voor een besturingselement opgehaald wanneer gebruikers een teken in een bepaalde tekst of getalveld typen. Deze methode werd geïntroduceerd in Dynamics 365.

  • Toetsdrukmethoden
    Een functie toevoegen, verwijderen of uitvoeren als de gebruiker op een toets in een besturingselement drukt. Deze methoden werden geïntroduceerd in Dynamics 365.

  • Methode voor besturingselementen voor Knowledge Base
    Deze methoden zijn alleen beschikbaar voor het besturingselement voor een Knowledge Base-zoekactie in een exemplaar van Dynamics 365 waarin de kennisbeheerfunctie is ingeschakeld.

    Voor informatie over dit besturingselement raadpleegt u Zoekbesturingselement voor Knowledge Base (clientreferentie).

  • Label
    Haal of wijzig het label voor een besturingselement van de methoden van getLabel en setLabel.

  • Beheer van opzoekmethoden en evenementen
    Beheer de resultaten van een gebruiker worden weergegeven om vervolgens uit te kiezen wanneer ze de waarde van een opzoekbesturingselement via addCustomFilter, addCustomView, getDefaultView, setDefaultView methoden instellen.

    Gebeurtenishandlers voor PreSearch-gebeurtenis u kunt toevoegen of verwijderen met behulp van de methoden van addPreSearch en removePreSearch.

  • Melding
    Weergeven en verwijderen van meldingen voor gebruikers over een besturingselement met een van de methoden van setNotification, addNotification en clearNotification.

  • OptionSet-besturingmethoden
    Wijzig de opties die in OptionSet-besturingselementen worden weergegeven met addOption, clearOptions, removeOption en methoden.

  • ShowTime
    Gebruik setShowTime om op te geven of een datumbesturingselement het tijdgedeelte van de datum moet weergeven en getShowTime om te bepalen of het tijdgedeelte van de datum momenteel wordt weergegeven.

  • Methoden voor subrasterbesturingselement
    Voor organisaties die CRM Online 2015 Update 1 gebruiken, zijn er nieuwe mogelijkheden om te werken met subrasterbesturingselementen.Meer informatie:Rasterobjecten (alleen-lezen) en -methoden (clientreferentie)

    Voor andere organisaties is de methode refresh de enige unieke methode die beschikbaar is voor subrasterbesturingselementen. Met deze methode worden de gegevens vernieuwd die in het subraster worden weergegeven.

  • Zichtbaar
    Definieer welke besturingselementen zichtbaar of verbergen en ze worden weergegeven die de methoden gebruiken van getVisible en setVisible.

  • Webresource en IFRAME-BESTURINGSELEMENTMETHODEN
    Communiceer met webresource- en IFRAME-besturingselementen met de methoden van getData, setData, getInitialUrl, getObject, setSrc en getSrc.

Methoden voor automatisch aanvullen

Gebruik de methoden showAutoComplete en hideAutoComplete om de opties voor automatisch aanvullen te configureren in tekstbesturingselementen in formulieren.

Voor een JavaScript-voorbeeldcode die de functie voor automatisch aanvullen laat zien raadpleegt u Voorbeeld: Automatisch aanvullen in Dynamics 365-besturingselementen

Notitie

Deze methoden worden niet ondersteund voor de mobiele Dynamics 365-clients (telefoons of tablets) en de interactieve servicehub. Deze methoden zijn alleen beschikbaar voor Bijgewerkte entiteiten.

showAutoComplete

Gebruik deze methode om maximaal 10 overeenkomende tekstreeksen weer te geven in een vervolgkeuzelijst terwijl gebruikers op toetsen drukken om tekens te typen in een specifiek tekstveld. U kunt ook een aangepaste opdracht toevoegen met een pictogram onder aan de vervolgkeuzelijst. Bij het selecteren van een item in de vervolgkeuzelijst wordt de waarde in het tekstveld gewijzigd in het geselecteerde item, verdwijnt de vervolgkeuzelijst en wordt Gebeurtenis OnChange voor het tekstveld aangeroepen.

Xrm.Page.getControl(arg).showAutoComplete(object)

  • Parameter
    Type: Object dat de resultatenset definieert, waaronder results en commands, die moet worden weergegeven in de vervolgkeuzelijst voor automatisch aanvullen.

    Opmerkingen: Roep deze methode aan in een functie die u hebt toegevoegd met de methode addOnKeyPress, om uit te voeren op de gebeurtenis keypress.

    Voorbeeld: Het volgende voorbeeld toont de definitie van het object dat wordt doorgestuurd naar de methode showAutoComplete.

    var resultset = { 
   results: [{ 
         id: <value1>, 
         icon: <url>, 
         fields: [<fieldValue1>]}, 

         {...}, 

         { 
         id: <valueN>, 
         icon: <url>, 
         fields: [<fieldValue1, fieldValue2,..., fieldValueN>]}],
   commands:{ 
         id: <value>, 
         icon: <url>, 
         label: <value>, 
         action: <function reference> 
   } 
}

hideAutoComplete

Gebruik deze functie om de vervolgkeuzelijst voor automatisch aanvullen die u hebt geconfigureerd voor een specifiek veld te verbergen.

Xrm.Page.getControl(arg).hideAutoComplete()

Notitie

U hoeft de methode hideAutoComplete niet expliciet te gebruiken omdat de vervolgkeuzelijst standaard wordt verborgen als de gebruiker ergens anders klikt of als een nieuwe vervolgkeuzelijst wordt weergegeven. Deze functie is beschikbaar in het geval ontwikkelaars de vervolgkeuzelijst voor automatisch aanvullen expliciet moeten verbergen om een aangepast scenario te verwerken.

Uitgeschakeld

Gebruik de getDisabled en setDisabled om te detecteren of een - besturingselement wordt uitgeschakeld of het inschakelen of uitschakelen.

Besturingselementtypen: de standaardinstelling, opzoeken, optionset.

getDisabled

Geeft aan of het besturingselement is uitgeschakeld.

Xrm.Page.getControl(arg).getDisabled()
  • Retourwaarde
    Type: Boole-waarde. Waar als het besturingselement is uitgeschakeld, anders niet-waar.

setDisabled

Stelt in of het besturingselement is uitgeschakeld.

Xrm.Page.getControl(arg).setDisabled(bool)
  • Argumenten
    Type: Boole-waarde. Waar als het besturingselement uitgeschakeld moet zijn, anders niet-waar.

getAttribute

Geeft het kenmerk op dat het besturingselement aan is verbonden.

Besturingselementtypen: de standaardinstelling, opzoeken, optionset.

Xrm.Page.getControl(arg).getAttribute()

Notitie

De besturingselementen die niet die aan een kenmerk zijn verbonden (subraster, webresource en IFRAME) hebben deze methode niet. Een fout wordt geworpen als u probeert deze methode in een van de volgende besturingselementen te gebruiken.

  • Retourwaarde
    Type: Object: een kenmerk

Opmerkingen

De constituerende besturingselementen binnen een besturingselement voor snelle weergave zijn opgenomen in de besturingselementenverzameling en deze besturingselementen hebben de methode getAttribute. Echter, is het kenmerk geen onderdeel van de kenmerkverzameling voor de entiteit. Als u de waarde voor het kenmerk kunt ophalen via getValue en zelfs de waarde aanpassen met setValue, worden de wijzigingen die u aanbrengt niet opgeslagen met de entiteit.

De volgende code toont het gebruik van de waarde van het kenmerk mobilephone van de contactpersoon bij weergave op een accountformulier via een besturingselement voor snelle weergave genaamd contactQuickForm. Deze code verbergt het besturingselement wanneer de waarde van het kenmerk null is.

var quickViewMobilePhoneControl = Xrm.Page.getControl("contactQuickForm_contactQuickForm_contact_mobilephone");
 if (quickViewMobilePhoneControl.getAttribute().getValue() == null)
 {
  quickViewMobilePhoneControl.setVisible(false);
 }

getControlType

Geeft een waarde aan die besturingselementen categoriseert.

Besturingselementtypen: alle.

Xrm.Page.getControl(arg).getControlType()

  • Retourwaarde
    Type: Tekenreeks

    Mogelijke retourneertwaarden van getControlType:

    Retourwaarde

    Beschrijving

    standard

    Een standaardbesturingselement.

    iframe

    Een IFrame-besturingselement

    lookup

    Een opzoekbesturingselement.

    optionset

    Een optiesetbesturingselement.

    subgrid

    Een subrasterbesturingselement.

    webresource

    Een webresource-besturingselement.

    notes

    Een notitiebesturingselement.

    timercontrol

    Een timerbesturingselement.

    kbsearch

    Een zoekbesturingselement voor Knowledge Base.

    customcontrol: <naamruimte>.<naam>

    Een aangepast besturingselement voor mobiele Dynamics 365-clients (telefoons en tablets).

    customsubgrid:<naamruimte>.<naam>

    Een aangepast gegevenssetbesturingselement voor mobiele Dynamics 365-clients (telefoons en tablets).

getName

Haalt de toegewezen naam van het besturingselement op.

Notitie

De naam die wordt toegewezen aan een - besturingselement wordt pas gedefinieerd wanneer het formulier wordt geladen. De wijzigingen aanbrengen in het formulier kunnen de naam wijzigen van toegewezen besturingselementen.

Besturingselementtypen: alle.

Xrm.Page.getControl(arg).getName()
  • Retourwaarde
    Type: Tekenreeks. De naam van het besturingselement.

getParent

Retourneert een verwijzing naar het sectieobject dat het besturingselement bevat.

Besturingselementtypen: alle.

Xrm.Page.getControl(arg).getParent()

getValue

Hiermee wordt de laatste waarde in een besturingselement opgehaald wanneer de gebruiker tekens in een bepaalde tekst of getalveld typt. Deze procedure helpt u interactieve ervaringen te maken door gegevens te valideren en gebruikers te melden wanneer ze tekens in een besturingselement typen.

De methode getValue verschilt van de methode voor het kenmerk getValue omdat met de besturingselementmethode de waarde van het besturingselement wordt opgehaald terwijl de gebruiker in het besturingselement typt, in tegenstelling tot de methode van het kenmerk getValue waarmee de waarde wordt opgehaald nadat de gebruiker het veld heeft vastgelegd (opgeslagen).

Notitie

Deze methode wordt niet ondersteund voor de mobiele Dynamics 365-clients (telefoons of tablets) en is alleen beschikbaar voor Bijgewerkte entiteiten.

Voor een JavaScript-voorbeeldcode die de methode getValue gebruikt om de opties voor automatisch aanvullen te configureren raadpleegt u Voorbeeld: Automatisch aanvullen in Dynamics 365-besturingselementen.

Xrm.Page.getControl(arg).getValue()
  • Retourwaarde
    Type: Tekenreeks. De nieuwste gegevenswaarde voor een besturingselement.

Toetsdrukmethoden

Gebruik de methoden addOnKeyPress, removeOnKeyPress en fireOnKeyPress om direct feedback te geven of acties te voeren wanneer de gebruiker in een besturingselement typt. Met deze methoden kunt u gegevensvalidaties uitvoeren in een besturingselement, nog voordat de gebruiker de waarde in een formulier vastlegt (opslaat).

Notitie

Deze methoden worden niet ondersteund voor de mobiele Dynamics 365-clients (telefoons of tablets) en zijn alleen beschikbaar voor Bijgewerkte entiteiten.

addOnKeyPress

Hiermee kunt u een functie toevoegen als gebeurtenishandler voor de toetsdrukgebeurtenis, zodat de functie wordt aangeroepen wanneer u een teken typt in het specifieke tekst- of getalveld.

Voor een JavaScript-voorbeeldcode die de methode addOnKeyPress gebruikt om de opties voor automatisch aanvullen te configureren raadpleegt u Voorbeeld: Automatisch aanvullen in Dynamics 365-besturingselementen.

Xrm.Page.getControl(arg).addOnKeyPress([function reference])

  • Parameter
    Type: functiereferentie

    Opmerkingen: De functie wordt aan de onderkant van de pipeline van de gebeurtenishandler toegevoegd. De uitvoeringscontext wordt automatisch ingesteld als eerste parameter die aan de gebeurtenishandler wordt doorgegeven met deze methode.Meer informatie:Uitvoeringscontext (clientreferentie)

    U moet een verwijzing naar een benoemde functie gebruiken in plaats van een anonieme functies als u de gebeurtenishandler voor het veld later wellicht wilt verwijderen.

removeOnKeyPress

Hiermee kunt u een gebeurtenishandler voor een tekst- of getalveld verwijderen die u hebt toegevoegd met addOnKeyPress.

Xrm.Page.getControl(arg).removeOnKeyPress([function reference])

  • Parameter
    Type: functiereferentie

    Opmerkingen Als een anonieme functie is ingesteld met addOnKeyPress, kan deze niet worden verwijderd met deze methode.

fireOnKeyPress

Hiermee kunt u een gebeurtenishandler handmatig activeren die u hebt gemaakt voor een specifiek tekst- of getalveld, zodat deze wordt geactiveerd bij de gebeurtenis keypress.

Xrm.Page.getControl(arg).fireOnKeyPress()

Methode voor besturingselementen voor Knowledge Base

Deze methoden zijn alleen beschikbaar voor het besturingselement voor een Knowledge Base-zoekactie, die beschikbaar is wanneer de Dynamics 365-organisatie is ingeschakeld voor de kennisbeheerfunctie. Voor informatie over deze besturingselementen raadpleegt u Zoekbesturingselement voor Knowledge Base (clientreferentie).

Label

Haal of wijzig het label voor een besturingselement van de methoden van getLabel en setLabel.

Besturingselementtypen: alle.

getLabel

Retourneert het label voor het besturingselement.

Xrm.Page.getControl(arg).getLabel()
  • Retourwaarde
    Type: Tekenreeks. Het label van het besturingselement.

setLabel

Stelt het label voor het besturingselement in.

Xrm.Page.getControl(arg).setLabel(label)
  • Argumenten
    Type: Tekenreeks. Het nieuwe label voor het besturingselement.

Beheer van opzoekmethoden en evenementen

Beheer de resultaten die worden weergegeven voor een gebruiker om uit te kiezen wanneer ze de waarde van een opzoekbesturingselement instellen via de methoden addCustomFilter, addCustomView, getDefaultView en setDefaultView. Het besturingselement Lookup geeft ook de PreSearch-gebeurtenis weer zodat u gebeurtenishandlers via programmeren kunt toevoegen met behulp van de methoden addPreSearch en removePreSearch.

Besturingselementtypen: opzoeken.

addCustomFilter

Gebruik deze om filters toe te voegen aan de resultaten in de opzoekbewerking. Elke filter wordt gecombineerd met een van de eerder toegevoegde filters als “AND”-voorwaarde.

Xrm.Page.getControl(arg).addCustomFilter(filter, entityLogicaName)

  • Argumenten

    • filterXml
      Type: Tekenreeks: Het toe te passen element van het fetchXml. Bijvoorbeeld:

      <filter type="and">
 <condition attribute="address1_city" operator="eq" value="Redmond" />
</filter>

    • entityLogicalName
      Type: Tekenreeks: (Optioneel) Als dit is ingesteld, wordt het filter alleen toegepast op dat entiteitstype. Anders wordt het toegepast op alle typen entiteiten.

  • Opmerkingen
    Meer informatie:FetchXML schema.

    Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

    Deze methode kan alleen in een functie in een gebeurtenismanager voor Gebeurtenis PreSearch van opzoekbesturingselement worden gebruikt.

    Het volgende voorbeeldcode is bestemd voor het opzoeken van het verkoopkansformulier Account (parentaccountid) Wanneer de functie Sdk.setParentAccountIdFilter is ingesteld in de Onload gebeurtenismanager van formulier, wordt de functie Sdk.filterCustomAccounts toegevoegd aan de gebeurtenis PreSearch voor de zoekactie. Het resultaat is dat alleen de accounts met de waarde van Categorie (accountcategorycode) Voorkeursklant (1) worden geretourneerd.

    var Sdk = window.Sdk || {};

Sdk.filterCustomerAccounts = function () {
    //Only show accounts with the type 'Preferred Customer'
    var customerAccountFilter = "<filter type='and'><condition attribute='accountcategorycode' operator='eq' value='1'/></filter>";
    Xrm.Page.getControl("parentaccountid").addCustomFilter(customerAccountFilter, "account");
}
//set 'Sdk.setParentAccountIdFilter' in the Opportunity form onload event handler
Sdk.setParentAccountIdFilter = function () {
    Xrm.Page.getControl("parentaccountid").addPreSearch(Sdk.filterCustomerAccounts);
}

addCustomView

Hiermee wordt een nieuwe weergave voor het dialoogvenster opzoekvak toegevoegd.

Xrm.Page.getControl(arg).addCustomView(viewId, entityName, viewDisplayName, fetchXml, layoutXml, isDefault)

  • Argumenten

    • viewId
      Type: Tekenreeks: De GUID voor een tekenreeksweergave van een weergave.

      Notitie

      Deze waarde wordt niet opgeslagen en hoeft alleen uniek te zijn onder de beschikbare weergaven voor het opzoeken. Een tekenreeks voor een nietgeldig GUID is, zoals "{00000000-0000-0000-0000-000000000001}" zal werken. Het wordt aanbevolen dat u een hulpprogramma zoals guidgen.exe gebruikt om u een geldige GUID te genereren. Het guidgen.exe-hulpprogramma is opgenomen in de Windows SDK.

    • entityName
      Type: Tekenreeks: De naam van de entiteit.

    • viewDisplayName
      Type: Tekenreeks: De naam van de weergave.

    • fetchXml
      Tekenreeks: De fetchxmlquery van de weergave.

    • layoutXml
      Type: Tekenreeks: De XML die de indeling van de weergave bepaalt.

    • is standaard
      Type: Boole-waarde: Of de weergave moet de standaardweergave zijn.

  • Opmerkingen
    Deze methode werkt niet met Eigenaar opzoekbewerkingen. De eigenaaropzoeken worden gebruikt om records waarvan de gebruiker eigenaar is toe te wijzen.

DefaultView

U kunt bepalen welke weergave de standaardweergave om gebruikers records in een opzoekweergave te laten selecteren en de standaardweergave te wijzigen met getDefaultView en setDefaultView.

getDefaultView

Retourneert de id-waarde van de weergave uit het standaarddialoogvenster opzoeken.

Xrm.Page.getControl(arg).getDefaultView()
  • Retourwaarde
    Type: Tekenreeks. De id-waarde van de standaardweergave.

setDefaultView

Stelt de standaardweergave in voor het opzoekbesturingselementdialoogvenster.

Xrm.Page.getControl(arg).setDefaultView(viewGuid)
  • Argumenten
    Type: Tekenreeks. De id van de weergave die als standaardweergave moet worden ingesteld.

Voorbeeld: deze setDefaultViewSample-functie stelt de standaardweergave van de opzoekactie van de primaire contactpersoon van de account-entiteit in op de weergave Mijn actieve contactpersonen.

function setDefaultViewSample() {
    Xrm.Page.getControl("primarycontactid").setDefaultView("{00000000-0000-0000-00AA-000010001003}");
}​

PreSearch-gebeurtenis

Gebeurtenishandlers voor Gebeurtenis PreSearch van opzoekbesturingselement u kunt toevoegen of verwijderen met behulp van de methoden van addPreSearch en removePreSearch.

Gebruik de PreSearch gebeurtenis om te controleren welke resultaten voor het besturingselement worden weergegeven van de huidige formuliergegevens als de gebruiker begint voor records te zoeken.

Bij beide methoden wordt Uitvoeringscontext (clientreferentie) doorgegeven als eerste parameter.

addPreSearch

Gebruik deze methode om wijzigingen in zoeken toe te passen op huidge waarden wanneer de gebruiker op het punt staat resultaten voor de zoekactie weer te geven.

Xrm.Page.getControl(arg).addPreSearch(handler)

  • Argumenten
    Type: Functie toe te voegen.

  • Opmerkingen
    Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

Het argument is een functie die wordt uitgevoerd vlak voordat de zoekactie om de resultaten voor een opzoekactie te bieden optreedt. U kunt deze handler gebruiken om een van de andere opzoekbesturingselementfuncties aan te roepen en de resultaten te verbeteren die in het opzoekveld worden weergegeven.

removePreSearch

Gebruik deze methode om de functies van de gebeurtenishandler te verwijderen die eerder voor de PreSearch gebeurtenis zijn ingesteld.

Xrm.Page.getControl(arg).removePreSearch(handler)

  • Argumenten
    Type: Functie toe verwijderen.

  • Opmerkingen
    Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

Melding

Gebruik deze methoden om meldingen voor een besturingselement weer te geven en te wissen.

setNotification

Hiermee wordt een foutbericht voor het besturingselement weergegeven om aan te geven dat gegevens ongeldig zijn. Als deze methode wordt gebruikt, verschijnt een rode X naast het besturingselement. Op mobiele Dynamics 365-clients kunt u op dit pictogram tikken om het bericht weer te geven.

Xrm.Page.getControl(arg).setNotification(message,uniqueId)

Opmerkingen

Wanneer een foutmelding voor een besturingselement wordt ingesteld, wordt het formulier niet opgeslagen.

Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

Argumenten

  • bericht
    Type: Tekenreeks: Het weer te geven bericht.

  • uniqueId
    Type: Tekenreeks: Het ID om te gebruiken bij het wissen van dit bericht met clearNotification. Optioneel.

Retourwaarde

Type: Boole-waarde: Geeft aan of de methode slaagt.

addNotification

Er wordt een fout of aanbeveling voor een besturingselement weergegeven en u kunt op basis van deze melding uit te voeren acties opgeven. Als u een foutmelding opgeeft, verschijnt een rode X naast het besturingselement. Als u een aanbeveling opgeeft, verschijnt een pictogram van een 'i' naast het besturingselement. Wanneer in mobiele Dynamics 365-clients op het pictogram wordt getikt, wordt het bericht weergegeven en kunt u de geconfigureerde actie uitvoeren door op de knop Toepassen te klikken of het bericht negeren.

Xrm.Page.getControl(arg).addNotification(object)

Opmerkingen

Wanneer u een foutmelding voor een besturingselement instelt, kan het formulier niet worden opgeslagen. Dit geldt niet voor aanbevelingsmeldingen.

Deze methode werd geïntroduceerd in Update voor Dynamics 365 (online en on-premises) - december 2016 en is alleen beschikbaar voor Bijgewerkte entiteiten.

Argumenten

De methode accepteert een object met de volgende kenmerken:

kenmerk

Type gegevens

Vereist

Beschrijving

messages

Matrix

Ja

Het bericht dat moet worden weergegeven in de melding. In de huidige versie wordt alleen het eerste bericht opgegeven in deze matrix weergegeven. De tekst die u hier opgeeft, wordt vet weergegeven in de melding en wordt doorgaans voor de titel of het onderwerp van de melding gebruikt. U moet het bericht tot 50 tekens beperken voor een optimale gebruikerservaring.

notificationLevel

Tekenreeks

Nee

Hiermee definieert u het meldingstype. Geldige waarden zijn ERROR of RECOMMENDATION. Als u dit kenmerk niet opgeeft in uw objectdefinitie, wordt het standaard ingesteld op ERROR.

uniqueId

Tekenreeks

Nee

De id die moet worden gebruikt om deze melding te wissen bij gebruik van clearNotification.

actions

Matrix van objecten

Nee

Een verzameling objecten met de volgende kenmerken:

  • message: tekenreeks. Het secundaire of hoofdbericht van de melding die voor de gebruiker moet worden weergegeven. U moet het bericht tot 100 tekens beperken voor een optimale gebruikerservaring.

  • actions: matrix. De corresponderende acties voor het bericht.

In de huidige release wordt slechts één hoofdbericht met corresponderende actie ondersteund. In het actieblok kunt u echter wel meerdere uit te voeren taken opgeven met JavaScript-code.

Notitie

Met de methode addNotification wordt een melding met de door u opgegeven berichten en twee standaardknoppen weergegeven: Toepassen en Negeren. Klik op Toepassen om de gedefinieerde actie uit te voeren en klik op Negeren om de melding te sluiten.

Retourwaarde

Type: Boole-waarde: Geeft aan of de methode slaagt.

Voorbeeld

Met de volgende voorbeeldcode wordt een melding in het veld Accountnaam van het accountformulier weergegeven om het beurssymbool in te stellen als het veld Accountnaam de waarde Microsoft bevat. Klik op Toepassen in de melding om het veld Beurssymbool in te stellen op "MSFT".

function addTickerSymbolRecommendation() {
    var myControl = Xrm.Page.getControl('name');
    var accountName = Xrm.Page.data.entity.attributes.get('name');
    var tickerSymbol = Xrm.Page.data.entity.attributes.get('tickersymbol');

    if (accountName.getValue('Microsoft') && tickerSymbol.getValue() != 'MSFT') {
        var actionCollection = {
            message: 'Set the Ticker Symbol to MSFT?',
            actions: null
        };

        actionCollection.actions = [function () {
            tickerSymbol.setValue('MSFT');
            myControl.clearNotification('my_unique_id');
        }];

        myControl.addNotification({
            messages: ['Set Ticker Symbol'],
            notificationLevel: 'RECOMMENDATION',
            uniqueId: 'my_unique_id',
            actions: [actionCollection]
        });
    }
    else
        console.log("Notification not set");
}

clearNotification

Verwijdert een bericht voor een besturingselement dat al wordt weergegeven.

Xrm.Page.getControl(arg).clearNotification(uniqueId)

Argumenten

  • uniqueId
    Type: Tekenreeks: de id om te gebruiken bij het wissen van een specifieke berichtenset die is ingesteld met setNotification of addNotification.

    Als de parameter uniqueId niet is opgegeven, wordt de huidige weergegeven melding verwijderd.

Opmerkingen

Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten.

Retourwaarde

Type: Boole-waarde: Geeft aan of de methode slaagt.

OptionSet-besturingmethoden

Gebruik de methoden addOption, clearOptions, removeOption om opties te bewerken die beschikbaar zijn voor OptionSet-besturingselementen.

addOption

Voegt een optie aan een optiesetbesturingselement toe.

Xrm.Page.getControl(arg).addOption(option, [index])

Belangrijk

Bij deze methode wordt niet gecontroleerd of de waarden in de opties die u toevoegt geldig zijn. Als u ongeldige opties toevoegt, werken ze niet correct. U moet alleen opties toevoegen die zijn gedefinieerd voor het specifieke optiesetkenmerk waar het besturingselement aan verbonden is. Gebruik het kenmerk getOptions of getOption methoden om geldige optieobjecten te krijgen om met deze methode toe te voegen.

  • Argumenten

    • optie
      Type: Object: Een optieobject om aan de OptionSet toe te voegen.

    • index
      Type: Getal: (Optioneel) De indexpositie waarop u de nieuwe optie wilt laten plaatsen. Als deze niet is opgegeven, wordt de optie aan het einde toegevoegd.

clearOptions

Wist alle opties van een optiesetbesturingselement.

Xrm.Page.getControl(arg).clearOptions()

removeOption

Verwijdert een optie uit een optiesetbesturingselement.

Xrm.Page.getControl(arg).removeOption(number)
  • Argumenten
    Type: Getal: De waarde van de optie die u wilt verwijderen.

setFocus

Stel op het besturingselement de focus in.

Xrm.Page.getControl(arg).setFocus()

ShowTime

Gebruik setShowTime om op te geven of een datumbesturingselement het tijdgedeelte van de datum moet weergeven en gebruik getShowTime om te bepalen of het tijdgedeelte van de datum momenteel wordt weergegeven.

getShowTime

Bepaal of een datumbesturingselement het tijdgedeelte van de datum weergeeft.

Besturingselementtypen: standaardbesturingselement voor kenmerken datetime.

var showsTime = Xrm.Page.getControl(arg).getShowTime();

Opmerkingen

Deze methode werd geïntroduceerd met Update 1 voor Microsoft Dynamics CRM Online 2015.

setShowTime

Opgeven of een datumbesturingselement het tijdgedeelte van de datum moet weergeven.

Besturingselementtypen: standaardbesturingselement voor kenmerken datetime.

Xrm.Page.getControl(arg).setShowTime(bool)

Opmerkingen

Deze methode is alleen beschikbaar voor Bijgewerkte entiteiten. Deze methode toont of verbergt het tijdonderdeel van een datumbesturingselement waarbij het kenmerk gebruikmaakt van de DateAndTime-notatie. Deze methode heeft geen uitwerking als de DateOnly-notatie wordt gebruikt.

Methoden voor subrasterbesturingselement

Bij versies vóór Update 1 voor Microsoft Dynamics CRM Online 2015 was refresh de enige methode die beschikbaar was voor een subrasterbesturingselement. Met CRM Online 2015 Update 1 zijn er nieuwe mogelijkheden die u kunt gebruiken.Meer informatie:Rasterobjecten (alleen-lezen) en -methoden (clientreferentie)

refresh

Vernieuwt de gegevens die in een subraster worden weergegeven.

Xrm.Page.getControl(arg).refresh()

Notitie

De vernieuwingsmethode is niet beschikbaar in het formulier Gebeurtenis OnLoad omdat subraster asynchroon worden geladen. Met het subraster Gebeurtenis OnLoad dat in CRM Online 2015 Update 1 werd geïntroduceerd kunt u nu detecteren wanneer het subraster wordt geladen en deze methode gebruiken met gebeurtenishandlers voor die gebeurtenis.

Zichtbaar

Definieer welke besturingselementen zichtbaar of verbergen en ze worden weergegeven die de methoden gebruiken van getVisible en setVisible.

getVisible

Wordt een waarde aan die aangeeft of dit besturingselement zijn zichtbaar is.

Notitie

Als de sectie die of het tabblad dat deze besturingselement bevat niet zichtbaar is, kan deze methode nog steeds true retourneren. Om zich ervan te vergewissen dat het besturingselement zichtbaar is; u moet de zichtbaarheid van de bevattende elementen ook controleren.

Xrm.Page.getControl(arg).getVisible()
  • Retourwaarde
    Type: Boole-waarde.True als het besturingselement zichtbaar is, anders false.

setVisible

Stelt een waarde in die aangeeft of dit besturingselement zichtbaar is.

Xrm.Page.getControl(arg).setVisible(bool)
  • Argumenten
    Type: Boole-waarde.True als het besturingselement zichtbaar moet zijn, anders false.

Notitie

Wanneer u velden selectief aan gebruikers in code worden weergegeven waarvan de gebeurtenis wordt uitgevoerd Onload, adviseren we u om de velden niet zichtbaar configureert als standaard en vervolgens om setVisible(true) te gebruiken om de velden weer te geven wanneer wordt voldaan aan de voorwaarden. Het gebruik van setVisible(false) om velden in de gebeurtenis Onload te verbergen kan ervoor zorgen dat het veld kort zichtbaar is voor de gebruiker voordat het wordt verborgen.

Als u een groter aantal velden met setVisible(false) verbergt, kunt u overwegen deze te groeperen in tabbladen of secties en het tabblad en de sectie in plaats van de afzonderlijke velden verbergen. Dit kan de prestaties verbeteren.

Webresource en IFRAME-BESTURINGSELEMENTMETHODEN

Gebruik deze methoden om te communiceren met webresource- en IFRAME-besturingselementen.

Gegevens

Webresources hebben een speciaal querytekenreeksparameter parameter met de naam data om aangepaste gegevens in te voeren. De methoden getData en setData werken alleen voor Silverlight-webresources die aan een formulier zijn toegevoegd.Meer informatie:Het doorgeven van gegevens vanuit een formulier aan een ingesloten Silverlight-webresource

Voor webpagina (HTML) webresources, kan de gegevensparameter worden geëxtraheerd via de methode getSrc of worden ingesteld met de methode setSrc.

Notitie

De methoden getData en setData worden niet ondersteund voor de interactieve servicehub.

getData

Levert de waarde van de gegevensquery tekenreeksparameter die aan een Silverlight - webresource wordt doorgegeven.

Xrm.Page.getControl(arg).getData()
  • Retourwaarde
    Type: Tekenreeks. De gegevenswaarde doorgegeven aan de Silverlight webresource.

setData

Stelt de waarde van de gegevensquery tekenreeksparameter in die aan een Silverlight - webresource wordt doorgegeven.

Xrm.Page.getControl(arg).setData(string)
  • Argumenten
    Type: Tekenreeks. De gegevenswaarde die moet worden doorgegeven aan de Silverlight webresource.

getInitialUrl

Retourneert de standaard-URL die een IFRAME-besturingselement is geconfigureerd om weer te geven. Deze methode is niet beschikbaar voor webresources.

Xrm.Page.getControl(arg).getInitialUrl()
  • Retourwaarde
    Type: Tekenreeks. Aanvankelijk URL.

getObject

Levert het object in het formulier dat staat voor een Iframe of voor een webresource.

Xrm.Page.getControl(arg).getObject()

  • Retourwaarde
    Type: Object. Welk object is afhankelijk van het type besturingselement.

    Een IFRAME retourneert het IFrame-element vanuit het Document Object Model (DOM).

    Een Silverlight - webresource levert het Object element van het DOM dat de ingesloten Silverlight invoegtoepassing is.

Src

Iframes of webresources hebben een src eigenschap om te bepalen wat ingesloten in het venster wordt weergeven. U kunt de eigenschap src krijgen of wijzigen met behulp van de methoden van getSrc en setSrc.

getSrc

Retourneert de huidige URL die wordt weergegeven in een of IFRAME of webresource.

Xrm.Page.getControl(arg).getSrc()
  • Retourwaarde
    Type: Tekenreeks. Een URL die de eigenschap src van het IFRAME of de webresource aangeeft.

setSrc

Stelt de huidige URL in die moet worden weergegeven in een of IFRAME of webresource.

Xrm.Page.getControl(arg).setSrc(string)
  • Argumenten
    Type: Tekenreeks: de URL.

Zie ook

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

Microsoft Dynamics 365

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht