openForm (odkaz na klientske rozhranie API)

Otvorí formulár entity alebo formulár rýchleho vytvorenia.

Poznámka

Ak chcete otvoriť hlavný formulár ako dialógové okno, použite namiesto toho metódu navigateTo . Ďalšie informácie nájdete v téme Otvorenie hlavného formulára v dialógovom okne pomocou rozhrania API klienta.

Syntax

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

Parametre

Meno Zadať Required Popis
entityFormOptions entityFormOptions (formulár entity)Možnosti Yes Možnosti formulára na otvorenie formulára.
formParameters Object Nie Objekt slovníka, ktorý odovzdáva formuláru ďalšie parametre. Neplatné parametre spôsobia chybu.

Informácie o prenose parametrov do formulára nájdete v téme Nastavenie hodnôt stĺpcov pomocou parametrov odovzdaných formuláru a Konfigurácia formulára na prijímanie vlastných parametrov reťazca dotazu.
successCallback Function Nie Funkcia, ktorá sa vykoná po uložení záznamu vo formulári rýchleho vytvorenia. Táto funkcia akceptuje objekt ako parameter. Objekt má savedEntityReference pole s nasledujúcimi vlastnosťami na identifikáciu zobrazených alebo vytvorených záznamov:
- entityType: Logický názov tabuľky.
- id: Vyjadrenie reťazca hodnoty GUID pre záznam.
- name: Hodnota primárneho stĺpca záznamu zobrazeného alebo vytvoreného.

POZNÁMKA:
– Funkcia sa successCallback nevykoná, keď otvoríte formulár pre existujúci alebo nový záznam.
– Táto funkcia sa successCallback spustí iba vtedy, keď uložíte záznam vo formulári na rýchle vytvorenie, ktorý ste otvorili pomocou metódy openForm.
errorCallback Function Nie Funkcia, ktorá sa vykoná v prípade zlyhania operácie.

objekt entityFormOptions

Objekt obsahuje nasledujúce hodnoty:

Meno Zadať Required Popis
entityName Povrázok Yes Logický názov tabuľky, pre ktorý sa má zobraziť formulár.
entityId Povrázok Nie ID záznamu tabuľky, pre ktorý sa má zobraziť formulár.
formId Povrázok Nie ID inštancie formulára, ktorá sa má zobraziť.
cmdbar Bool Nie Označuje, či sa má zobraziť panel príkazov. Ak tento parameter nezadáte, predvolene sa zobrazí panel príkazov. Vyžaduje odovzdanie openInNewWindow parametra ako true.
createFromEntity Vyhľadávanie Nie Určí záznam, ktorý poskytuje predvolené hodnoty na základe hodnôt namapovaných stĺpcov. Vyhľadávací objekt má nasledujúce vlastnosti String: entityType, ida name (voliteľné).
openInNewWindow Bool Nie Udáva, či sa má zobraziť formulár v novom okne alebo na novej karte. Ak zadáte a nezadáte true hodnoty pre výšku alebo šírku, formulár sa zobrazí na novej karte. Otvorenie formulára v novom okne alebo na novej karte spôsobí, že vykresľovanie formulára je pomalé v porovnaní s otvorením formulára na tej istej karte. Namiesto toho zvážte otvorenie formulára v hlavnom dialógovom okne formulára. Táto vlastnosť momentálne nie je podporovaná pre formuláre rýchleho vytvorenia, pretože nie je ich možné otvoriť v novom okne alebo karte.
height Číslo Nie Výška okna formulára, ktorá sa má zobraziť v pixeloch. Vyžaduje odovzdanie openInNewWindow parametra ako true.
width Číslo Nie Šírka okna formulára, ktorá sa má zobraziť v pixeloch. Vyžaduje odovzdanie openInNewWindow parametra ako true.
navbar Povrázok Nie Určuje, či sa zobrazí navigačný panel a či je k dispozícii navigácia v aplikácii pomocou oblastí a podoblastí definovaných v mape lokality. Platné hodnoty sú: on, offalebo entity. Vyžaduje odovzdanie parametra openInNewWindow ako hodnotu true.
- on: Zobrazí sa navigačný panel. Toto je predvolené správanie, ak sa parameter navigačného panela nepoužíva.
- off: Navigačný panel sa nezobrazuje. Ľudia môžu navigovať pomocou iných prvkov používateľského rozhrania alebo tlačidiel späť a dopredu.
- entity: Vo formulári sú k dispozícii len možnosti navigácie pre súvisiace tabuľky. Po prechode na súvisiacu tabuľku sa na navigačnom paneli zobrazí tlačidlo Späť, aby sa umožnilo návrat k pôvodnému záznamu.
relationship relationship (vzťah) Nie Definovanie objektu vzťahu na zobrazenie súvisiacich záznamov vo formulári.
selectedStageId Povrázok Nie ID vybratej fázy v inštancii obchodného procesu.
useQuickCreateForm Bool Nie Udáva, či sa má otvoriť formulár na rýchle vytvorenie. Tabuľka musí mať povolenú možnosť Povoliť rýchle vytvorenie , aby sa zobrazil formulár rýchleho vytvorenia a musíte tiež pridať tabuľku a formulár rýchleho vytvorenia do aplikácie. Ak hodnotu nezadáte useQuickCreateForm, predvolená hodnota je nastavená na false.

