openForm (klienta API atsauce)

Atver entītijas veidlapu vai ātrās izveides veidlapu.

Piezīmes

Lai atvērtu galveno veidlapu kā dialogu, izmantojiet metodi navigateTo . Papildinformācija: Atveriet galveno veidlapu dialoglodziņā, izmantojot klienta API

Sintakse

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

Parametri

Nosaukums	Tips	Obligāts	Apraksts
`entityFormOptions`	Objekts	Jā	Veidlapas opcijas veidlapas atvēršanai. Objekta entityFormOptions skatīšana
`formParameters`	Objekts	Nē.	Vārdnīcas objekts, kas veidlapai nodod papildu parametrus. Nederīgi parametri izraisa kļūdu. Informāciju par parametru nodošanu veidlapai skatiet sadaļā Kolonnu vērtību iestatīšana, izmantojot veidlapai nodotos parametrus un Veidlapas konfigurēšana pielāgotu vaicājumu virknes parametru akceptēšanai.
`successCallback`	Funkcija	Nē.	Funkcija, kas jāizpilda, kad ieraksts tiek saglabāts ātrās izveides veidlapā. Šī funkcija pieņem objektu kā parametru. Objektam ir masīvs `savedEntityReference` ar šādiem rekvizītiem, lai identificētu parādītos vai izveidotos ierakstus: - `entityType`: tabulas loģiskais nosaukums. - `id`: ieraksta GUID vērtības virknes attēlojums. - `name`: parādītā vai izveidotā ieraksta primārās kolonnas vērtība. PIEZĪME: - Funkcija `successCallback` netiek izpildīta, atverot veidlapu esošam vai jaunam ierakstam. - Funkcija `successCallback` tiek izpildīta tikai tad, ja saglabājat ierakstu ātrās izveides veidlapā, kas tika atvērta, izmantojot openForm metodi.
`errorCallback`	Funkcija	Nē.	Funkcija, kas jāizpilda, ja operācija neizdodas.

entityFormOptions objekts

Objekts satur šādas vērtības:

Nosaukums	Tips	Obligāts	Apraksts
`entityName`	Virkne	Jā	Loģiskais tabulas nosaukums, kurai jāparāda veidlapa.
`entityId`	Virkne	Nē.	Tabulas ieraksta ID, kuram jāparāda veidlapa.
`formId`	Virkne	Nē.	Parādāmās veidlapas instances ID.
`cmdbar`	Būls	Nē.	Norāda, vai jāparāda komandjosla. Ja nenorādāt šo parametru, komandjosla tiek parādīta pēc noklusējuma. Nepieciešams nodot `openInNewWindow` parametru kā true.
`createFromEntity`	Uzmeklēšana	Nē.	Norāda ierakstu, kas nodrošina noklusējuma vērtības, pamatojoties uz kartētām kolonnu vērtībām. Uzmeklēšanas objektam ir šādi virknes rekvizīti: `entityType`, `id`, un `name` (neobligāti).
`openInNewWindow`	Būls	Nē.	Norāda, vai veidlapa jāparāda jaunā logā vai jaunā cilnē. Ja norādāt `true` un nenorādāt augstuma vai platuma vērtības, veidlapa tiek parādīta jaunā cilnē. Atverot veidlapu jaunā logā vai jaunā cilnē, veidlapas atveidošana ir lēnāka salīdzinājumā ar veidlapas atvēršanu tajā pašā cilnē; tā vietā apsveriet iespēju atvērt veidlapu galvenajā veidlapas dialoglodziņā. Šis rekvizīts pašlaik netiek atbalstīts ātrās izveides veidlapām, jo tās nevar atvērt jaunā logā vai cilnē.
`height`	Skaitlis	Nē.	Veidlapas loga augstums, kas jāparāda pikseļos. Nepieciešams nodot `openInNewWindow` parametru kā true.
`width`	Skaitlis	Nē.	Veidlapas loga platums, kas jāparāda pikseļos. Nepieciešams nodot `openInNewWindow` parametru kā true.
`navbar`	Virkne	Nē.	Kontrolē, vai navigācijas josla tiek parādīta un vai lietojumprogrammu navigācija ir pieejama, izmantojot vietnes kartē definētos apgabalus un apakšapgabalus. Derīgās vērtības ir: `on`, `off`vai `entity`. Nepieciešams nodot parametru openInNewWindow kā true. - `on`: tiek parādīta navigācijas josla. Šī ir noklusējuma darbība, ja netiek izmantots navigācijas joslas parametrs. - `off`: navigācijas josla netiek rādīta. Lietotāji var pārvietoties, izmantojot citus lietotāja interfeisa elementus vai pogas atpakaļ un uz priekšu. - `entity`: veidlapā ir pieejamas tikai saistīto tabulu navigācijas opcijas. Pēc navigācijas uz saistītu tabulu navigācijas joslā tiek parādīta poga Atpakaļ, lai varētu atgriezties sākotnējā ierakstā.
`relationship`	Objekts	Nē.	Definējiet relācijas objektu, lai veidlapā parādītu saistītos ierakstus. Skatīt relācijas objektu
`selectedStageId`	Virkne	Nē.	Biznesa procesa instances atlasītā posma ID.
`useQuickCreateForm`	Būls	Nē.	Norāda, vai atvērt ātrās izveides veidlapu. Lai parādītu ātrās izveides veidlapu, tabulā ir jābūt iespējotai opcijai Atļaut ātro izveidi , kā arī jāpievieno tabula un ātrās izveides veidlapa savai programmai. Ja nenorādāt vērtību `useQuickCreateForm`, noklusējums ir iestatīts uz `false`.

relāciju objekts

Objektam ir šādas vērtības.

Nosaukums	Tips	Apraksts
`attributeName`	Virkne	Relācijai izmantotās kolonnas nosaukums.
`name`	Virkne	Relācijai izmantotās kolonnas nosaukums.
`navigationPropertyName`	Virkne	Relācijai izmantotās kolonnas nosaukums.
`relationshipType`	Skaitlis	Relāciju tips. Norādiet vienu no šīm vērtībām: - 0:Viens pret daudziem - 1:DaudziDaudzi
`roleType`	Skaitlis	Lomas tips attiecībās. Norādiet vienu no šīm vērtībām: - 1:Atsauces - 2:AsociācijaVienība

Atzīmes

Šī metode ir jāizmanto, lai atvērtu tabulas vai ātrās izveides veidlapas, nevis novecojušās Xrm.Utility.openEntityForm un Xrm.Utility.openQuickCreate metodes.

Izmantojiet setActiveProcess , lai parādītu noteiktu biznesa procesu, un setActiveProcessInstance , lai veidlapā parādītu noteiktu biznesa procesa instanci.

Piemēri

1. piemērs: esoša ieraksta veidlapas atvēršana

Izmantojot tālāk norādīto koda paraugu, tiek atvērta kontaktpersonas veidlapa, lai parādītu esošu kontaktpersonas ierakstu:

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

2. piemērs: jauna ieraksta veidlapas atvēršana

Izmantojot tālāk norādīto koda paraugu, tiek atvērta kontaktpersonas veidlapa ar dažām iepriekš aizpildītām vērtībām, lai izveidotu jaunu ierakstu:

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

3. piemērs: veidlapas atvēršana jaunam ierakstam (sarežģīta uzmeklēšana)

Izmantojot tālāk norādīto koda paraugu, tiek atvērta darbības veidlapa ar dažām iepriekš aizpildītām vērtībām (ieskaitot sarežģītu uzmeklēšanu), lai izveidotu jaunu ierakstu:

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

4. piemērs: ātrās izveides veidlapas atvēršana

Izmantojot tālāk sniegto koda paraugu, tiek atvērta ātrās izveides kontaktpersonas veidlapa ar dažām iepriekš aizpildītām vērtībām:

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

Atsauksmes

Vai šī lapa palīdzēja?

Last updated on 2026-05-01