<parameters> (FormXml)

Article
07/22/2016

Applies To: Dynamics CRM 2015

Contains the parameters to be passed to a control in a form.

Syntax

<parameters>
 <!-- For Lookup controls-->
 <AllowFilterOff />
 <AutoResolve />
 <AvailableViewIds />
 <DefaultViewId />
 <DefaultViewReadOnly />
 <DependentAttributeName />
 <DependentAttributeType />
 <DisableMru />
 <DisableQuickFind />
 <DisableViewPicker />
 <EntityLogicalName/>
 <FilterRelationshipName />
 <InlineViewIds/>
 <IsInlineNewEnabled/>
 <ResolveEmailAddress />
 <UnboundLookupBrowse />
 <UnboundLookupControlType />
 <UnboundLookupStyle />
 <UnboundLookupTypes />
 <ViewPickerReadOnly />

 <!-- For Link Control-->
 <LinkControlDefinitionId/>
 <ShowLinkControlLabel />
 <!-- For IFrame or Web resource controls-->
 <Border />
 <IsPassword />
 <PassParameters />
 <Preload />
 <Scrolling /><!-- For Reports too-->
 <ShowOnMobileClient/>
 <Security /><!-- For IFrame controls only-->
 <Url />
 <!-- For Web resource controls-->
 <AltText />
 <Data />
 <Height />
 <HorizontalAlignment />
 <ShowInROF/>
 <SizeType />
 <VerticalAlignment />
 <Width />

 <!-- For Sub-Grid controls-->
 <AutoExpand />
 <ChartGridMode />
 <EnableChartPicker />
 <EnableContextualActions/>
 <EnableJumpBar />
 <EnableQuickFind />
 <EnableViewPicker />
 <IsUserChart />
 <IsUserView />
 <MaxRowsBeforeScroll>
 <RecordsPerPage />
 <RelationshipName />
 <RelationshipRoleOrdinal />
 <TargetEntityType />
 <TeamTemplateId />
 <ViewId />
 <ViewIds />
 <VisualizationId />
 <!-- For Reports -->
 <PromptAreaCollapsed />
 <ReportId />
 <SnapshotId />

<!-- For Bing Maps  -->
 <AddressField />

<!-- For SLA Timer  -->
 <FailureTimeField />
<FailureConditionName />
<FailureConditionValue />
<SuccessConditionName />
<SuccessConditionValue />
<WarningConditionName />
<WarningConditionValue />
<CancelConditionName />
<CancelConditionValue />

</parameters>

Attributes and Elements

The following describes the attributes, child elements, and parent elements.

Attributes

This element has no attributes.

Child Elements

Element	Description
<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.
<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)	Specifies the views to be available for selection in the sub-grid.
<Border> (FormXml)	A parameter for IFrame or web resource controls. The value of this element specifies whether to display a border around the control.
<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.
<ChartGridMode> (FormXml)	Specifies whether the sub-grid displays a chart, a grid, or both.
<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.
<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.
<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.
<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.
<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
<Format> (FormXml)	For internal use only
<Height> (FormXml)	Provides the height value, when a Web resource for an image uses the Specific parameter.
<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.
<IsColorValue> (FormXml)	For internal use only
<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.
<LinkControlDefinitionId> (FormXml)	Defines the link control XML to be loaded for the associated flyout definition.
<MaxLength> (FormXml)	For internal use only
<MaxRowsBeforeScroll> (FormXml)	For internal use only.
<MaxValue> (FormXml)	For internal use only
<MinValue> (FormXml)	For internal use only
<NumberOfResults> (FormXml)	For internal use only
<OptionSetId> (FormXml)	For internal use only
<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.
<PromptAreaCollapsed> (FormXml)	Specifies whether to show the Prompt Area collapsed in the report.


<RecordsPerPage> (FormXml)	Sets the number of records to display per page. This is a parameter for sub-grid controls.
<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.
<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
<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
<ShowLanguageFilter> (FormXml)	For internal use only
<ShowLinkControlLabel> (FormXml)	For internal use only.
<ShowInROF> (FormXml)	(Deprecated) Indicated whether this web resource would be displayed in a read-optimized form.
<ShowOnMobileClient> (FormXml)	Indicates whether the Iframe or web resource control is displayed for entity forms and dashboards in Microsoft Dynamics CRM 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.
<TargetEntities> (FormXml)	For internal use only
<TargetEntityType> (FormXml)	Specifies the entity records to be displayed in the sub-grid.
<TeamTemplateId> (FormXml)	For internal use only.
<UnboundLookupBrowse> (FormXml)	For internal use only.
<UnboundLookupControlType> (FormXml)	For internal use only.
<UnboundLookupStyle> (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.
<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.

Parent Elements

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

Remarks

The parameters element is valid for several different types of controls. Specific child elements are only valid for particular types of controls. The following table breaks out which parameters are valid for each type of control:

Child element	Lookup	Link	IFrame	Web Resource	Sub-Grid	Report	Bing Maps	Timer
AddressField							X
AllowFilterOff	X
AutoResolve	X
AvailableViewIds	X
DefaultViewId	X
DefaultViewReadOnly	X
DependentAttributeName	X
DependentAttributeType	X
DisableMru	X
DisableQuickFind	X
DisableViewPicker	X
EnableContextualActions					X
EntityLogicalName	X
FilterRelationshipName	X
InlineViewIds	X
IsInlineNewEnabled	X
LinkControlDefinitionId		X		X
ShowLinkControlLabel		X
ResolveEmailAddress	X
UnboundLookupBrowse	X
UnboundLookupControlType	X
UnboundLookupStyle	X
UnboundLookupTypes	X
ShowInROF				X
ViewPickerReadOnly	X
Border			X	X
IsPassword			X	X
PassParameters			X	X
Preload			X	X
Scrolling			X	X		X
Security			X
Url			X	X
ShowOnMobileClient			X	X
AltText				X
Data				X
Height				X
HorizontalAlignment				X
SizeType				X
VerticalAlignment				X
Width				X
AutoExpand					X
ChartGridMode					X
EnableChartPicker					X
EnableJumpBar					X
EnableQuickFind					X
EnableViewPicker					X
IsUserChart					X
IsUserView					X
RecordsPerPage					X
RelationshipName					X
RelationshipRoleOrdinal					X
TargetEntityType					X
ViewId					X
ViewIds					X
VisualizationId					X
TeamTemplateId					X
MaxRowsBeforeScroll					X
PromptAreaCollapsed						X
ReportId						X
SnapshotId						X
FailureTimeField								X
SuccessConditionName								X
SuccessConditionValue								X
WarningConditionName								X
WarningConditionValue								X
CancelConditionName								X
CancelConditionValue								X

Example

The following shows an example of parameters.

<control id="IFRAME_sdk" classid="{FD2A7985-3187-444e-908D-6624B21F69C0}">
 <parameters>
  <Url>https://bing.com</Url> 
  <PassParameters>false</PassParameters> 
  <Security>true</Security> 
  <Scrolling>auto</Scrolling> 
  <Border>true</Border> 
 </parameters>
</control>

Element Information

Schema Type	complexType
Validation File	FormXml.xsd
Number of Occurrences	0 or 1
XPath	`//FormXml/forms/systemform/form/tabs/tab/columns/column/sections/section/rows/row/cell/control/parameters`

Share via