objekt vzťahu

Objekt má nasledujúce hodnoty.

Meno Zadať Popis
attributeName Povrázok Názov stĺpca použitého pre vzťah.
name Povrázok Názov stĺpca použitého pre vzťah.
navigationPropertyName Povrázok Názov stĺpca použitého pre vzťah.
relationshipType Číslo Typ vzťahu. Zadajte jednu z nasledujúcich hodnôt:
– 0:OneToMany
– 1:ManyToMany
roleType Číslo Typ roly vo vzťahu. Zadajte jednu z nasledujúcich hodnôt:
- 1:Odkazovanie
- 2:PriradenieEntita

Poznámky

Túto metódu musíte použiť na otvorenie tabuliek alebo rýchle vytvorenie formulárov namiesto zastaraných metód Xrm.Utility.openEntityForm a Xrm.Utility.openQuickCreate .

Pomocou možnosti setActiveProcess môžete zobraziť konkrétny obchodný proces a nastaviťActiveProcessInstance na zobrazenie konkrétnej inštancie obchodného procesu vo formulári.

Príklady

Sample Popis
Otvorenie formulára pre existujúci záznam Zadaním jeho ID otvorte formulár kontaktu pre existujúci záznam.
Otvorenie formulára pre nový záznam Otvorte nový formulár kontaktu s predvolenými hodnotami vrátane vyhľadávania používateľa.
Otvorenie formulára pre nový záznam (komplexné vyhľadávanie) Otvorte nový e-mailový formulár s predvolenými hodnotami a súvisiacim vyhľadávaním, ktorý určuje typ tabuľky.
Otvorenie formulára na rýchle vytvorenie Otvorte formulár kontaktu na rýchle vytvorenie s predvolenými hodnotami.

Otvorenie formulára pre príklad existujúceho záznamu

Nasledujúci vzorový kód otvorí formulár kontaktu na zobrazenie existujúceho záznamu kontaktu:

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

Otvorenie formulára pre nový príklad záznamu

Nasledujúci vzorový kód otvorí formulár kontaktu s vopred vyplnenými hodnotami na vytvorenie nového záznamu:

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

Otvorenie formulára pre nový záznam (príklad komplexného vyhľadávania)

Nasledujúci vzorový kód otvorí formulár aktivity s niektorými vopred vyplnenými hodnotami (vrátane komplexného vyhľadávania) na vytvorenie nového záznamu:

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

Otvorenie príkladu formulára na rýchle vytvorenie

Nasledujúci vzorový kód otvorí formulár rýchleho vytvorenia kontaktu s niektorými vopred vyplnenými hodnotami:

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