<FormStateRule> (RibbonDiffXml)

 

Applies To: Dynamics CRM 2013

Specifies a rule that can detect the state of the form.

Syntax

<FormStateRule 
 Default=["0" | "1" | "true" | "false"] 
 InvertResult=["0" | "1" | "true" | "false"] 
 State=["Create" | "Existing" | "ReadOnly"  | "Disabled"  | "BulkEdit"]
/>

Attributes and Elements

The following table lists the attributes, child elements, and parent elements.

Attributes

Attribute	Description	Type	Usage
Default	Sets the default return value for the rule if the actual value cannot be determined.	Boolean	Optional
InvertResult	Negates the return value of the rule.	Boolean	Optional
State	Describes the type of form. These correspond to the values returned by the Xrm.Page.ui (client-side reference).getFormType method. Valid values: Value Description Create Used before a record is saved. Existing Used after a record is saved and the user has access to edit it. ReadOnly Used to display a record that the user cannot edit. Disabled Used when the record is inactive and cannot be edited. BulkEdit Used when many records are updated at once.	Enumeration	Required

Child Elements

This element has no child elements.

Parent Elements

Element	Description
<DisplayRule> (RibbonDiffXml)	Specifies either the definition of a rule used to display a ribbon element or a reference to a DisplayRule from a command definition.
<EnableRule> (RibbonDiffXml)	Specifies either the definition of a rule used to enable or disable a ribbon element or a reference to an EnableRule from a command definition.
<Or> (RibbonDiffXml)	Specifies a set of rules that must be evaluated together.

Element Information

XPath	//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/FormStateRule | //RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/FormStateRule | //RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/OrRule/Or/FormStateRule | //RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/OrRule/Or/FormStateRule
Schema Name	FormStateRuleType
Validation File	RibbonTypes.xsd
Can be Empty	Yes

See Also

Ribbon XML reference
Customize commands and the ribbon