Customize entity forms
Applies To: Dynamics CRM 2013
Forms provide the user interface (UI) that people use to create, view, or edit entity records. Use the form designer in the customization tools to create and edit entity forms. See the customization guide topic Create and design forms for information about tasks related to working with forms in the application.
This topic will provide information necessary to create or edit forms programmatically.
In This Topic
Access form definitions
Form properties
Create and edit forms
Access form definitions
Entity forms are stored in the SystemForm entity along with dashboards and visualizations. There are two ways that you can inspect the form definitions for an entity:
Include the entity in an unmanaged solution and export the solution.
Query the SystemForm entity
View FormXML from an exported entity
Only definitions of system entity forms that have been customized are included in exported managed solution. To view the definition of a system entity form, you must either change it in some way, or create a new form by saving the existing form with a new name.
After you export the solution, extract the contents and view the customizations.xml file. You’ll find the definition of the forms in ImportExportXml > Entities > Entity > FormXml. In the <FormXml> (FormXml) node, you’ll find each type of form is grouped in a <forms> (FormXml) element with the type attribute specifying the type of form.
Form properties
The following table describes key SystemForm entity attributes and the corresponding data included in the XML elements exported with the solution.
SystemForm property |
FormXML element |
Description |
|---|---|---|
AncestorFormId |
Unique identifier of the parent form. This is set when you choose to create a new form by creating a form by using Save As for an existing form or by using CopySystemFormRequest. |
|
CanBeDeleted |
Information that specifies whether this component can be deleted.This managed property is only applied if the form was created by importing a managed solution. |
|
Description |
Description is a string and <Descriptions> (FormXml) contains any localized labels for the description of the form. The localized labels can be retrieved using the RetrieveLocLabelsRequest. |
|
FormActivationState |
Specifies the state of the form. Only forms of type “main” can be deactivated. Valid Values:
|
|
FormId |
Unique identifier of the form |
|
FormPresentation |
Specifies whether this form is in the updated UI layout in Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online. |
|
FormXml |
XML representation of the form layout. For details about the form structure, see <form> (FormXml). |
|
IntroducedVersion |
Version of the solution that the form was added in. |
|
IsAIRMerged |
N/A |
Specifies whether this form is merged with the updated UI layout in Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online. |
IsCustomizable |
Information that specifies whether this component can be customized. This managed property is only applied if the form was created by importing a managed solution. |
|
IsDefault |
N/A |
Information that specifies whether the form or the dashboard is the system default. |
Name |
Name is a string and <Descriptions> (FormXml) contains any localized labels for the name of the form. The localized labels can be retrieved using the RetrieveLocLabelsRequest. |
|
ObjectTypeCode |
The form is a decedent of the Entity element. |
The ObjectTypeCode value is the entity logical name. |
Type |
<forms> (FormXml) element type attribute |
Valid values for forms are:
|
Create and edit forms
You can only create new forms for an entity where EntityMetadata. CanCreateForms allows it.
You can create new forms using either a CreateRequest or the CopySystemFormRequest. When using CopySystemFormRequest or using Save As in the form editor, note that there is no inheritance between forms. Therefore, changes to the base form aren’t automatically applied to any forms created from it.
Editing the form definitions from an exported managed solution and then re-importing the solution is a supported method to edit entity forms. When manually editing forms we strongly recommend you use an XML editor that allows for schema validation. More information: Edit the customizations XML file with schema validation
See Also
Developers guide to customization for Microsoft Dynamics CRM 2013
Create and design forms
SystemForm (system dashboard) entity messages and methods
Create or edit how business rules are initiated
Form XML reference
Form XML schema