Del via

Kontrolelementet Xrm.Page.ui (klientsidereference)

  • Artikel

 

Udgivet: januar 2017

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

control indeholder metoder til at ændre præsentationen eller funktionaliteten af et kontrolelement og identificere den tilsvarende attribut.

Du kan få adgang til kontrolelementer ved hjælp af følgende samlinger: Xrm.Page.ui.kontrolelementer, Xrm.Page.ui Section.kontrolelementer eller Xrm.Page.data.entity Attribute.kontrolelementer. Metoden Xrm.Page.getControl er en genvej til at få adgang til Xrm.Page.ui.controls.get.

Syntakseksemplerne i dette emne viser brugen af metoden Xrm.Page.getControl til at få adgang til et objekt. Hvilket kontrolelement afhænger af de argumenter, der sendes til metoden. Parameteren args til at få adgang til et enkelt kontrolelement skal være enten navnet på kontrolelementet eller indekset.

Når en formular viser kontrolelementet for et forretningsprocesforløb i overskriften, føjes yderligere kontrolelementer til hver attribut, der vises i forretningsprocesforløbet. Disse kontrolelementer har et entydigt navn, der ligner følgende eksempel: header_process_<attribute name>.

Bemærk

Kun kontrolelementer i den aktive fase af forretningsprocesforløbet kan åbnes efter navn på denne måde.

Kontrolelementer, der vises i formularhovedet, er tilgængelige og har et entydigt navn som følgende: header_<attribute name>.

For kontrolelementer, der er bundet til attributter, er det almindeligt at få adgang til kontrolelementer gennem samlingen Xrm.Page.data.entity Attribute.kontrolelementer.

De brugerdefinerede kontrolelementer til Dynamics 365-mobilklienter (telefoner og tablets) understøtter alle egenskaber og metoder for kontrolelementer med undtagelse af følgende: Metoder til automatisk fuldførelse, getValue, Metoder med tastetryk og Opslagskontrolelementmetoder og -hændelser.

Med version Opdatering 1 til Microsoft Dynamics CRM Online 2016 og Microsoft Dynamics CRM 2016 Service Pack 1 (det lokale miljø) understøttes de følgende metoder for tidsstyring nu på den nye funktion til formulargengivelse (også kaldet "turboformularer"): getControlType, getName, getParent, Etiket metoder, refresh og Synlig metoder.

Kontrolegenskaber og metoder

  • Metoder til automatisk fuldførelse
    Konfigurere den automatiske fuldførelsesoplevelse i kontrolelementer med tekst i Dynamics 365-formularer. Disse metoder blev introduceret i Dynamics 365.

  • Deaktiveret
    Registrere tilstanden og aktivere eller deaktivere kontrolelementer ved hjælp af metoderne getDisabled og setDisabled.

  • getAttribute
    Hente den attribut, som kontrolelementet er bundet til.

  • getControlType
    Hente oplysninger om typen af kontrolelement.

  • getName
    Hente navnet på kontrolelementet.

  • getParent
    Hente det afsnitsobjekt, som kontrolelementet er i.

  • getValue
    Henter den seneste værdi for et kontrolelement, når brugerne skriver et tegn i et specifik tekst- eller talfelt. Denne metode blev introduceret i Dynamics 365.

  • Metoder med tastetryk
    Tilføj, fjern eller udføre en funktion, når brugeren trykker på en tast i et kontrolelement. Disse metoder blev introduceret i Dynamics 365.

  • Metoder for videnbasekontrolelementer
    Disse metoder er kun tilgængelige for kontrolelementet til søgning i videnbasen i en forekomst af Dynamics 365, hvor vidensstyringsfunktionen er aktiveret.

    Du kan finde oplysninger om dette kontrolelement i Kontrolelement til søgning i videnbasen (klientsidereference).

  • Etiket
    Få eller ændre etiketten for et kontrolelement ved hjælp af metoderne getLabel og setLabel.

  • Opslagskontrolelementmetoder og -hændelser
    Kontrollere de resultater, brugerne kan vælge mellem, når de angiver værdien af et opslagskontrolelement ved hjælp af metoderne addCustomFilter, addCustomView, getDefaultView, setDefaultView.

    Du kan tilføje eller fjerne hændelseshandlere for PreSearch-hændelse ved hjælp af metoderne addPreSearch og removePreSearch.

  • Besked
    Få vist og fjerne beskeder til brugerne om et kontrolelement ved hjælp af metoderne setNotification, addNotification og clearNotification.

  • OptionSet-kontrolelementmetoder
    Ændre de indstillinger, der vises i OptionSet-kontrolelementer, ved hjælp af metoderne addOption, clearOptions, og removeOption.

  • ShowTime
    Brug setShowTime til at angive, om et datokontrolelement skal vise klokkeslætsdelen af datoen, og getShowTime til at bestemme, om klokkeslætsdelen af datoen skal vises.

  • Kontrolelementmetoder til undergitter
    For virksomheder, der anvender Opdatering 1 til CRM Online 2015, findes der nye funktioner til at arbejde med kontrolelementer i undergitre.Flere oplysninger:Skrivebeskyttede gitterobjekter og -metoder (klientsidereference)

    For andre organisationer er refresh metoden den eneste entydige tilgængelige metode for kontrolelementer i undergitre. Denne metode opdaterer de data, som vises i undergitteret.

  • Synlig
    Bestemme, hvilke kontrolelementer der er synlige, og vise eller skjule dem ved hjælp af metoderne getVisible og setVisible.

  • Kontrolelementmetoderne Webressource og IFRAME
    Interaktion med webressource og IFRAME-kontrolelementer ved hjælp af metoderne getData, setData, getInitialUrl, getObject, setSrc og getSrc.

Metoder til automatisk fuldførelse

Brug metoderne showAutoComplete og hideAutoComplete til at konfigurere den automatiske fuldførelsesoplevelse i kontrolelementer med tekst i formularer.

Du kan se en JavaScript-eksempelkode, der viser funktionen til automatisk fuldførelse, i Eksempel: Udfylde automatisk i Dynamics 365-kontrolelementer

Bemærk

Disse metoder understøttes ikke for Dynamics 365-mobilklienter (telefoner eller tablets) og den interaktive tjenestehub. Disse metoder er kun tilgængelige for Opdaterede objekter.

showAutoComplete

Brug denne funktion til at vise op til 10 matchende strenge på en rulleliste, når brugerne trykker på taster for at skrive tegn i et bestemt felt. Du kan også tilføje en tilpasset kommando med et ikon nederst på rullelisten. Når du vælger et element i rullelisten, ændres værdien i tekstfeltet til det valgte element, rullelisten forsvinder, og Hændelsen OnChange for tekstfeltet aktiveres.

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

  • Parameter
    Type: Objekt, der definerer det resultatsæt, som omfatter results og commands, der skal vises i rullelisten for automatisk fuldførelse.

    Bemærkninger: Kald denne metode i en funktion, du har tilføjet ved hjælp af addOnKeyPress-metoden, for at køre den på keypress-hændelsen.

    Eksempel: Følgende eksempel viser definitionen af det objekt, der skal overføres til showAutoComplete-metoden.

    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

Brug denne funktion til at skjule rullelisten for den automatiske fuldførelse, du har konfigureret for et bestemt tekstfelt.

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

Bemærk

Du behøver ikke at bruge den specifikke hideAutoComplete-metode, fordi som standard skjules rullelisten automatisk, hvis brugeren klikker et andet sted, eller hvis en ny rulleliste vises. Denne funktion er tilgængelig i tilfælde af, at udviklere er nødt til at skjule rullelisten for automatisk fuldførelse for at håndtere et brugerdefineret scenario.

Deaktiveret

Brug getDisabled og setDisabled til at registrere, om et kontrolelement er deaktiveret eller for at aktivere eller deaktivere det.

Kontrolelementtyper: standard, opslag, optionset.

getDisabled

Returnerer, om kontrolelementet er deaktiveret.

Xrm.Page.getControl(arg).getDisabled()
  • Returværdi
    Type: Boolesk værdi. Sand, hvis kontrolelementet er deaktiveret, ellers falsk.

setDisabled

Angiver, om kontrolelementet er deaktiveret.

Xrm.Page.getControl(arg).setDisabled(bool)
  • Argumenter
    Type: Boolesk værdi. Sand, hvis kontrolelementet skulle være deaktiveret, ellers falsk.

getAttribute

Returnerer den attribut, som kontrolelementet er bundet til.

Kontrolelementtyper: standard, opslag, optionset.

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

Bemærk

Kontrolelementer, der ikke er bundet til en attribut (undergitter, webressource og IFRAME), har ikke denne metode. Der udløses en fejl, hvis du forsøger at bruge denne metode på et af disse kontrolelementer.

  • Returværdi
    Type: objekt: en attribut.

Bemærkninger

Konstituentkontrolelementerne i et kontrolelement til hurtig visning er indeholdt i kontrolelementsamlingen, og disse kontrolelementer har metoden getAttribute. Attributten er dog ikke en del af objektets attributsamling. Selvom du kan hente værdien for denne attribut ved hjælp af getValue og eventuelt ændre værdien ved hjælp af setValue, bliver de ændringer, du foretager, ikke gemt sammen med objektet.

Nedenstående kode viser brugen af værdien af kontaktattributten mobilephone, når den vises på en firmaobjektformular ved hjælp af et kontrolelement til hurtig visning med navnet contactQuickForm. Denne kode skjuler kontrolelementet, når værdien af attributten er null.

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

getControlType

Returnerer en værdi, der inddeler kontrolelementer.

Kontrolelementtyper: alle.

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

  • Returværdi
    Type: streng

    Mulige returværdier for getControlType:

    Returværdi

    Beskrivelse

    standard

    Et standardkontrolelement.

    iframe

    Et IFRAME-kontrolelement

    lookup

    Et opslagskontrolelement.

    optionset

    Et OptionSet-kontrolelement.

    subgrid

    Et undergitterkontrolelement.

    webresource

    Et webressourcekontrolelement.

    notes

    Et notekontrolelement.

    timercontrol

    En tidsstyring.

    kbsearch

    Et kontrolelement til søgning i videnbasen.

    customControl: <navneområde>.<navn>

    Et brugerdefineret kontrolelement til Dynamics 365-mobilklienter (telefoner og tablets).

    customsubgrid:<navneområde>.<navn>

    Et brugerdefineret datasæt til Dynamics 365-mobilklienter (telefoner og tablets).

getName

Returnerer det navn, der er tildelt til kontrolelementet.

Bemærk

Det navn, der er tildelt til et kontrolelement, bestemmes først, når formularen indlæses. Ændringer i formularen kan ændre det navn, der er tildelt til et bestemt kontrolelement.

Kontrolelementtyper: alle.

Xrm.Page.getControl(arg).getName()
  • Returværdi
    Type: streng. Navnet på kontrolelementet.

getParent

Returnerer en reference til det afsnitsobjekt, der indeholder kontrolelementet.

Kontrolelementtyper: alle.

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

getValue

Henter den seneste værdi i et kontrolelement, når brugeren skriver tegn i et specifikt tekst- eller talfelt. Denne metode hjælper dig med at bygge interaktive oplevelser ved at validere data og advare brugerne, når de skriver tegn i et kontrolelement.

getValue-metoden adskiller sig fra getValue-attributmetoden, fordi kontrolelementmetoden henter værdien fra kontrolelementet, mens brugeren skriver i kontrolelementet, i modsætning til getValue-attributmetoden, der henter værdien, når brugeren har bekræftet (gemt) feltet.

Bemærk

Denne metode understøttes ikke for Dynamics 365-mobilklienter (telefoner eller tablets) og er kun tilgængelige for Opdaterede objekter.

Du kan se en JavaScript-eksempelkode, der bruger getValue-metoden til at konfigurere den automatisk fuldførelse oplevelse, under Eksempel: Udfylde automatisk i Dynamics 365-kontrolelementer.

Xrm.Page.getControl(arg).getValue()
  • Returværdi
    Type: streng. Den seneste dataværdi for et kontrolelement.

Metoder med tastetryk

Brug metoderne addOnKeyPress, removeOnKeyPress og fireOnKeyPress til at give umiddelbar feedback eller udføre handlinger, når brugeren skriver i et kontrolelement. Med disse metoder kan du foretage datavalideringer i et kontrolelement, selv før brugeren bekræfter (gemmer) værdien i en formular.

Bemærk

Disse metoder understøttes ikke for Dynamics 365-mobilklienter (telefoner eller tablets) og er kun tilgængelige for Opdaterede objekter.

addOnKeyPress

Bruges til at tilføje en funktion som en hændelseshandler for tastetrykhændelsen, så funktionen kaldes, når du skriver et tegn i et bestemt tekst- eller talfelt.

Du kan se en JavaScript-eksempelkode, der bruger addOnKeyPress-metoden til at konfigurere den automatisk fuldførelse oplevelse, under Eksempel: Udfylde automatisk i Dynamics 365-kontrolelementer.

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

  • Parameter
    Type: funktionsreference

    Bemærkninger: Funktionen føjes til bunden af hændelseshandlerens pipeline. Kørselskonteksten indstilles automatisk til at være den første parameter, der overføres til hændelseshandleren, som angives ved hjælp af denne metode.Flere oplysninger:Kontekst for udførelse (klientsidereference)

    Du skal bruge en reference til en navngivet funktion i stedet for en anonym funktion, hvis du senere evt. vil fjerne hændelseshandleren for feltet.

removeOnKeyPress

Bruges til at fjerne en hændelseshandler til et tekst- eller talfelt i CRM, som du har tilføjet ved hjælp af addOnKeyPress.

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

  • Parameter
    Type: funktionsreference

    Bemærkninger: Hvis en anonym funktion indstilles ved hjælp af addOnKeyPress, kan den ikke fjernes ved hjælp af denne metode.

fireOnKeyPress

Bruges til manuelt at aktivere en hændelseshandler, du har oprettet til et bestemt tekst- eller talfelt, som skal udføres ved keypress-hændelsen.

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

Metoder for videnbasekontrolelementer

Disse metoder er kun tilgængelige for kontrolelementet til søgning i videnbasen, som er tilgængeligt, når Dynamics 365-organisationen er aktiveret for vidensstyringsfunktionen. Du kan finde oplysninger om disse kontrolelementer under Kontrolelement til søgning i videnbasen (klientsidereference).

Etiket

Få eller ændre etiketten for et kontrolelement ved hjælp af metoderne getLabel og setLabel.

Kontrolelementtyper: alle.

getLabel

Returnerer etiketten for kontrolelementet.

Xrm.Page.getControl(arg).getLabel()
  • Returværdi
    Type: streng. Etiketten på kontrolelementet.

setLabel

Angiver etiketten for kontrolelementet.

Xrm.Page.getControl(arg).setLabel(label)
  • Argumenter
    Type: streng. Den nye etiket for kontrolelementet.

Opslagskontrolelementmetoder og -hændelser

Kontrollere de resultater, brugerne kan vælge mellem, når de angiver værdien af et opslagskontrolelement ved hjælp af metoderne addCustomFilter, addCustomView, getDefaultView og setDefaultView.Lookup-kontrolelementet viser også PreSearch-hændelse så du via programmering kan tilføje hændelseshandlere ved hjælp af metoderne addPreSearch og removePreSearch.

Kontrolelementtyper: opslag.

addCustomFilter

Brug til at føje filtre til de resultater, der vises i opslaget. Hvert filter kan kombineres med alle de filtre, der tidligere er tilføjet som en "AND"-betingelse.

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

  • Argumenter

    • filterXml
      Type: streng: fetchXml-filterelement, der skal anvendes. Eksempel:

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

    • entityLogicalName
      Type: streng: (valgfrit) Hvis det er angivet, gælder filteret kun til den pågældende objekttype. Ellers gælder det for alle typer objekter, der er returneret.

  • Bemærkninger
    Flere oplysninger:FetchXML schema.

    Denne metode er kun tilgængelig for Opdaterede objekter.

    Denne metode kan kun bruges i en funktion i en hændelseshandler for Hændelsen PreSearch for Opslagskontrolelement.

    Følgende kodeeksempel er til opslag i salgsmulighedsformularen Firma (parentaccountid). Når funktionen Sdk.setParentAccountIdFilter er angivet i formularhændelseshandleren Onload, føjes funktionen Sdk.filterCustomAccounts til hændelsen PreSearch for dette opslag. Resultatet er, at kun konti med kategori (accountcategorycode)-værdien Foretrukken kunde (1) returneres.

    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

Tilføjer en ny visning i opslagsdialogboksen.

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

  • Argumenter

    • viewId
      Type:streng: strengrepræsentation af et GUID for en visning.

      Bemærk

      Denne værdi bliver aldrig gemt og skal kun være entydig blandt de andre tilgængelige visninger for opslaget. En streng til en ugyldig GUID fungerer, for eksempel "{00000000-0000-0000-0000-000000000001}". Det anbefales, at du bruger et værktøj som f.eks. guidgen.exe til at generere en gyldig GUID. Værktøjet guidgen.exe indgår i Windows SDK.

    • entityName
      Type: streng: navnet på objektet.

    • viewDisplayName
      Type: streng: navnet på visningen.

    • fetchXml
      Streng: fetchXml-forespørgslen for visningen.

    • layoutXml
      Type:streng: Den XML, der definerer visningens layout.

    • isdefault
      Type: boolesk: Om visningen skal være standardvisning.

  • Bemærkninger
    Denne metode fungerer ikke sammen med opslag på ejer. Ejeropslag bruges til at tildele brugerejede poster.

DefaultView

Du kan registrere, hvilken visning der er standardvisningen, som vises, så brugerne kan vælge poster i et opslag, og ændre standardvisningen ved hjælp af getDefaultView og setDefaultView.

getDefaultView

Returnerer id-værdien for standardvisningen af opslagsdialogboksen.

Xrm.Page.getControl(arg).getDefaultView()
  • Returværdi
    Type: streng. Id-værdien er standardvisningen.

setDefaultView

Angiver standardvisningen for kontrolelementet til opslagsdialogboksen.

Xrm.Page.getControl(arg).setDefaultView(viewGuid)
  • Argumenter
    Type: streng. Id'et for visningen, der skal angives som standardvisning.

Eksempel: Denne setDefaultViewSample-funktion indstiller account-objektformularens primære kontaktpersoners standardvisning for opslag til visningen Mine aktive kontakter.

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

PreSearch-hændelse

Du kan tilføje eller fjerne hændelseshandlere for Hændelsen PreSearch for Opslagskontrolelement ved hjælp af metoderne addPreSearch og removePreSearch.

Brug hændelsen PreSearch til at kontrollere, hvilke resultater der vises for kontrolelementet ved brug af de aktuelle formulardata, når brugeren begynder at søge efter poster.

Begge metoder har Kontekst for udførelse (klientsidereference) angivet som den første parameter.

addPreSearch

Brug denne metode til at anvende ændringer på opslag, der er baseret på de aktuelle værdier, lige før brugeren er ved at få vist resultaterne af opslaget.

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

  • Argumenter
    Type: funktion, der skal tilføjes.

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

Argumentet er en funktion, der vil blive kørt, lige før søgningen, der skal levere resultater for et opslag, foretages. Du kan bruge denne handler til at kalde en af de andre kontrolelementfunktioner til opslag og forbedre resultaterne, der skal vises i opslaget.

removePreSearch

Brug denne metode til at fjerne hændelseshandlerfunktioner, der tidligere er angivet for hændelsen PreSearch.

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

  • Argumenter
    Type: funktion, der skal fjernes.

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

Besked

Brug disse metoder til at få vist og slette beskeder for et kontrolelement.

setNotification

Viser en fejlmeddelelse for kontrolelementet for at angive, at data ikke er gyldige. Når denne metode anvendes, vises et rødt "X"-ikon ved siden af kontrolelementet. Når du klikker på ikonet, vises meddelelsen på Dynamics 365-mobilklienter.

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

Bemærkninger

Hvis du angiver en fejlmeddelelse for et kontrolelement, blokeres lagring af formularen.

Denne metode er kun tilgængelig for Opdaterede objekter.

Argumenter

  • meddelelse
    Type: streng: Meddelelse, der skal vises.

  • uniqueId
    Type: streng: Id'et bruges til at fjerne netop denne meddelelse, når du bruger clearNotification. Valgfrit.

Returværdi

Type: boolesk: Angiver, om metoden lykkedes.

addNotification

Viser en besked om fejl eller anbefalinger for et kontrolelement og lader dig angive handlinger, der skal køres ud fra anmeldelsen. Når du angiver en af fejltypemeddelelse, vises et rødt "X"-ikon ved siden af kontrolelementet. Når du angiver en af anbefalingstype, vises et "i"-ikon ved siden af kontrolelementet. Når du trykker på ikonet på Dynamics 365-mobilklienter, vises meddelelsen, og du kan udføre den konfigurerede handling ved at klikke på knappen Anvend eller afvise meddelelsen.

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

Bemærkninger

Angivelse af en fejlmeddelelse for et kontrolelement blokerer lagring af formularen, mens angivelse af en anmeldelsesmeddelelse ikke blokerer lagring af formularen.

Denne metode blev introduceret i December 2016 – opdatering til Dynamics 365 (online og det lokale miljø) og er kun tilgængelig for Opdaterede objekter.

Argumenter

Metoden accepterer et objekt med følgende attributter:

Attribut

Datatype

Krævet

Beskrivelse

messages

Matrix

Ja

Meddelelsen, der vises i meddelelsen. I den aktuelle version vises kun den første meddelelse, der er angivet i denne matrix. Den streng, du angiver her, vises med fed skrift i meddelelsen og bruges typisk til titlen eller emnet for anmeldelsen. Du bør begrænse din meddelelse til 50 tegn for at optimere brugeroplevelsen.

notificationLevel

Streng

Nej

Definerer typen af meddelelse. Gyldige værdier er ERROR eller RECOMMENDATION. Hvis du ikke angiver denne attribut i object-definitionen, angives den som standard til ERROR.

uniqueId

Streng

Nej

Det id, der skal bruges til at fjerne denne meddelelse, når du bruger clearNotification.

actions

Matrix for objekter

Nej

En samling af objekter med følgende attributter:

  • message: Streng. Sekundær meddelelse eller tekstmeddelelse om den meddelelse, der skal vises for brugeren. Begrænse din meddelelse til 100 tegn for at optimere brugeroplevelsen.

  • actions: Matrix. Tilsvarende handlinger for meddelelsen.

I den nuværende version understøttes kun enkelt brødtekstmeddelelse og en tilsvarende handling. Du kan dog definere flere opgaver, der skal udføres ved hjælp af JavaScript-kode i handlingsblokken.

Bemærk

addNotification-metoden viser en meddelelse om de meddelelser, du har angivet og to standardknapper: Anvend og Afvis. Hvis du klikker på Anvend, udføres den handling, du har defineret, og hvis du klikker på Afvis, lukkes meddelelsen.

Returværdi

Type: boolesk: Angiver, om metoden lykkedes.

Eksempel

Følgende eksempelkode viser en meddelelse i feltet Firmanavn i firmaformularen for at angive Aktiesymbol, hvis feltet Kontonavn indeholder "Microsoft". Hvis du klikker på Anvend i meddelelsen, indstilles feltet Aktiesymbol til "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

Fjern en meddelelse, som allerede vises for et kontrolelement.

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

Argumenter

  • uniqueId
    Type: Streng: Id'et bruges til at fjerne en bestemt meddelelse, der blev angivet med setNotification eller addNotification.

    Hvis parameteren uniqueId ikke er angivet, fjernes den aktuelle viste meddelelse.

Bemærkninger

Denne metode er kun tilgængelig for Opdaterede objekter.

Returværdi

Type: boolesk: Angiver, om metoden lykkedes.

OptionSet-kontrolelementmetoder

Brug metoderne addOption, clearOptions og removeOption til at manipulere tilgængelige indstillinger for OptionSet-kontrolelementer.

addOption

Tilføjer en indstilling til en grupperet indstilling.

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

Vigtigt

Denne metode kontrollerer ikke, om værdierne i de indstillinger, du tilføjer, er gyldige. Hvis du tilføjer ugyldige indstillinger, fungerer de ikke korrekt. Du skal kun tilføje indstillinger, der er defineret for den specifikke attribut for grupperet indstilling, som kontrolelementet er bundet til. Brug attributten getOptions eller metoderne getOption til at få objekter med gyldig indstilling, der kan tilføjes ved hjælp af denne metode.

  • Argumenter

    • indstilling
      Type: objekt: et indstillingsobjekt, der skal føjes til OptionSet.

    • indeks
      Type: Tal: (valgfrit) indeksplacering til placering af den nye indstilling i. Hvis den ikke er angivet, føjes indstillingen til slutningen.

clearOptions

Rydder alle indstillingerne fra et kontrolelement for en grupperet indstilling.

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

removeOption

Fjerner en indstilling fra et kontrolelement for en grupperet indstilling.

Xrm.Page.getControl(arg).removeOption(number)
  • Argumenter
    Type: tal: værdien af den indstilling, du vil fjerne.

setFocus

Sætter fokus på kontrolelementet.

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

ShowTime

Brug setShowTime til at angive, om et datokontrolelement skal vise klokkeslætsdelen af datoen, og brug getShowTime til at bestemme, om klokkeslætsdelen af datoen skal vises.

getShowTime

Få at vide, om et datokontrolelement viser klokkeslætsdelen af datoen.

Kontroltyper: standardkontrolelement for datetime-attributter.

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

Bemærkninger

Denne metode blev introduceret i Opdatering 1 til Microsoft Dynamics CRM Online 2015.

setShowTime

Angiv, om et kontrolelement til dato skal vise klokkeslætsdelen af datoen.

Kontroltyper: standardkontrolelement for datetime-attributter.

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

Bemærkninger

Denne metode er kun tilgængelig for Opdaterede objekter. Denne metode viser eller skjuler klokkeslætskomponenten i et datokontrolelement, hvor attributten bruger DateAndTime-formatet. Denne metode har ingen funktion, når DateOnly-formatet bruges.

Kontrolelementmetoder til undergitter

For versioner før Opdatering 1 til Microsoft Dynamics CRM Online 2015 er den eneste metode, der er tilgængelig for et kontrolelement i et undergitter refresh. I Opdatering 1 til CRM Online 2015 er der nye funktioner, som du kan bruge.Flere oplysninger:Skrivebeskyttede gitterobjekter og -metoder (klientsidereference)

refresh

Opdaterer de data, som vises i et undergitter

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

Bemærk

Opdateringsmetoden er ikke tilgængelig i formularen OnLoad-hændelse, fordi undergitre indlæses asynkront. Med undergitteret OnLoad-hændelse, der blev introduceret i Opdatering 1 til CRM Online 2015, kan du nu registrere, når gitteret er indlæst, og bruge denne metode med hændelseshandlere til denne hændelse.

Synlig

Bestemme, hvilke kontrolelementer der er synlige, og vise eller skjule dem ved hjælp af metoderne getVisible og setVisible.

getVisible

Returnerer en værdi, der angiver, om kontrolelementet er synligt i øjeblikket.

Bemærk

Hvis afsnittet eller fanen for dette kontrolelement ikke er synlig, kan denne metode stadig returnere true. For at sikre, at kontrolelementet faktisk er synligt, skal du også kontrollere synligheden af de indeholdte elementer.

Xrm.Page.getControl(arg).getVisible()
  • Returværdi
    Type: Boolesk værdi.True hvis kontrolelementet er synligt, ellers false.

setVisible

Angiver en værdi, der angiver, om kontrolelementet er synligt.

Xrm.Page.getControl(arg).setVisible(bool)
  • Argumenter
    Type: Boolesk værdi.True hvis kontrolelementet skulle være synligt, ellers false.

Bemærk

Når du selektivt får vist felter til brugere i kode, der kører i hændelsen Onload, anbefaler vi, at du som standard konfigurerer felterne til ikke at være synlige og derefter bruger setVisible(true) til at vise felterne, når betingelserne er rigtige. Når du bruger setVisible(false) til at skjule felter i hændelsen Onload, kan det resultere i, at feltet kort vises til brugeren, før det skjules.

Hvis du skjuler et større antal felter ved hjælp af setVisible(false), skal du overveje, om du kan gruppere dem sammen i faner eller afsnit og skjule fanen eller afsnittet i stedet for de enkelte felter. Dette kan forbedre ydeevnen.

Kontrolelementmetoderne Webressource og IFRAME

Brug disse metoder til at kommunikere med kontrolelementerne Webressource og IFRAME.

Data

Webressourcer har en speciel forespørgselsstrengparameter med navnet data til at sende brugerdefinerede data. Metoderne getData og setData fungerer kun for Silverlight-webressourcer, der er føjet til en formular.Flere oplysninger:Overføre data fra en formular til en integreret Silverlight-webressource

Til webressourcer på websider (HTML) kan parameteren udtrækkes fra metoden getSrc eller angives med metoden setSrc.

Bemærk

Metoderne getData og setData understøttes ikke for den interaktive tjenestehub.

getData

Returnerer parameterværdien for den dataforespørgselsstreng, der blev sendt til en Silverlight-webressource.

Xrm.Page.getControl(arg).getData()
  • Returværdi
    Type: streng. Dataværdien, der overføres til webressourcen Silverlight.

setData

Angiver parameterværdien for den dataforespørgselsstreng, der sendes til en Silverlight-webressource.

Xrm.Page.getControl(arg).setData(string)
  • Argumenter
    Type: streng. Dataværdien, der skal overføres til webressourcen Silverlight.

getInitialUrl

Returnerer den standard-URL, som et IFRAME-kontrolelement er konfigureret til at vise. Denne metode er ikke tilgængelig for webressourcer.

Xrm.Page.getControl(arg).getInitialUrl()
  • Returværdi
    Type: streng. Den oprindelige URL-adresse.

getObject

Returnerer det objekt i formularen, som repræsenterer en IFRAME eller webressource.

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

  • Returværdi
    Type: objekt. Hvilket objekt afhænger af typen kontrolelement.

    En IFRAME returnerer elementet IFrame fra Document Object Model (DOM).

    En Silverlight-webressource returnerer elementet Object fra den DOM, der repræsenterer det integrerede Silverlight-plug-in.

Src

IFRAMEs eller webressourcer har en src-egenskab til at definere, hvad der skal vises i det integrerede vindue. Du kan hente eller ændre egenskaben src ved hjælp af metoderne getSrc og setSrc.

getSrc

Returnerer den aktuelle URL, der vises i en IFRAME eller webressource.

Xrm.Page.getControl(arg).getSrc()
  • Returværdi
    Type: streng. En URL, der repræsenterer egenskaben src for IFRAME eller webressourcen.

setSrc

Angiver den URL, der vises i en IFRAME eller webressource.

Xrm.Page.getControl(arg).setSrc(string)
  • Argumenter
    Type: streng: URL.

Se også

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

Microsoft Dynamics 365

© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret