Share via

<EntityPropertyRule> (RibbonDiffXml)

  • Article

 

Applies To: Dynamics CRM 2015

Specifies a rule that can detect specific Boolean entity properties.

Syntax

<EntityPropertyRule 
 AppliesTo=["PrimaryEntity" | " SelectedEntity "]
 Default =["0" | "1" | "true" | "false"]
 EntityName="String" 
 InvertResult =["0" | "1" | "true" | "false"]
 PropertyName=["DuplicateDetectionEnabled" | "GridFiltersEnabled" | "HasStateCode"  | "IsConnectionsEnabled"  | "MailMergeEnabled"  | "WorksWithQueue"  | "HasActivities"  | "IsActivity"  | "IsBusinessProcessEnabled"  | "HasNotes"  | "IsCustomizable"]
 PropertyValue=["0" | "1" | "true" | "false"] 
/>

Attributes and Elements

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

Attributes

Attribute

Description

Type

Usage

AppliesTo

Determines whether the rule applies to the entity record being displayed in the form or entity records being displayed in a sub-grid.

Valid values:

Value

Description

PrimaryEntity

For a form or Subgrid ribbon, the rule applies to the entity displayed in the form. This will option does not apply for a Grid Ribbon.

SelectedEntity

For a Grid or Subgrid ribbon this rule applies to the entity that appears in the grid.

Enumeration

Optional

Default

Sets the default return value for the rule if the actual value cannot be determined.

Boolean

Optional

EntityName

Specifies the entity that this rule will apply to. Use the entity logical name, for example, "new_customentity".

String

Optional

InvertResult

Negates the return value of the rule.

Boolean

Optional

PropertyName

The name of the boolean entity property to check.

Valid values:

Value

Description

DuplicateDetectionEnabled

Allows defining duplicate detection rules with this entity.

GridFiltersEnabled

Corresponds to the IsValidForAdvancedFind property.

HasStateCode

The entity has a Status (statecode) field.

IsConnectionsEnabled

Allows Connections to be established between instances of this entity and other Connections enabled entities.

MailMergeEnabled

The entity allows users to generate mail merge documents.

WorksWithQueue

The entity is enabled to work with queues.

HasActivities

The entity has a relationship with the Activity (activitypointer) entity so that the entity can appear in the Regarding lookup field in Activities.

IsActivity

The entity is defined as an activity.

IsBusinessProcessEnabled

The entity is enabled for business processes.

HasNotes

The entity has a entity relationship with the Note (annotation) entity.

IsCustomizable

The entity provides some degree of customizability.

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.

<Or> (RibbonDiffXml)

Specifies a set of rules that must be evaluated together.

Element Information

XPath

 
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/EntityPropertyRule |
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/OrRule/Or/EntityPropertyRule

Schema Name

EntityPropertyRuleType

Validation File

RibbonTypes.xsd

Can be Empty

Yes

See Also

Ribbon XML reference
Customize commands and the ribbon

© 2016 Microsoft. All rights reserved. Copyright