<DisplayRule> (RibbonDiffXml)
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Specifies either the definition of a rule used to display a ribbon element or a reference to a DisplayRule from a command definition.
Note |
|---|
The DisplayRule element child elements are only valid when it is a grandchild of <RuleDefinitions> (RibbonDiffXml). |
<CommandDefinition> <DisplayRules> <DisplayRule Id="String" /> </DisplayRules> </CommandDefinition>
<RuleDefinitions> <DisplayRules> <DisplayRule Id="String"> <CommandClientTypeRule /> <CrmClientTypeRule /> <CrmOfflineAccessStateRule /> <CrmOutlookClientTypeRule /> <CrmOutlookClientVersionRule /> <EntityPrivilegeRule /> <EntityPropertyRule /> <EntityRule /> <FormEntityContextRule /> <FormStateRule /> <FormTypeRule /> <HideForTabletExperienceRule /> <MiscellaneousPrivilegeRule /> <OptionSetRule /> <OrganizationSettingRule /> <OrRule /> <OutlookRenderTypeRule /> <OutlookVersionRule /> <PageRule /> <ReferencingAttributeRequiredRule /> <RelationshipTypeRule /> <SkuRule /> <ValueRule /> </DisplayRule> </DisplayRules> </RuleDefinitions>
Attributes and Elements
The following table lists the attributes, child elements, and parent elements.
Attributes
Attribute | Description | Type | Usage |
|---|---|---|---|
Id | Either:
| String | Required |
Child Elements
Element | Description |
|---|---|
Specifies a rule that detects the type of presentation being used. | |
Specifies a rule that detects the type of Microsoft Dynamics 365 client. | |
Specifies a rule that detects the type of Microsoft Dynamics Dynamics 365 for Microsoft Office Outlook client. | |
Specifies a rule that can be used to detect whether Microsoft Dynamics 365 for Outlook with Offline Access is currently operating offline. | |
Specifies a rule that can detect the current user's permissions for a specific entity. | |
Specifies a rule that can detect specific Boolean entity properties. | |
Specifies a rule that can detect whether a specific entity is in context. | |
Specifies a rule that can detect whether a form ribbon is displayed in the context of a specific entity. | |
Specifies a rule that can detect the state of the form. | |
Specifies a rule that detects the type of Microsoft Dynamics 365 form. | |
Specifies a rule that will return false when the web application is viewed in a mobile browser on a tablet device. | |
Specifies a rule that can detect whether the user possesses a specific Microsoft Dynamics 365 privilege. | |
For internal use only. | |
A rule that can detect two specific organization settings within a DisplayRule. | |
A rule that contains a collection of rules so that this rule will evaluate as true if any of the rules in the collection evaluates as true. | |
A rule that can detect whether a form or list item is rendered as a web page or natively in Outlook in order to determine if a ribbon element should be displayed. | |
A rule that detects the version of Microsoft Office Outlook client. | |
A rule that evaluates the address of the current page. | |
A rule that detects whether the referencing attribute for an entity is required. | |
A rule that detects whether a specific type of formal entity relationship exists between two entities. | |
A rule that detects the Microsoft Dynamics 365 edition. | |
A rule that detects the value of a specific field. |
Parent Elements
Element | Description |
|---|---|
Contains a collection of display rules. |
The <DisplayRules> (RibbonDiffXml) element is used as a child of <RuleDefinitions> (RibbonDiffXml) and <CommandDefinition> (RibbonDiffXml). When the DisplayRule element is a grandchild of RuleDefinitions it defines a rule and supports a variety of child rule elements. When DisplayRule is a grandchild of CommandDefinition, it simply references the DisplayRule definition using the Id attribute.
Element Information
XPath |
//RibbonDiffXml/CommandDefinitions/CommandDefinition/DisplayRules/DisplayRule | //RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule |
Schema Name |
|
Validation File | RibbonTypes.xsd |
Can be Empty | When a grandchild of <CommandDefinition> (RibbonDiffXml) |
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright
