Ribbon XML reference

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

Use RibbonDiffXml to create declarative definitions of modifications to the default Microsoft Dynamics 365 ribbon.

In This Section

This list provides links to schema information about all the RibbonDiffXml elements.

Reference

• <Actions> (RibbonDiffXml)
  Specifies the actions that a command will perform.

• <BoolParameter> (RibbonDiffXml)
  Specifies a value with a Boolean data type that may be passed as a parameter.

• <Button> (RibbonDiffXml)
  Specifies a simple button used to perform an action.

• <CheckBox> (RibbonDiffXml)
  Specifies a check box used to select an option.

• <Color> (RibbonDiffXml)
  Specifies a color within a collection of colors for a color picker control.

• <ColorPicker> (RibbonDiffXml)
  Deprecated: Specified a grid used to select a color or style.

• <Colors> (RibbonDiffXml)
  Specifies a collection of colors for a color picker control.

• <ComboBox> (RibbonDiffXml)
  Deprecated: Specified a list used to select a value by clicking or typing.

• <CommandClientTypeRule> (RibbonDiffXml)
  Specifies a rule that detects the type of presentation being used.

• <CommandDefinition> (RibbonDiffXml)
  Specifies a set of rules that control how a ribbon element is displayed and actions to perform that can be referenced by ribbon elements and controls.

• <CommandDefinitions> (RibbonDiffXml)
  Contains a collection of commands that can be referenced by ribbon controls.

• <CommandUIDefinition> (RibbonDiffXml)
  Specifies the visible Ribbon elements to be included within a CustomAction element.

• <ContextualGroup> (RibbonDiffXml)
  Contains a collection of tabs to be displayed within a specific context.

• <ControlRef> (RibbonDiffXml)
  Specifies a placeholder for a control within a layout template.

• <Controls> (RibbonDiffXml)
  Contains a collection of controls.

• <CrmClientTypeRule> (RibbonDiffXml)
  Specifies a rule that detects the type of Microsoft Dynamics 365 client.

• <CrmOutlookClientVersionRule> (RibbonDiffXml)
  Detects the version of Microsoft Dynamics 365 for Microsoft Office Outlook.

• <CrmOfflineAccessStateRule> (RibbonDiffXml)
  Specifies a rule that can be used to detect whether Microsoft Dynamics 365 for Outlook with Offline Access is currently operating offline.

• <CrmOutlookClientTypeRule> (RibbonDiffXml)
  Specifies a rule that detects the type of Microsoft Dynamics Dynamics 365 for Microsoft Office Outlook client.

• <CrmParameter> (RibbonDiffXml)
  Represents data retrieved from the Microsoft Dynamics 365 application that may be passed as a parameter.

• <CustomAction> (RibbonDiffXml)
  Defines an action to add or replace items in the ribbon.

• <CustomActions> (RibbonDiffXml)
  Contains a collection of actions that can add, replace, or remove items from the ribbon.

• <CustomRule> (RibbonDiffXml)
  Specifies a rule used with an EnableRule definition that is composed of a reference to a function within a JavaScript library.

• <DecimalParameter> (RibbonDiffXml)
  Specifies a value with a decimal data type that may be passed as a parameter.

• <DeviceTypeRule> (RibbonDiffXml)
  For internal use only.

• <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.

• <DisplayRules> (RibbonDiffXml)
  Contains a collection of display rules.

• <DropDown> (RibbonDiffXml)
  Deprecated: Specified a list used to select a value by clicking.

• <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.

• <EnableRules> (RibbonDiffXml)
  Contains a collection of enable rules.

• <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.

• <FlyoutAnchor> (RibbonDiffXml)
  Specifies a button with a down arrow used to open a menu.

• <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 365 form.

• <Gallery> (RibbonDiffXml)
  Deprecated: Specified a control that displays a collection of related controls in the Ribbon. If there are too many items in the gallery, an expand arrow is provided to display the rest of the collection in a pane.

• <GalleryButton> (RibbonDiffXml)
  Deprecated: Specified a button control within a gallery element.

• <Group> (RibbonDiffXml)
  Specifies a group of controls within a tab that share a common layout template.

• <Groups> (RibbonDiffXml)
  Contains a collection of Group elements.

• <GroupTemplate> (RibbonDiffXml)
  Specifies a collection of layout definitions that a group can use when the ribbon width changes.

• <HideCustomAction> (RibbonDiffXml)
  Removes an existing ribbon element from being processed for the ribbon.

• <HideForTabletExperienceRule> (RibbonDiffXml)
  Specifies a rule that will return false when the web application is viewed in a mobile browser on a tablet device.

• <HideIfExportToExcelNotEnabledRule> (RibbonDiffXml)
  For internal use only.

• <InsertTable> (RibbonDiffXml)
  Deprecated: Specified a 10 by 10 grid used to specify the dimensions of a table.

