openForm (Ügyfél API-referencia)

Megnyit egy entitásűrlapot vagy egy gyorslétrehozási űrlapot.

Megjegyzés:

A főűrlap párbeszédpanelként való megnyitásához használja inkább a navigateTo metódust. További információ: Fő űrlap megnyitása párbeszédpanelen az ügyfél API használatával.

Szintaxis

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

Paraméterek

Név Típus Kötelező megadni Leírás
entityFormOptions entityFormOptions Igen Űrlapbeállítások az űrlap megnyitásához.
formParameters Objektum Nem Szótárobjektum, amely további paramétereket ad át az űrlapnak. Az érvénytelen paraméterek hibát okoznak.

A paraméterek űrlapnak való átadásáról további információt az oszlopértékek beállítása az űrlapnak átadott paraméterek használatával , valamint az űrlap konfigurálása egyéni lekérdezési paraméterek elfogadásához című témakörben talál.
successCallback Funkció Nem A gyors létrehozási űrlapon a rekord mentésekor végrehajtandó függvény. Ez a függvény egy objektumot fogad el paraméterként. Az objektum egy savedEntityReference tömbbel rendelkezik, amely a következő tulajdonságokkal rendelkezik a megjelenített vagy létrehozott rekordok azonosításához:
- entityType: A tábla logikai neve.
- id: A rekord GUID-értékének sztring-ábrázolása.
- name: A megjelenített vagy létrehozott rekord elsődleges oszlopértéke.

MEGJEGYZÉS:
– A successCallback függvény nem lesz végrehajtva, amikor űrlapot nyit meg egy meglévő vagy új rekordhoz.
– A successCallback függvény csak akkor lesz végrehajtva, ha az openForm metódussal megnyitott gyors létrehozási űrlapon ment egy rekordot.
errorCallback Funkció Nem A művelet sikertelensége esetén végrehajtandó függvény.

entityFormOptions objektum

Az objektum a következő értékeket tartalmazza:

Név Típus Kötelező megadni Leírás
entityName Sztring Igen A tábla logikai neve az űrlap megjelenítéséhez.
entityId Sztring Nem A táblarekord azonosítója az űrlap megjelenítéséhez.
formId Sztring Nem A megjelenítendő űrlappéldány azonosítója.
cmdbar Boole Nem Azt jelzi, hogy meg kell-e jeleníteni a parancssávot. Ha nem adja meg ezt a paramétert, a parancssáv alapértelmezés szerint megjelenik. A paraméter igazként való átadását openInNewWindow igényli.
createFromEntity Keresés Nem Olyan rekordot jelöl ki, amely alapértelmezett értékeket biztosít a megfeleltetett oszlopértékek alapján. A keresési objektum a következő sztringtulajdonságokkal rendelkezik: entityType, idés name (nem kötelező).
openInNewWindow Boole Nem Azt jelzi, hogy új ablakban vagy új lapon jelenjen-e meg az űrlap. Ha magassági vagy szélességi értékeket ad meg true , és nem ad meg értékeket, az űrlap egy új lapon jelenik meg. Ha új ablakban vagy új lapon nyit meg egy űrlapot, az űrlap megjelenítése lassúvá válik az űrlap ugyanazon a lapon való megnyitásához képest; érdemes inkább a főűrlapon megnyitni egy űrlapot. Ez a tulajdonság jelenleg nem támogatott a gyors létrehozási űrlapok esetében, mivel nem nyithatóak meg új ablakban vagy lapon.
height Szám Nem A megjelenítendő űrlapablak magassága képpontban. A paraméter igazként való átadását openInNewWindow igényli.
width Szám Nem A képpontban megjelenítendő űrlapablak szélessége. A paraméter igazként való átadását openInNewWindow igényli.
navbar Sztring Nem Azt szabályozza, hogy megjelenjen-e a navigációs sáv, és hogy az alkalmazásnavigáció elérhető-e az oldaltérképen meghatározott területek és alterületek használatával. Az érvényes értékek a következők: on, offvagy entity. Az openInNewWindow paraméter igazként való átadását igényli.
- on: Megjelenik a navigációs sáv. Ez az alapértelmezett viselkedés, ha a navigációs paraméter nincs használatban.
- off: A navigációs sáv nem jelenik meg. A felhasználók a felhasználói felület más elemeivel vagy a vissza és előre gombokkal navigálhatnak.
- entity: Űrlapon csak a kapcsolódó táblák navigációs beállításai érhetők el. Miután navigált egy kapcsolódó táblára, megjelenik egy vissza gomb a navigációs sávon, amely lehetővé teszi az eredeti rekordra való visszatérést.
relationship Kapcsolat Nem Definiáljon egy kapcsolatobjektumot a kapcsolódó rekordok űrlapon való megjelenítéséhez.
selectedStageId Sztring Nem Az üzletifolyamat-példány kiválasztott szakaszának azonosítója.
useQuickCreateForm Boole Nem Azt jelzi, hogy meg kell-e nyitni egy gyors létrehozási űrlapot. A táblázatnak engedélyeznie kell a Gyors létrehozás engedélyezése beállítást a gyors létrehozási űrlap megjelenítéséhez, és hozzá kell adnia a táblázatot és a gyors létrehozási űrlapot az alkalmazáshoz. Ha nem adja meg az értékét useQuickCreateForm, az alapértelmezett érték a következőre falsevan állítva: .

