openForm (kliendi API viide)

Avab olemivormi või kiirloomise vormi.

Märkus.

Põhivormi avamiseks dialoogina kasutage meetodit navigateTo (Liigu meetodini). Lisateave: Põhivormi avamine dialoogis kliendi API abil

Süntaks

Xrm.Navigation.openForm(entityFormOptions, formParameters).then(successCallback, errorCallback);

Parameetrid

Nimi	Liik	Nõutav	Kirjeldus
entityFormOptions	Ese	Jah	Vormi avamise vormisuvandid. Kuva entityFormOptions-objekt
formParameters	Ese	Ei	Sõnastikuobjekt, mis edastab vormile lisaparameetreid. Kehtetud parameetrid põhjustavad vea. Lisateavet vormile parameetrite edastamise kohta leiate teemadest Veeruväärtuste seadmine vormile edastatud parameetrite abil ja Vormi konfigureerimine kohandatud päringustringi parameetrite aktsepteerimiseks.
successCallback	Function	Ei	Funktsioon, mis käivitatakse kirje salvestamisel kiirvormil. See funktsioon edastatakse objekti parameetrina. Objektil on savedEntityReference kuvatava(te) või loodud kirjete tuvastamiseks järgmiste atribuutidega massiiv: - entityType: Tabeli loogiline nimi. - id: Kirje GUID-väärtuse stringkuju. - name: Kuvatava või loodud kirje esmane veeruväärtus. MÄRKUS. - Funktsiooni successCallback ei käivitata, kui avate olemasoleva või uue kirje vormi. - Funktsioon successCallback käivitatakse ainult siis, kui salvestate kirje kiirkujul, mis avati meetodi openForm abil.
errorCallback	Function	Ei	Funktsioon, mis käivitatakse, kui toiming nurjub.

entityFormOptions object

Objekt sisaldab järgmisi väärtusi:

Nimi	Liik	Nõutav	Kirjeldus
entityName	String	Jah	Selle tabeli loogiline nimi, mille kohta vorm kuvatakse.
entityId	String	Ei	Selle tabelikirje ID, mille vormi soovite kuvada.
formId	String	Ei	Kuvatava vormieksemplari ID.
cmdbar	Bool	Ei	Näitab, kas kuvada käsuriba. Kui te seda parameetrit ei määra, kuvatakse käsuriba vaikimisi. Nõutav on läbiv openInNewWindow parameeter tõesena.
createFromEntity	Otsing	Ei	Määrab kirje, mis pakub vastendatud veeruväärtuste põhjal vaikeväärtusi. Otsinguobjektil on järgmised atribuudid String: entityType, idja name (valikuline).
openInNewWindow	Bool	Ei	Näitab, kas vorm kuvatakse uues aknas või uuel vahekaardil. Kui määrate true ja ei määra kõrguse või laiuse väärtusi, kuvatakse vorm uuel vahekaardil. Vormi avamine uues aknas või uuel vahekaardil muudab vormi renderdamise aeglaseks võrreldes vormi avamisega samal vahekaardil; kaaluge vormi avamist põhivormi dialoogis. Kiirloomisvormid ei toeta praegu seda atribuuti, kuna neid ei saa uues aknas ega vahekaardil avada.
height	Number	Ei	Kuvatava vormiakna kõrgus pikslites. Nõutav on läbiv openInNewWindow parameeter tõesena.
width	Number	Ei	Kuvatava vormiakna laius pikslites. Nõutav on läbiv openInNewWindow parameeter tõesena.
navbar	String	Ei	Määrab, kas navigeerimisriba kuvatakse ja kas rakenduses navigeerimine on saadaval saidikaardil määratletud alade ja alamalade abil. Sobivad väärtused on: on, offvõi entity. Nõuab parameetri openInNewWindow edastamist tõesena. - on: Kuvatakse navigeerimisriba. See on vaikekäitumine, kui navigeerimisriba parameetrit ei kasutata. - off: Navigeerimisriba ei kuvata. Inimesed saavad navigeerida muude kasutajaliidese elementide või tagasi- ja edasinuppude abil. - entity: Vormil on saadaval ainult seotud tabelite navigeerimissuvandid. Pärast seotud tabelisse navigeerimist kuvatakse navigeerimisribal tagasiliikumisnupp, mis võimaldab naasta algsesse kirjesse.
relationship	Ese	Ei	Määratlege seoseobjekt, et kuvada vormil seotud kirjed. Seoseobjekti vaatamine
selectedStageId	String	Ei	Äriprotsessi eksemplari valitud etapi ID.
useQuickCreateForm	Bool	Ei	Näitab, kas soovite avada kiirvormi. Kiirvormi kuvamiseks peab tabelil olema lubatud suvand Luba kiir loomine ning samuti peate lisama tabeli ja kiirvormi oma rakendusse. Kui te ei määra i väärtust, seatakse vaikeväärtuseks useQuickCreateFormfalse.