• <IntParameter> (RibbonDiffXml)
  Specifies a value with an integer data type that may be passed as a parameter.

• <JavaScriptFunction> (RibbonDiffXml)
  Specifies an action that calls a function from a specific JavaScript library.

• <Label> (RibbonDiffXml)
  Specifies a line of text used to provide information.

• <Layout> (RibbonDiffXml)
  Specifies a layout for a Group within a GroupTemplate.

• <LocLabel> (RibbonDiffXml)
  Specifies a text string associated with a language code.

• <LocLabels> (RibbonDiffXml)
  Contains a collection of LocLabel elements.

• <LowScaleWarning> (RibbonDiffXml)
  For internal use only.

• <MaxSize> (RibbonDiffXml)
  Defines the largest layout possible for a group.

• <Menu> (RibbonDiffXml)
  Specifies a container used to show pop-up menus.

• <MenuSection> (RibbonDiffXml)
  Specifies a section used to divide a menu. A menu section can have a title and contain controls.

• <MiscellaneousPrivilegeRule> (RibbonDiffXml)
  Specifies a rule that can detect whether the user possesses a specific Microsoft Dynamics 365 privilege.

• <MRUSplitButton> (RibbonDiffXml)
  Deprecated: Specified a split button control that displays Most Recently Used items.

• <Or> (RibbonDiffXml)
  Specifies a set of rules that must be evaluated together.

• <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.

• <OutlookCommand> (RibbonDiffXml)
  For internal use only.

• <OutlookItemTrackingRule> (RibbonDiffXml)
  A rule that detects whether the item is enabled for items tracked in Microsoft Dynamics 365 in order to enable a ribbon element.

• <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.

• <OverflowArea> (RibbonDiffXml)
  Defines an area where multiple controls can render as a list.

• <OverflowSection> (RibbonDiffXml)
  Specifies a division of a Layout which allows controls to change relative position depending on the available space.

• <PageRule> (RibbonDiffXml)
  A rule that evaluates the address of the current page.

• <RecordPrivilegeRule> (RibbonDiffXml)
  A rule that detects a user’s privileges for a specific record in order to enable a ribbon element.

• <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.

• <RibbonDiffXml> (RibbonDiffXml)
  The root element for all the elements that define custom ribbons.

• <RibbonNotSupported> (RibbonDiffXml)
  An element included with the RibbbonDiffXml for an entity to indicate that the entity does not support the ribbon.

• <RibbonTemplates> (RibbonDiffXml)
  Contains a collection of group templates.

• <Row> (RibbonDiffXml)
  Specifies a row within a Section.

• <RuleDefinitions> (RibbonDiffXml)
  Contains a collection of rule definitions.

• <Scale> (RibbonDiffXml)
  Specifies one of the possible layouts that may be used by a group when the maximum size layout cannot be displayed.

• <Scaling> (RibbonDiffXml)
  Contains a collection of elements used to define how ribbon groups are presented when the horizontal space available changes.

• <Section> (RibbonDiffXml)
  Contains a collection of rows.

• <SelectionCountRule> (RibbonDiffXml)
  A rule that detects how many items in a grid are selected.

• <SkuRule> (RibbonDiffXml)
  A rule that detects the Microsoft Dynamics 365 edition.

• <Spinner> (RibbonDiffXml)
  Specifies a control used to insert a value by typing or using the arrow keys to cycle through the values.

• <SplitButton> (RibbonDiffXml)
  Specifies a control used as both a button and a menu.

• <StringParameter> (RibbonDiffXml)
  Specifies a value with a string data type that may be passed as a parameter.

• <Strip> (RibbonDiffXml)
  Contains a collection of control references.

• <Tab> (RibbonDiffXml)
  Specifies a tab in the ribbon.

• <TabDisplayRule> (RibbonDiffXml)
  Specifies conditions when a tab will display.

• <TabDisplayRules> (RibbonDiffXml)
  Contains a collection of TabDisplayRule elements.

• <Templates> (RibbonDiffXml)
  Contains a collection of ribbon templates.

• <TextBox> (RibbonDiffXml)
  Deprecated: Specified a control used to enter text.

• <Title> (RibbonDiffXml)
  Specifies title text for a specific language.

• <Titles> (RibbonDiffXml)
  Contains a collection of title elements.

• <ToggleButton> (RibbonDiffXml)
  Specifies a button used to toggle between an on and off state.

• <Unit> (RibbonDiffXml)
  Specifies a unit in a spinner control.

• <UnitAbbreviation> (RibbonDiffXml)
  Specifies an abbreviation for a unit.

• <Url> (RibbonDiffXml)
  An action that opens a web page at a specified address.

• <ValueRule> (RibbonDiffXml)
  A rule that detects the value of a specific field.

See Also

Customize commands and the ribbon
Sample: Export ribbon definitions
Ribbon core schema
Customization XML reference
Server Ribbon in SharePoint Foundation

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright