Edit

Share via

openForm (Client API reference)

  • Article

Opens an entity form or a quick create form.

Note

To open a main form as a dialog, use the navigateTo method instead. More information: Open main form in a dialog using client API

Syntax

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

Parameters

Name Type Required Description
entityFormOptions Object Yes Form options for opening the form. See entityFormOptions object
formParameters Object No A dictionary object that passes extra parameters to the form. Invalid parameters will cause an error.

For information about passing parameters to a form, see Set column values using parameters passed to a form and Configure a form to accept custom querystring parameters.
successCallback Function No A function to execute when the record is saved in the quick create form.This function is passed an object as a parameter. The object has a savedEntityReference array with the following properties to identify the record(s) displayed or created:
- entityType: The logical name of the table.
- id: A string representation of a GUID value for the record.
- name: The primary column value of the record displayed or created.

NOTE:
- The successCallback function is not executed when you open a form for an existing or new record.
- The successCallback function is executed only when you save a record in a quick create form that was opened using the openForm method.
errorCallback Function No A function to execute when the operation fails.

entityFormOptions object

The object contains the following values:

Name Type Required Description
entityName String Yes Logical name of the table to display the form for.
entityId String No ID of the table record to display the form for.
formId String No ID of the form instance to be displayed.
cmdbar Bool No Indicates whether to display the command bar. If you do not specify this parameter, the command bar is displayed by default. Requires passing openInNewWindow parameter as true.
createFromEntity Lookup No Designates a record that will provide default values based on mapped column values. The lookup object has the following String properties: entityType, id, and name (optional).
openInNewWindow Bool No Indicates whether to display form in a new window or a new tab. If you specify true and do not specify values for height or width, the form will display in a new tab. Opening a form in a new window or a new tab makes the rendering of the form slow compared to opening the form on the same tab; consider opening a form in the main form dialog instead. This property is currently not supported for Quick Create forms, as they can not be opened in a new window or tab.
height Number No Height of the form window to be displayed in pixels. Requires passing openInNewWindow parameter as true.
width Number No Width of the form window to be displayed in pixels. Requires passing openInNewWindow parameter as true.
navbar String No Controls whether the navigation bar is displayed and whether application navigation is available using the areas and subareas defined in the sitemap. Valid values are: on, off, or entity. Requires passing openInNewWindow parameter as true.
- on: The navigation bar is displayed. This is the default behavior if the navbar parameter is not used.
- off: The navigation bar is not displayed. People can navigate using other user interface elements or the back and forward buttons.
- entity: On a form, only the navigation options for related tables are available. After navigating to a related table, a back button is displayed in the navigation bar to allow returning to the original record.
relationship Object No Define a relationship object to display the related records on the form. See relationship object
selectedStageId String No ID of the selected stage in business process instance.
useQuickCreateForm Bool No Indicates whether to open a quick create form. The table must have the Allow Quick Create option enabled for the quick create form to be displayed and you must also add the table and the quick create form to your app. If you do not specify the value of useQuickCreateForm, the default will be set to false.

relationship object

The object has the following values.

Name Type Description
attributeName String Name of the column used for relationship.
name String Name of the column used for relationship.
navigationPropertyName String Name of the column used for relationship.
relationshipType Number Relationship type. Specify one of the following values:
- 0:OneToMany
- 1:ManyToMany
roleType Number Role type in relationship. Specify one of the following values:
- 1:Referencing
- 2:AssociationEntity

Remarks

You must use this method to open table or quick create forms instead of the deprecated Xrm.Utility.openEntityForm and Xrm.Utility.openQuickCreate methods.

Use setActiveProcess to display a particular business process and setActiveProcessInstance to display a particular business process instance on the form.

Examples

Example 1: Open a form for existing record

The following sample code opens a contact form to display an existing contact record:

var entityFormOptions = {};
entityFormOptions["entityName"] = "contact";
entityFormOptions["entityId"] = "8DA6E5B9-88DF-E311-B8E5-6C3BE5A8B200";

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

Example 2: Open a form for new record

The following sample code opens a contact form with some pre-populated values to create a new record:

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"] = "[email protected]";
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);
    });

Example 3: Open a form for new record (complex lookup)

The following sample code opens a activity form with some pre-populated values (including a complex lookup) to create a new record:

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

Example 4: Open a quick create form

The following sample code opens a quick create contact form with some pre-populated values:

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"] = "[email protected]";
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