<ReferencingAttributeRequiredRule> (RibbonDiffXml)

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

<ReferencingAttributeRequiredRule 
 Default=["0" | "1" | "true" | "false"]
 InvertResult=["0" | "1" | "true" | "false"]
 />

Attributes and Elements

The following describes 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

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.

This is a very specific rule for a very specific case. Use this rule when there is a relationship bound subgrid or an associated grid on the page. This rule will test whether the referencing attribute used in the relationship is required. This rule is used to hide the Add Existing <record type> button when it isn’t appropriate to display it.

In an entity relationship the lookup field in the related record (the referencing attribute) may be required or not. For example, the Regarding field of an activity is not required yet the Potential Customer field of an opportunity is required. The Add Existing Activity button will set the Regarding field value to the current record context and it can only work if the Regarding field doesn’t already have a value. All Opportunity records have a value in their Potential Customer field, so it never makes sense to display an Add Existing Opportunity button. This rule detects that the referencing attribute is required and therefore returns true.

Element Information

XPath


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

Schema Name

ReferencingAttributeRequiredRuleType

Validation File

RibbonTypes.xsd

Can be Empty

Yes

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: