Export (0) Print
Expand All
Expand Minimize

<DisplayRule> (RibbonDiffXml)

Applies To: Microsoft Dynamics CRM 2013, Microsoft 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.

noteNote
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>

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

Attributes

 

Attribute Description Type Usage

Id

Either:

  • A unique identifier for the definition of a Display Rule

  • A reference to the Id value of a definition of a Display Rule.

String

Required

Child Elements

 

Element Description

<CommandClientTypeRule> (RibbonDiffXml)

Specifies a rule that detects the type of presentation being used.

<CrmClientTypeRule> (RibbonDiffXml)

Specifies a rule that detects the type of Microsoft Dynamics CRM client.

<CrmOutlookClientTypeRule> (RibbonDiffXml)

Specifies a rule that detects the type of Microsoft Dynamics CRM for Microsoft Office Outlook client.

<CrmOfflineAccessStateRule> (RibbonDiffXml)

Specifies a rule that can be used to detect whether Microsoft Dynamics CRM for Outlook with Offline Access is currently operating offline.

<EntityPrivilegeRule> (RibbonDiffXml)

Specifies a rule that can detect the current user's permissions for a specific entity.

<EntityPropertyRule> (RibbonDiffXml)

Specifies a rule that can detect specific Boolean entity properties.

<EntityRule> (RibbonDiffXml)

Specifies a rule that can detect whether a specific entity is in context.

<FormEntityContextRule> (RibbonDiffXml)

Specifies a rule that can detect whether a form ribbon is displayed in the context of a specific entity.

<FormStateRule> (RibbonDiffXml)

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

<FormTypeRule> (RibbonDiffXml)

Specifies a rule that detects the type of Microsoft Dynamics CRM form.

<HideForTabletExperienceRule> (RibbonDiffXml)

Specifies a rule that will return false when the web application is viewed in a mobile browser on a tablet device.

<MiscellaneousPrivilegeRule> (RibbonDiffXml)

Specifies a rule that can detect whether the user possesses a specific Microsoft Dynamics CRM privilege.

<OptionSetRule> (RibbonDiffXml)

For internal use only.

<OrganizationSettingRule> (RibbonDiffXml)

A rule that can detect two specific organization settings within a DisplayRule.

<OrRule> (RibbonDiffXml)

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.

<OutlookRenderTypeRule> (RibbonDiffXml)

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.

<OutlookVersionRule> (RibbonDiffXml)

A rule that detects the version of Microsoft Office Outlook client.

<PageRule> (RibbonDiffXml)

A rule that evaluates the address of the current page.

<ReferencingAttributeRequiredRule> (RibbonDiffXml)

A rule that detects whether the referencing attribute for an entity is required.

<RelationshipTypeRule> (RibbonDiffXml)

A rule that detects whether a specific type of formal entity relationship exists between two entities.

<SkuRule> (RibbonDiffXml)

A rule that detects the Microsoft Dynamics CRM edition.

<ValueRule> (RibbonDiffXml)

A rule that detects the value of a specific field.

Parent Elements

 

Element Description

<DisplayRules> (RibbonDiffXml)

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.

 

XPath

//RibbonDiffXml/CommandDefinitions/CommandDefinition/DisplayRules/DisplayRule |
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule

Schema Name

  • DisplayRulesType/DisplayRule

  • ReferenceDisplayRuleType

Validation File

RibbonTypes.xsd

Can be Empty

When a grandchild of <CommandDefinition> (RibbonDiffXml)

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.
Show:
© 2014 Microsoft