Form XML reference

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Use the Form editor to manipulate the XML that defines forms. Use the information in this section when you edit the Form XML.

The root element is <FormXml> (FormXml).

In This Section

• <ActionList> (FormXml)
  For internal use only

• <AddressField> (FormXml)
  Specifies the composite address field used by a Bing Maps control.

• <AllowChangingFiltersOnUI> (FormXml)
  For internal use only

• <AllowFilterOff> (FormXml)
  Specifies whether users can turn off the record filter when record filtering is enabled.

• <Ancestor> (FormXml)
  Contains the ID of the updated user experience form that this form was created from.

• <AltText> (FormXml)
  A parameter for Web resource controls. The value of this element specifies alternative text for image Web resources.

• <AutoExpand> (FormXml)
  Specifies whether a sub-grid automatically expands to use available space in the form tab.

• <AutoResolve> (FormXml)
  Specifies whether automatic resolutions in the field are enabled.

• <AvailableViewIds> (FormXml)
  Controls which views are available for selection, when view selection is enabled.

• <Border> (FormXml)
  A parameter for IFrame or web resource controls. The value of this element specifies whether to display a border around the control.

• <CanBeDeleted> (FormXml)
  Specifies whether the form can be deleted.

• <CancelConditionName> (FormXml)
  Specifies the field used by the SLA timer control to check for cancellation condition.

• <CancelConditionValue> (FormXml)
  Specifies the value used by the SLA timer control when determining cancellation.

• <cell> (FormXml)
  A form layout element. A cell contains the labels and the control to display.

• <ChartGridMode> (FormXml)
  Specifies whether the sub-grid displays a chart, a grid, or both.

• <clientincludes> (FormXml)
  Contains references to Web resources or internal files to include with the form.

• <clientresources> (FormXml)
  Contains files and script objects to be included with the form.

• <clientvariables> (FormXml)
  For internal use only. Specifies application variables that are available to scripts in the form.

• <column> (FormXml)
  Specifies a column within a tab element.

• <columns> (FormXml)
  Contains the columns within a tab.

• <control> (FormXml)
  Specifies the control to display within a form cell.

• <controldescription> (FormXml)
  Specifies the description of a custom control on a form.

• <controldescriptions> (FormXml)
  Contajns the description of all the custom controls on a form.

• <ControlMode> (FormXml)
  Indicates the mode of the quick form control.

• <customcontrol> (FormXml)
  Specifies a custom control on a form.

• <data> (FormXml)
  For internal use only.

• <Data> Web Resource Parameter (FormXml)
  Represents query string parameters to pass to the Web resource.

• <DefaultValue> (FormXml)
  For internal use only

• <DefaultViewId> (FormXml)
  Specifies the default view.

• <DefaultViewReadOnly> (FormXml)
  Specifies that the default view cannot be changed in the form editor.

• <dependencies> (FormXml)
  Contains the dependencies for an event.

• <dependency> (FormXml)
  Specifies an attribute that is required by code in an event.

• <DependentAttributeName> (FormXml)
  Specifies the name of an attribute to use when filtering related records.

• <DependentAttributeType> (FormXml)
  Specifies the type of entity for the lookup field used to filter related records.

• <Description> (FormXml)
  Provides a localized description of a form.

• <Descriptions> (FormXml)
  Contains a set of localized descriptions of the form.

• <DisableMru> (FormXml)
  Disables the most recently used items for the lookup.

• <DisableQuickFind> (FormXml)
  Specifies whether to display the search box in the lookup dialog box.

• <DisableViewPicker> (FormXml)
  Specifies whether to display a list of views to choose from when searching for a record to set in the lookup.

• <DisplayConditions> (FormXml)
  Contains definitions of any security role membership conditions that must be met to display the form.

• <EnableAutoSuggestions> (FormXml)
  For internal use only

• <EnableChartPicker> (FormXml)
  Specifies whether a chart selection is available.

• <EnableContextualActions> (FormXml)
  Specifies whether the contextual actions are shown in the inline subgrid. For internal use only.

• <EnableJumpBar> (FormXml)
  Specifies whether an index is displayed for the sub-grid.

• <EnableQuickFind> (FormXml)
  Specifies whether to display a search box in the sub-grid.

• <EnableViewPicker> (FormXml)
  Specifies whether to display a view selection option for the sub-grid.

• <EntityLogicalName> (FormXml)
  Specifies the entity logical name of the quick create form to open. This parameter is used by lookups to determine the type of record to be created when the New button is clicked.

• <event> (FormXml)
  Specifies an event for the form or field.

• <events> (FormXml)
  Contains all the event definitions for a cell or form.

• <Everyone> (FormXml)
  Specifies that the form is visible to everyone.

• <externaldependencies> (FormXml)
  Contains dependencies that represent fields that cannot be removed from the form.

• <FailureTimeField> (FormXml)
  Specifies the time field used by the SLA timer control to assess failure.

• <FailureConditionName> (FormXml)
  Specifies the field used by the SLA timer control to check for failure conditions.

• <FailureConditionValue> (FormXml)
  Specifies the value used by the SLA timer control when determining failure.

• <FilterRelationshipName> (FormXml)
  Specifies the name of an entity relationship that filters records to only those that use that relationship.

• <FilterResults> (FormXml)
  For internal use only

• <footer> (FormXml)
  Displays read-only information at the bottom of a form.

• <form> (FormXml)
  Displays read-only information at the bottom of a form.

• <FormActivationState> (FormXml)
  Specifies the state of the form.

• <Format> (FormXml)
  For internal use only

• <formid> (FormXml)
  Contains the unique ID value for a form.

• <formLibraries> (FormXml)
  Contains the JavaScript libraries that are available in the form.

• <formparameters> (FormXml)
  Contains definitions of custom parameters that will be accepted by the form.

• <forms> (FormXml)
  Contains all the system form definitions for a specific type of form.

• <FormXml> (FormXml)
  Contains all the forms definitions for an entity.

• <Handler> (FormXml)
  Specifies a JavaScript library and function to call for an event.

• <Handlers> (FormXml)
  Contains all the event handlers for an event.

• <header> (FormXml)
  Displays read-only information at the top of the form.

• <Height> (FormXml)
  Provides the height value, when a Web resource for an image uses the Specific parameter.

• <hiddencontrols> (FormXml)
  For internal use only.

• <HorizontalAlignment> (FormXml)
  Specifies the horizontal alignment of image Web resources.

• <InlineViewIds> (FormXml)
  Specifies the GUIDs of the views that are used for inline lookup. These views contain the columns that are displayed in the search results.

• <internalcssfile> (FormXml)
  For internal use only. Defines style sheets used by the form.

• <InternalHandlers> (FormXml)
  For internal use only. Contains event handlers defined by Microsoft Dynamics 365.

• <internaljscriptfile> (FormXml)
  For internal use only. Defines script Web resources used by the form.

• <internaljscriptvariable> (FormXml)
  For internal use only. Defines script variables for the form.

• <internalresources> (FormXml)
  For internal use only. Defines form resources that control the functionality of forms.

• <IntroducedVersion> (FormXml)
  A version number that represents the version of the solution that the solution component was added in.

• <IsColorValue> (FormXml)
  For internal use only

• <IsCustomizable> (FormXml)
  Indicates whether the form is customizable.

• <IsDeDupLookup> (FormXml)
  For internal use only

• <IsInlineNewEnabled> (FormXml)
  Specifies whether the New button is shown in the inline lookup. For internal use only.

• <IsPassword> (FormXml)
  Formats a string attribute field so that the password is hidden when data is typed in the field.

• <IsTitle> (FormXml)
  For internal use only

• <IsUserChart> (FormXml)
  Specifies that the chart displayed is owned by a user rather than by the system.

• <IsUserView> (FormXml)
  Specifies that the view displayed is owned by a user rather than by the system.

• <isvresources> (FormXml)
  Contains form resources specified by independent software vendors.

• <label> (FormXml)
  Defines label text for a specified language.

• <labels> (FormXml)
  Contains form label definitions.

• <Library> (FormXml)
  Specifies a JavaScript library that is available to the form.

• <LinkControlDefinitionId> (FormXml)
  Defines the link control XML to be loaded for the associated flyout definition.

• <LocalizedName> (FormXml)
  Specifies a name for the form in a specified language.

• <LocalizedNames> (FormXml)
  Contains names of the form for different languages.

• <MaxLength> (FormXml)
  For internal use only

• <MaxRowsBeforeScroll> (FormXml)
  For internal use only.

• <MaxValue> (FormXml)
  For internal use only

• <MinValue> (FormXml)
  For internal use only

• <NavBar> (FormXml)
  Represents a container for items added to the navigation pane in a detail form window.

• <NavBarArea> (FormXml)
  Contains the titles that replace the navigation group labels in the entity form.

• <NavBarAreas> (FormXml)
  Contains the NavBarArea definitions for the entity form.

• <NavBarByRelationshipItem> (FormXml)
  Specifies a navigation item in an entity form that is associated with an entity relationship.

• <NavBarItem> (FormXml)
  Specifies a navigation item to display in a form. Use this element when the navigation item is not associated with an entity relationship.

• <Navigation> (FormXml)
  Contains definitions of navigation options that appear in the form page.

• <NumberOfResults> (FormXml)
  For internal use only

• <OptionSetId> (FormXml)
  For internal use only

• <parameters> (FormXml)
  Contains the parameters to be passed to a control in a form.

• <parameters> Custom Control (FormXml)
  Contains the parameters to be passed for a custom control.

• <PassParameters> (FormXml)
  A parameter for IFrame and Web Resource controls that specifies that a set of context parameters will be passed in a query string to the URL of the control.

• <Precision> (FormXml)
  For internal use only

• <Preload> (FormXml)
  A parameter for IFrame or Web Resource controls. For internal use only.

• <Privilege> (FormXml)
  Specifies a permission that a user must possess in order for the parent navigation item to be displayed in the form.

• <Privileges> (FormXml)
  Contains the set of rights that a user needs in order for the navigation item to display in the form.

• <PromptAreaCollapsed> (FormXml)
  Specifies whether to show the Prompt Area collapsed in the report.

• <querystringparameter> (FormXml)
  Specifies a query string parameter signature that will be allowed for a form.

• <RecordsPerPage> (FormXml)
  Sets the number of records to display per page. This is a parameter for sub-grid controls.

• <ReferencePanelQuickFormCollectionIconUrl> (FormXml)
  For internal use only.

• <RelationshipName> (FormXml)
  Specifies a relationship to be used by a sub-grid control.

• <RelationshipRoleOrdinal> (FormXml)
  Sets the direction of a Connection Role relationship. This is a parameter for sub-grid controls.

• <ReportId> (FormXml)
  Specifies the report to display.

• <ResolveEmailAddress> (FormXml)
  Specifies whether the lookup control should attempt to resolve an email address for the text displayed in the window.

• <RibbonDiffXml> (FormXml)
  Specifies custom ribbon actions for a form.

• <Role> (FormXml)
  Specifies a security role that a user must be associated with to view a form.

• <row> (FormXml)
  Specifies a row used to organize form elements.

• <rows> (FormXml)
  Specifies rows used to compose form layout.

• <Scrolling> (FormXml)
  Specifies the scrolling behavior of the IFrame. This is a parameter for IFrame, Web resource, and report controls.

• <SearchForAutoSuggestionsUsing> (FormXml)
  For internal use only

• <section> (FormXml)
  Specifies a section within a form.

• <sections> (FormXml)
  Contains the definitions of sections used in the form layout.

• <Security> (FormXml)
  Indicates whether cross-site scripting restrictions are applied. This is a parameter for IFrame controls.

• <SelectPrimaryCustomer> (FormXml)
  For internal use only

• <ShowArticleTab> (FormXml)
  For internal use only

• <ShowContextualActions> (FormXml)
  For internal use only

• <ShowDepartmentFilter> (FormXml)
  For internal use only

• <ShowInROF> (FormXml)
  (Deprecated) Indicated whether this web resource would be displayed in a read-optimized form.

• <ShowLanguageFilter> (FormXml)
  For internal use only

• <ShowLinkControlLabel> (FormXml)
  For internal use only.

• <ShowOnMobileClient> (FormXml)
  Indicates whether the Iframe or web resource control is displayed for entity forms and dashboards in Microsoft Dynamics Dynamics 365 for tablets.

• <SizeType> (FormXml)
  Specifies how the web resource should be sized to fit in the form.

• <SnapshotId> (FormXml)
  A parameter for report controls.

• <SuccessConditionName> (FormXml)
  Specifies the field used by the SLA timer control to check for success condition.

• <SuccessConditionValue> (FormXml)
  Specifies the value used by the SLA timer control when determining success.

• <systemform> (FormXml)
  Contains the definition of a form and supporting data.

• <tab> (FormXml)
  Specifies a tab element in the organization of a form.

• <tabs> (FormXml)
  Contains the tab definitions for a form.

• <TargetEntities> (FormXml)
  For internal use only

• <TargetEntity> (FormXml)
  For internal use only

• <TargetEntityType> (FormXml)
  Specifies the entity records to be displayed in the sub-grid.

• <TeamTemplateId> (FormXml)
  For internal use only.

• <Title> (FormXml)
  Specifies the text for a title for a specific language.

• <Titles> (FormXml)
  Contains definitions of Title elements.

• <ToolTip> (FormXml)
  Specifies the text to display for a tooltip in a navigation item for a form.

• <UnboundLookupControlType> (FormXml)
  For internal use only

• <UnboundLookupBrowse> (FormXml)
  For internal use only

• <UnboundLookupTypes> (FormXml)
  For internal use only

• <Url> (FormXml)
  A parameter for IFrame and Web resource controls that specifies the location of the page or HTML Web resource to open.

• <VerticalAlignment> (FormXml)
  Specifies the horizontal alignment of image Web resources.

• <ViewId> (FormXml)
  Specifies the view to be used as the data source for the sub-grid.

• <ViewIds> (FormXml)
  Specifies the views to be available for selection in the sub-grid.

• <ViewPickerReadOnly> (FormXml)
  Specifies if enabling or disabling the view picker is allowed by the form editor.

• <VisualizationId> (FormXml)
  Sets the default chart when chart selection is not enabled.

• <WarningConditionName> (FormXml)
  Specifies the field used by the SLA timer control to check for warning condition.

• <WarningConditionValue> (FormXml)
  Specifies the value used by the SLA timer control when determining warning.

• <webresource> (FormXml)
  Specifies a Web resource to be available to the form.

• <Width> (FormXml)
  A parameter for web resource controls. When a web resource for an image uses the Specific parameter, this parameter provides the width value.

Related Sections

Customize entity forms

Form XML schema

Edit the customizations XML file with schema validation

When to edit the customizations file

Customization XML reference

Ribbon XML reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright