openForm (kliento API nuoroda)

Atidaro objekto formą arba sparčiojo kūrimo formą.

Pastaba.

Norėdami atidaryti pagrindinę formą kaip dialogo langą, naudokite metodą navigateTo . Daugiau informacijos žr. Pagrindinės formos atidarymas dialogo lange naudojant kliento API.

Sintaksė

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

Parametrai

Pavadinimas Tipas Būtina Aprašas
entityFormOptions entityFormOptions Taip Formos parinktys formai atidaryti.
formParameters Objektas Ne Žodyno objektas, perduodantis formai papildomus parametrus. Neleistini parametrai sukelia klaidą.

Informacijos apie parametrų rodymą formoje žr . Stulpelių reikšmių nustatymas naudojant į formą perduotus parametrus ir Formos konfigūravimas, kad būtų priimti pasirinktiniai užklausų eilutės parametrai.
successCallback Funkcija Ne Funkcija, vykdoma įrašant įrašą sparčiojo kūrimo formoje. Ši funkcija priima objektą kaip parametrą. Objektas turi masyvą savedEntityReference su šiomis ypatybėmis, kad galėtų identifikuoti rodomus arba sukurtus įrašus:
- entityType: Loginis lentelės pavadinimas.
- id: įrašo GUID reikšmės eilutės atvaizdavimas.
- name: rodoma arba kuriamo įrašo pirminė stulpelio reikšmė.

PASTABA:
– Atidarius successCallback esamo arba naujo įrašo formą, funkcija nevykdoma.
- Funkcija successCallback vykdoma tik tada, kai įrašote įrašą sparčiojo kūrimo forma, kurią atidarėte naudodami metodą openForm.
errorCallback Funkcija Ne Funkcija, kurią reikia vykdyti, kai operacija nepavyksta.

entityFormOptions objektas

Objekte yra šios reikšmės:

Pavadinimas Tipas Būtina Aprašas
entityName Eilutė Taip Loginis lentelės pavadinimas, skirtas formai rodyti.
entityId Eilutė Ne Lentelės įrašo ID, skirtas formai rodyti.
formId Eilutė Ne Rodytinas formos egzemplioriaus ID.
cmdbar Bulio logika Ne Nurodo, ar rodyti komandų juostą. Jei nenurodysite šio parametro, pagal numatytuosius parametrus bus rodoma komandų juosta. Reikia perduoti openInNewWindow parametrą kaip teisingą.
createFromEntity Peržvalga Ne Nurodo įrašą, kuris pateikia numatytąsias reikšmes, pagrįstas susietų stulpelių reikšmėmis. Peržvalgos objektas turi šias eilutės ypatybes: entityType, idir name (pasirinktinai).
openInNewWindow Bulio logika Ne Nurodo, ar rodyti formą naujame lange, ar naujame skirtuke. Jei nurodysite true ir nenurodysite aukščio ar pločio reikšmių, forma bus rodoma naujame skirtuke. Atidarius formą naujame lange arba naujame skirtuke formos vaizdas generuojamas lėtai, palyginti su formos atidarymu tame pačiame skirtuke; verčiau atidarykite formą pagrindinės formos dialogo lange. Sparčiojo kūrimo formos šiuo metu nepalaiko šios ypatybės, nes jos negalima atidaryti naujame lange arba skirtuke.
height Skaičius Ne Formos lango aukštis, kuris bus rodomas pikseliais. Reikia perduoti openInNewWindow parametrą kaip teisingą.
width Skaičius Ne Formos lango plotis, rodomas pikseliais. Reikia perduoti openInNewWindow parametrą kaip teisingą.
navbar Eilutė Ne Kontroliuoja, ar rodoma naršymo juosta ir ar galima naršyti taikomosioje programoje, naudojant svetainės struktūroje apibrėžtas sritis ir parajonius. Leistinos reikšmės yra: on, offarba entity. Būtina perduoti openInNewWindow parametrą kaip teisingą.
- on: rodoma naršymo juosta. Tai numatytasis veikimas, jei naršymo juostos parametras nenaudojamas.
- off: naršymo juosta nerodoma. Žmonės gali naršyti naudodami kitus vartotojo sąsajos elementus arba mygtukus atgal ir pirmyn.
- entity: formoje galimos tik susijusių lentelių naršymo parinktys. Naršant į susijusią lentelę, naršymo juostoje rodomas mygtukas Atgal, kad būtų galima grįžti į pradinį įrašą.
relationship ryšys Ne Apibrėžkite ryšio objektą, kad formoje būtų rodomi susiję įrašai.
selectedStageId Eilutė Ne Verslo proceso egzemplioriaus pasirinkto etapo ID.
useQuickCreateForm Bulio logika Ne Nurodo, ar atidaryti sparčiojo kūrimo formą. Kad būtų rodoma sparčiojo kūrimo forma, lentelėje turi būti įgalinta parinktis Leisti spartųjį kūrimą , be to, į taikomąją programą turite įtraukti lentelę ir sparčiojo kūrimo formą. Jei nenurodysite reikšmės useQuickCreateForm, numatytoji reikšmė bus nustatyta kaip false.

ryšio objektas

Objektas turi šias reikšmes.

Pavadinimas Tipas Aprašas
attributeName Eilutė Ryšio stulpelio pavadinimas.
name Eilutė Ryšio stulpelio pavadinimas.
navigationPropertyName Eilutė Ryšio stulpelio pavadinimas.
relationshipType Skaičius Santykių tipas. Nurodykite vieną iš šių reikšmių:
- 0:OneToMany
- 1:ManyToMany
roleType Skaičius Vaidmens tipas ryšyje. Nurodykite vieną iš šių reikšmių:
- 1: nuoroda
- 2:AssociationEntity

Pastabos

Turite naudoti šį metodą norėdami atidaryti lentelę arba sparčiojo kūrimo formas, o ne pasenusius "Xrm.Utility.openEntityForm " ir "Xrm.Utility.openQuickCreate" metodus.

Naudokite setActiveProcess norėdami parodyti konkretų verslo procesą ir setActiveProcessInstance , kad formoje būtų rodomas konkretus verslo proceso egzempliorius.

Pavyzdžiai

Pavyzdys Aprašas
Atidaryti esamo įrašo formą Atidarykite esamo įrašo kontakto formą nurodydami jo ID.
Atidaryti naujo įrašo formą Atidarykite naują kontakto formą su numatytosiomis reikšmėmis, įskaitant vartotojo peržvalgą.
Atidaryti naujo įrašo formą (sudėtinga peržvalga) Atidarykite naują el. pašto formą su numatytosiomis reikšmėmis ir susijusią peržvalgą, kuri nurodo lentelės tipą.
Sparčiojo kūrimo formos atidarymas Atidaryti sparčiojo kontakto kūrimo formą su numatytosiomis reikšmėmis.

Atidaryti esamo įrašo pavyzdžio formą

Šis kodo pavyzdys atidaro kontakto formą, kad būtų rodomas esamas kontakto įrašas:

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

Atidaryti naujo įrašo pavyzdžio formą

Šis kodo pavyzdys atidaro kontakto formą su iš anksto užpildytomis reikšmėmis, kad sukurtų naują įrašą:

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

Atidaryti naujo įrašo (sudėtingos peržvalgos) pavyzdžio formą

Toliau pateiktame kodo pavyzdyje atidaroma veiklos forma su iš anksto užpildytomis reikšmėmis (įskaitant sudėtinę peržvalgą), kad būtų galima sukurti naują įrašą:

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

Atidaryti sparčiojo kūrimo formos pavyzdį

Toliau pateiktame kodo pavyzdyje atidaroma sparčiojo kontakto kūrimo forma su iš anksto užpildytomis reikšmėmis:

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

Xrm.Navigation