seoseobjekt

Objektil on järgmised väärtused.

Nimi	Liik	Kirjeldus
attributeName	String	Seose jaoks kasutatava veeru nimi.
name	String	Seose jaoks kasutatava veeru nimi.
navigationPropertyName	String	Seose jaoks kasutatava veeru nimi.
relationshipType	Number	Suhte tüüp. Määrake üks järgmistest väärtustest: - 0:OneToMany - 1:ManyToMany
roleType	Number	Seose rollitüüp. Määrake üks järgmistest väärtustest: - 1:Viitamine - 2:AssociationEntity

Märkused

Seda meetodit tuleb kasutada tabeli avamiseks või vormide kiireks loomiseks, mitte iganenud meetodite Xrm.Utility.openEntityForm ja Xrm.Utility.openQuickCreate asemel.

SetActiveProcessi abil saate kuvada kindla äriprotsessi ja seadaActiveProcessInstance'i, et kuvada vormil kindel äriprotsessi eksemplar.

Näited

Näide 1: vormi avamine olemasoleva kirje jaoks

Järgmine näidiskood avab kontaktivormi olemasoleva kontaktikirje kuvamiseks:

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";
entityFormOptions["entityId"] = "00aa00aa-bb11-cc22-dd33-44ee44ee44ee";

// Open the form.
Xrm.Navigation.openForm(entityFormOptions).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Näide 2: vormi avamine uue kirje jaoks

Järgmises näidiskoodis avatakse uue kirje loomiseks kontaktivorm, kus on mõned eeltäidetud väärtused.

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";

// Set default values for the Contact form
var formParameters = {};
formParameters["firstname"] = "Sample";
formParameters["lastname"] = "Contact";
formParameters["fullname"] = "Sample Contact";
formParameters["emailaddress1"] = "contact@adventure-works.com";
formParameters["jobtitle"] = "Sr. Marketing Manager";
formParameters["donotemail"] = "1";
formParameters["description"] = "Default values for this record were set programmatically.";

// Set lookup column
formParameters["preferredsystemuserid"] = "3493e403-fc0c-eb11-a813-002248e258e0"; // ID of the user.
formParameters["preferredsystemuseridname"] = "Admin user"; // Name of the user.
// End of set lookup column

// Open the form.
Xrm.Navigation.openForm(entityFormOptions, formParameters).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Näide 3: vormi avamine uue kirje jaoks (keerukas otsing)

Järgmine näidiskood avab uue kirje loomiseks mõne eelasustatud väärtusega (sh keeruka otsinguga) tegevusvormi:

var entityFormOptions = {};
entityFormOptions["entityName"] = "email";

// Set default values for the Contact form
var formParameters = {};
formParameters["subject"] = "Sample";
formParameters["description"] = "Default values for this record were set programmatically.";

// Set lookup column
formParameters["regardingobjectid"] = "3493e403-fc0c-eb11-a813-002248e258e0"; // ID of the user.
formParameters["regardingobjectidname"] = "Admin user"; // Name of the user.
formParameters["regardingobjectidtype"] = "systemuser"; // Table name. 
// End of set lookup column

// Open the form.
Xrm.Navigation.openForm(entityFormOptions, formParameters).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Näide 4: kiirvormi avamine

Järgmine näidiskood avab kiirloomiskontaktivormi, kus on mõned eeltäidetud väärtused:

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";
entityFormOptions["useQuickCreateForm"] = true;

// Set default values for the Contact form
var formParameters = {};
formParameters["firstname"] = "Sample";
formParameters["lastname"] = "Contact";
formParameters["fullname"] = "Sample Contact";
formParameters["emailaddress1"] = "contact@adventure-works.com";
formParameters["jobtitle"] = "Sr. Marketing Manager";
formParameters["donotemail"] = "1";
formParameters["description"] = "Default values for this record were set programmatically.";

// Set lookup column
formParameters["preferredsystemuserid"] = "3493e403-fc0c-eb11-a813-002248e258e0"; // ID of the user.
formParameters["preferredsystemuseridname"] = "Admin user"; // Name of the user.
formParameters["preferredsystemuseridtype"] = "systemuser"; // Table name.
// End of set lookup column

// Open the form.
Xrm.Navigation.openForm(entityFormOptions, formParameters).then(
    function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    });

Seotud artiklid

Xrm.Navigation