kapcsolatobjektum

Az objektum az alábbi értékekkel rendelkezik.

Név Típus Leírás
attributeName Sztring A kapcsolathoz használt oszlop neve.
name Sztring A kapcsolathoz használt oszlop neve.
navigationPropertyName Sztring A kapcsolathoz használt oszlop neve.
relationshipType Szám Kapcsolat típusa. Adja meg az alábbi értékek egyikét:
- 0:OneToMany
- 1:ManyToMany
roleType Szám Szerepkör típusa a kapcsolatban. Adja meg az alábbi értékek egyikét:
- 1:Hivatkozás
- 2:AssociationEntity

Megjegyzések

Ezzel a módszerrel kell megnyitnia a táblázatot vagy a gyors létrehozási űrlapokat az elavult Xrm.Utility.openEntityForm és az Xrm.Utility.openQuickCreate metódus helyett.

A setActiveProcess használatával megjeleníthet egy adott üzleti folyamatot, a setActiveProcessInstance pedig megjeleníthet egy adott üzleti folyamatpéldányt az űrlapon.

Példák

Minta Leírás
Űrlap megnyitása meglévő rekordhoz Nyisson meg egy névjegyűrlapot egy meglévő rekordhoz az azonosítójának megadásával.
Űrlap megnyitása új rekordhoz Nyisson meg egy új névjegyűrlapot alapértelmezett értékekkel, beleértve a felhasználó keresését is.
Űrlap megnyitása új rekordhoz (összetett keresés) Nyisson meg egy új e-mail-űrlapot alapértelmezett értékekkel és a táblatípust meghatározó kereséssel.
Gyors létrehozási űrlap megnyitása Nyisson meg egy gyors kapcsolatfelvételi űrlapot alapértelmezett értékekkel.

Űrlap megnyitása meglévő rekord példához

Az alábbi mintakód megnyit egy névjegyűrlapot egy meglévő partnerrekord megjelenítéséhez:

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

Űrlap megnyitása új rekord példájához

Az alábbi mintakód megnyitja a névjegyűrlapot néhány előre feltöltött értékkel egy új rekord létrehozásához:

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

Űrlap megnyitása új rekordhoz (összetett keresés)

Az alábbi mintakód egy tevékenységűrlapot nyit meg néhány előre feltöltött értékkel (beleértve egy összetett keresést is) egy új rekord létrehozásához:

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

Gyors létrehozási űrlap megnyitása példaként

Az alábbi mintakód egy gyors kapcsolatfelvételi űrlapot nyit meg néhány előre feltöltött értékkel:

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