<CommandUIDefinition> (RibbonDiffXml)

 

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

Specifies the visible Ribbon elements to be included within a CustomAction element.

Syntax

<CommandUIDefinition >
[
 <Button /> |
 <CheckBox /> |
 <ComboBox /> |
 <ColorPicker /> |
 <ContextualGroup /> |
 <Controls /> |
 <DropDown /> |
 <FlyoutAnchor /> |
 <Gallery /> |
 <GalleryButton /> |
 <GroupTemplate /> |
 <Group /> |
 <Groups /> |
 <InsertTable /> |
 <Label /> |
 <MRUSplitButton /> |
 <MaxSize /> |
 <Menu /> |
 <MenuSection /> |
 <Scale /> |
 <Scaling /> |
 <Spinner /> |
 <SplitButton /> |
 <Tab /> |
 <TextBox /> |
 <ToggleButton />
]
</CommandUIDefinition>

Attributes and Elements

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

Attributes

This element has no attributes.

Child Elements

Element

Description

<Button> (RibbonDiffXml)

Specifies a simple button used to perform an action.

<CheckBox> (RibbonDiffXml)

Specifies a check box used to select an option.

<ComboBox> (RibbonDiffXml)

Deprecated: Specified a list used to select a value by clicking or typing.

<ColorPicker> (RibbonDiffXml)

Deprecated: Specified a grid used to select a color or style.

<ContextualGroup> (RibbonDiffXml)

Contains a collection of tabs to be displayed within a specific context.

<Controls> (RibbonDiffXml)

Contains a collection of controls.

<DropDown> (RibbonDiffXml)

Deprecated: Specified a list used to select a value by clicking.

<FlyoutAnchor> (RibbonDiffXml)

Specifies a button with a down arrow used to open a menu.

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

<GroupTemplate> (RibbonDiffXml)

Specifies a collection of layout definitions that a group can use when the ribbon width changes.

<Group> (RibbonDiffXml)

Specifies a group of controls within a tab that share a common layout template.

<Groups> (RibbonDiffXml)

Contains a collection of Group elements.

<InsertTable> (RibbonDiffXml)

Deprecated: Specified a 10 by 10 grid used to specify the dimensions of a table.

<Label> (RibbonDiffXml)

Specifies a line of text used to provide information.

<MRUSplitButton> (RibbonDiffXml)

Deprecated: Specified a split button control that displays Most Recently Used items.

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

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

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

<Tab> (RibbonDiffXml)

Specifies a tab in the ribbon.

<TextBox> (RibbonDiffXml)

Deprecated: Specified a control used to enter text.

<ToggleButton> (RibbonDiffXml)

Specifies a button used to toggle between an on and off state.

Parent Elements

Element

Description

<CustomAction> (RibbonDiffXml)

Defines an action to add or replace items in the ribbon.

Element Information

XPath

//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition

Schema Name

CommandUIDefinition

Validation File

RibbonCore.xsd

Can be Empty

No

See Also

Customize commands and the ribbon
Ribbon XML reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright