Microsoft TechNet

United States (English) Sign in

Print This Topic Print Multiple Topics

Home Library Wiki Learn Gallery Downloads Support Forums Blogs

TechNet Library

Microsoft Dynamics CRM

Microsoft Dynamics CRM 2011

Software Development Kit

Software Development Kit for Microsoft Dynamics CRM

Customize Microsoft Dynamics CRM

Customize the Ribbon

Ribbon XML Reference

<Actions> (RibbonDiffXml)

<BoolParameter> (RibbonDiffXml)

<Button> (RibbonDiffXml)

<CheckBox> (RibbonDiffXml)

<Color> (RibbonDiffXml)

<ColorPicker> (RibbonDiffXml)

<Colors> (RibbonDiffXml)

<ComboBox> (RibbonDiffXml)

<CommandDefinition> (RibbonDiffXml)

<CommandDefinitions> (RibbonDiffXml)

<CommandUIDefinition> (RibbonDiffXml)

<ContextualGroup> (RibbonDiffXml)

<ControlRef> (RibbonDiffXml)

<Controls> (RibbonDiffXml)

<CrmClientTypeRule> (RibbonDiffXml)

<CrmOfflineAccessStateRule> (RibbonDiffXml)

<CrmOutlookClientTypeRule> (RibbonDiffXml)

<CrmOutlookClientVersionRule> (RibbonDiffXml)

<CrmParameter> (RibbonDiffXml)

<CustomAction> (RibbonDiffXml)

<CustomActions> (RibbonDiffXml)

<CustomRule> (RibbonDiffXml)

<DecimalParameter> (RibbonDiffXml)

<DisplayRule> (RibbonDiffXml)

<DisplayRules> (RibbonDiffXml)

<DropDown> (RibbonDiffXml)

<EnableRule> (RibbonDiffXml)

<EnableRules> (RibbonDiffXml)

<EntityPrivilegeRule> (RibbonDiffXml)

<EntityPropertyRule> (RibbonDiffXml)

<EntityRule> (RibbonDiffXml)

<FlyoutAnchor> (RibbonDiffXml)

<FormEntityContextRule> (RibbonDiffXml)

<FormStateRule> (RibbonDiffXml)

<Gallery> (RibbonDiffXml)

<GalleryButton> (RibbonDiffXml)

<Group> (RibbonDiffXml)

<Groups> (RibbonDiffXml)

<GroupTemplate> (RibbonDiffXml)

<HideCustomAction> (RibbonDiffXml)

<InsertTable> (RibbonDiffXml)

<IntParameter> (RibbonDiffXml)

<JavaScriptFunction> (RibbonDiffXml)

<Label> (RibbonDiffXml)

<Layout> (RibbonDiffXml)

<LocLabel> (RibbonDiffXml)

<LocLabels> (RibbonDiffXml)

<LowScaleWarning> (RibbonDiffXml)

<MaxSize> (RibbonDiffXml)

<Menu> (RibbonDiffXml)

<MenuSection> (RibbonDiffXml)

<MiscellaneousPrivilegeRule> (RibbonDiffXml)

<MRUSplitButton> (RibbonDiffXml)

<Or> (RibbonDiffXml)

<OrganizationSettingRule> (RibbonDiffXml)

<OrRule> (RibbonDiffXml)

<OutlookCommand> (RibbonDiffXml)

<OutlookItemTrackingRule> (RibbonDiffXml)

<OutlookRenderTypeRule> (RibbonDiffXml)

<OutlookVersionRule> (RibbonDiffXml)

<OverflowArea> (RibbonDiffXml)

<OverflowSection> (RibbonDiffXml)

<PageRule> (RibbonDiffXml)

<RecordPrivilegeRule> (RibbonDiffXml)

<ReferencingAttributeRequiredRule> (RibbonDiffXml)

<RelationshipTypeRule> (RibbonDiffXml)

<RibbonDiffXml> (RibbonDiffXml)

<RibbonNotSupported> (RibbonDiffXml)

<RibbonTemplates> (RibbonDiffXml)

<Row> (RibbonDiffXml)

<RuleDefinitions> (RibbonDiffXml)

<Scale> (RibbonDiffXml)

<Scaling> (RibbonDiffXml)

<Section> (RibbonDiffXml)

<SelectionCountRule> (RibbonDiffXml)

<SkuRule> (RibbonDiffXml)

<Spinner> (RibbonDiffXml)

<SplitButton> (RibbonDiffXml)

<StringParameter> (RibbonDiffXml)

<Strip> (RibbonDiffXml)

<Tab> (RibbonDiffXml)

<TabDisplayRule> (RibbonDiffXml)

<TabDisplayRules> (RibbonDiffXml)

<Templates> (RibbonDiffXml)

<TextBox> (RibbonDiffXml)

<Title> (RibbonDiffXml)

<Titles> (RibbonDiffXml)

<ToggleButton> (RibbonDiffXml)

<Unit> (RibbonDiffXml)

<UnitAbbreviation> (RibbonDiffXml)

<Url> (RibbonDiffXml)

<ValueRule> (RibbonDiffXml)

Minimize

This topic has not yet been rated - Rate this topic

<PageRule> (RibbonDiffXml)

[Applies to: Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online]

A rule that evaluates the address of the current page.

<PageRule 
 Address="String" 
 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
Address	The address of the page to evaluate. It should be a relative path to the page. Only Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online pages can be evaluated.	String	Required
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.
<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.
<TabDisplayRule> (RibbonDiffXml)	Specifies conditions when a tab will display.
<Or> (RibbonDiffXml)	Specifies a set of rules that must be evaluated together.

Only Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online pages can be evaluated to apply a page rule. External pages or HTML Web resources cannot be used.

Element Information

XPath	Copy //RibbonDiffXml/RuleDefinitions/TabDisplayRules/TabDisplayRule/PageRule \| //RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/PageRule \| //RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/PageRule \| //RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/OrRule/Or/PageRule \| //RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/OrRule/Or/PageRule
Schema Name	PageRuleType
Validation File	RibbonTypes.xsd
Can be Empty	Yes

Other Resources

Customize the Ribbon

Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2012 Microsoft Corporation. All rights reserved.

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

© 2013 Microsoft

Manage Your Profile

|

Site Feedback

© 2013 Microsoft. All rights reserved.