Xrm.Utility (klientsidereference)

  • Artikel

 

Udgivet: november 2016

Gælder for: Dynamics CRM 2015

Med objektet Xrm.Utility får du en beholder til nyttige funktioner, der ikke er direkte relateret til den aktuelle side.

Disse funktioner er tilgængelige på hver side i programmet, der understøtter scripting. Du kan bruge dem i formularscripts eller kommandoer på båndet. For HTML-webressourcer er de tilgængelige, når du medtager siden ClientGlobalContext.js.aspx. Du kan finde flere oplysninger under GetGlobalContext-funktion og ClientGlobalContext.js.aspx (klientsidreference).

Funktioner

  • Dialogbokse
    Brug visningsmeddelelserne alertDialog og confirmDialog til brugere, og indstil kode til at køre baseret på deres svar. Disse funktioner skal bruges sammen med Microsoft Dynamics CRM til tablets i stedet for metoderne window.alert og window.confirm.

  • isActivityType
    Afgør, om et objekt er et aktivitetsobjekt.

  • openEntityForm
    Åbner en objektformular.

  • openQuickCreate
    Til Opdatering 1 til Microsoft Dynamics CRM Online 2015 eller senere kan du bruge denne funktion til at åbne en ny formular til hurtig oprettelse. Du kan bruge denne funktion til at indstille standardværdier ved hjælp af attributtilknytninger eller til bestemte attributter. Hvis brugeren gemmer posten, kan du hente en reference til den post, der er oprettet.

  • openWebResource
    Åbner en HTML-webressource.

Dialogbokse

Der findes to dialogtyper: alertDialog og confirmDialog. Disse medtages til brug sammen med scripts, der fungerer med Microsoft Dynamics CRM til tablets.CRM til tablets tillader ikke brug af JavaScript-funktioner, der blokerer kodestrømmen såsom window.alert og window.confirm. Du kan bruge disse metoder i stedet for de andre metoder, hvis du vil vise en meddelelse for brugeren. Den vigtigste forskel er, at disse metoder ikke blokerer kode, før en bruger lukker dem. De indeholder en parameter til en tilbagekaldsfunktion for at angive, hvilken kode skal køres, afhængigt af brugerens svar.

Bemærk

I Microsoft Dynamics CRM til tablets tilsidesættes enhver brug af metoden window.alert, og i stedet bruges Xrm.Utility.alertDialog uden tilbagekald. Dette viser meddelelsen, men vil ikke blokere for kørsel af kode, sådan som window.alert gør. Denne tilknytning af window.alert til Xrm.Utility.alertDialog i CRM til tablets er forældet og vil blive fjernet i den næste større frigivelse. Du skal overføre al kode, du har i dag, for at bruge Xrm.Utility.alertDialog frem for window.alert.

alertDialog

Viser en dialogboks med en meddelelse, der er defineret af programmet.

Xrm.Utility.alertDialog(message,onCloseCallback)

  • Parametre

    Navn

    Type

    Krævet

    Beskrivelse

    meddelelse

    Streng

    Ja

    Teksten i meddelelsen, der skal vises i dialogboksen.

    onCloseCallback

    Funktion

    Nej

    En funktion, der skal køres, når der klikkes på knappen OK.

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

confirmDialog

Viser en bekræftelsesdialogboks, der indeholder en valgfri meddelelse og knapperne OK og Annuller.

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

  • Parametre

    Navn

    Type

    Krævet

    Beskrivelse

    meddelelse

    Streng

    Ja

    Teksten i meddelelsen, der skal vises i dialogboksen.

    yesCloseCallback

    Funktion

    Nej

    En funktion, der skal køres, når der klikkes på knappen OK.

    noCloseCallback

    Funktion

    Nej

    En funktion, der skal køres, når der klikkes på knappen Annuller.

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

isActivityType

Afgør, om et objekt er et aktivitetsobjekt.

Xrm.Utility.isActivityType(entityName)

  • Parameter

    Navn

    Type

    Krævet

    Beskrivelse

    entityName

    Streng

    Ja

    Det logiske navn på et objekt.

  • Returværdi

    Type

    Beskrivelse

    Boolesk

    Sand, hvis objektet er et aktivitetsobjekt, ellers falsk.

openEntityForm

Åbner en objektformular for en ny eller eksisterende objektpost ved hjælp af de indstillinger, du angiver som parametre.

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

  • Parametre

    Navn

    Type

    Krævet

    Beskrivelse

    navn

    Streng

    Ja

    Det logiske navn på objektet.

    id

    Streng

    Nej

    Strengrepræsentation af et entydigt id eller posten, der skal åbnes i formularen. Hvis den ikke er indstillet, åbnes en formular, hvor der kan oprettes en ny post.

    parameters

    Objekt

    Nej

    Et ordbogsobjekt, der sender ekstra parametre til formularen. Ugyldige parametre vil medføre en fejl.

    Gyldig ekstra parametre for forespørgselsstrengen er:

    windowOptions

    Objekt

    Nej

    I Opdatering 1 til Microsoft Dynamics CRM Online 2015 eller senere kan du bruge denne valgfrie parameter i webprogrammet til at styre, hvordan formularen åbnes. Du kan vælge at åbne en formular i et nyt vindue ved at overføre et ordbogsobjekt med en boolesk openInNewWindow-egenskab indstillet til true.

    Denne parameter ignoreres i CRM til tablets og CRM til telefoner.

  • Bemærkninger
    Denne funktion sikrer, at brugerne under visse omstændigheder ikke bliver bedt om at logge på igen.

  • Eksempler
    Åbn en ny firmapost ved hjælp af standardformularen

    Xrm.Utility.openEntityForm("account");

    Åbn en eksisterende firmapost ved hjælp af standardformularen

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

    Åbne en ny firmapost med en bestemt formular og angive standardværdier

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

    Åbn en ny firmapost ved hjælp af standardformularen i et nyt vindue

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

openQuickCreate

Til Opdatering 1 til Microsoft Dynamics CRM Online 2015 eller senere kan du bruge denne funktion til at åbne en ny formular til hurtig oprettelse. Du kan bruge denne funktion til at indstille standardværdier ved hjælp af attributtilknytninger eller til bestemte attributter. Hvis brugeren gemmer posten, kan du hente en reference til den post, der er oprettet.

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

  • Parametre

    Navn

    Type

    Krævet

    Beskrivelse

    entityLogicalName

    Streng

    Ja

    Det logiske navn på objektet, der skal oprettes.

    createFromEntity

    Opslag

    Nej

    Angiver en post, der angiver standardværdier baseret på tilknyttede attributværdier.

    Et opslagsobjekt har følgende String-egenskaber:

    • entityType: Det logiske navn på objektet.

    • id: En strengrepræsentation af en GUID-værdi for posten.

    • name: Værdien af den primære attribut for posten.

    parameters

    Objekt

    Nej

    Et ordbogsobjekt, der sender ekstra parametre for forespørgselsstrenge til formularen. Ugyldige parametre for forespørgselsstrenge vil medføre en fejl.

    Gyldig ekstra parametre for forespørgselsstrengen er:

    successCallback

    Funktion

    Nej

    Den funktion, der skal kaldes, når en post oprettes. Denne funktion sender et objekt som en parameter. Dette objekt har savedEntityReference-egenskab med følgende egenskaber, der identificerer den post, der er oprettet:

    • entityType: Det logiske navn på objektet.

    • id: En strengrepræsentation af en GUID-værdi for posten.

    • name: Værdien af den primære attribut for den oprettede post.

    errorCallback

    Funktion

    Nej

    En funktion, der kaldes, når handlingen ikke kan udføres.

    Et objekt med følgende egenskaber overføres:

    • errorCode: Number. Fejlkoden.

    • message: String. En lokaliseret fejlmeddelelse.

  • Bemærkninger
    Denne funktion er kun tilgængelig for Opdatering 1 til Microsoft Dynamics CRM Online 2015 eller nyere.

    Der er en grænse på 10 indlejrede formularer til hurtig oprettelse i webprogrammet. Hvis denne grænse overskrides, åbner denne funktion den komplette objektformular i stedet for formularen til hurtig oprettelse.

  • Eksempel
    Når denne kode køres i en firmaobjektformular, kan en formular til hurtig oprettelse oprette et nyt underordnet firma med et standardnavn, som er indstillet til at omfatte navnet på det overordnede firma.

    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);
});

    Når denne kode køres med browserudviklerværktøjer (F12 funktioner), repræsenterer følgende outputtet til konsollen, når det køres i forbindelse med et firma med navnet 'A. Datum Corporation (sample)', og brugeren ikke ændrer det standardnavn, der er angivet for det nye underordnede firma.

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

openWebResource

Åbner en HTML-webressource.

Bemærk

Denne funktion fungerer ikke sammen med Microsoft Dynamics CRM til tablets.

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

  • Parametre

    Navn

    Type

    Krævet

    Beskrivelse

    webResourceName

    Streng

    Ja

    Navnet på den HTML-webressource, der skal åbnes.

    webResourceData

    Streng

    Nej

    Data, der skal overføres til dataparameteren.

    bredde

    Antal

    Nej

    Bredden på vinduet, der skal åbnes, i pixel.

    height

    Antal

    Nej

    Højden på vinduet, der skal åbnes, i pixel.

  • Returværdi
    Vinduesobjekt.

  • Bemærkninger
    En HTML-webressource kan acceptere de parameterværdier, der er beskrevet i Videreføre parametre til HTML-webressourcer. Denne funktion er kun til overførsel i den valgfrie dataparameter. Hvis du vil overføre værdier for de andre gyldige parametre, skal du føje dem til webResourceName-parameteren.

  • Eksempler
    Åbn en HTML-webressource med navnet "new_webResource.htm"

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

    Åbn en HTML-webressource, herunder et enkelt dataelement for dataparameteren

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

    Åbn en HTML-webressource, som overfører flere værdier via dataparameteren

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

    Bemærk

    Disse værdier skal trækkes ud fra værdien af dataparameteren i HTML-webressourcen. Du kan finde flere oplysninger under Eksempel: Send flere værdier til en webressource via dataparameteren

    Åbn en HTML-webressource med parametrene, der forventes af HTML-webressourcer

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

    Du kan finde flere oplysninger under Videreføre parametre til HTML-webressourcer.

    Åbn en HTML-webressource, der indstiller højde og bredde

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

Se også

Programmeringsreference på klientsiden
Åbne formularer, visninger, dialogbokse og rapporter med en URL-adresse
Angiv feltværdier vha. parametre, der overføres til en formular
Konfigurere en formular for at acceptere brugerdefinerede forespørgselsstrengparametre
Formularscripter - hurtig henvisning
Skrive kode til Microsoft Dynamics CRM 2015-formularer
Bruge Xrm.Page-objektmodel

© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret