Ribbon Page Group

• May 22, 2020
• 3 minutes to read

 

Ribbon Page Group

A Ribbon Page Group represents a group of bar item links within a Ribbon Page. Groups are used to combine commands that have certain features in common.

A Ribbon Page Group is represented by the RibbonPageGroup component. To add page groups to a page, add RibbonPageGroup objects to the RibbonPage.Groups collection. In XAML, you can define groups directly between the RibbonPage start and end tags.

A Ribbon page group's children are bar item links. To add items to a group, use the RibbonPageGroup.ItemLinks collection. In XAML you can define bar item link objects directly between the RibbonPageGroup start and end tags.

NOTE

In XAML, a RibbonControl and RibbonStatusBarControl must be created within a BarManager object. Bar items to be used within the RibbonControl/RibbonStatusBarControl must be defined in the BarManager's BarManager.Items collection.

For each bar item, you can assign large and small icons. Large icons are used by default if there is enough space within a group. However, when the group's region becomes smaller, large icons are automatically replaced with small icons, and text is hidden if necessary. If the group's size is reduced so it can no longer display all of its links at one time, the group is collapsed. To prevent a page group from being collapsed, set its RibbonPageGroup.AllowCollapse property to false.

Clicking a collapsed group's Dropdown button invokes a popup that contains the group's contents.

Bar Item Link Arrangement Rules

There are several bar item link arrangement principles used by RibbonControl. You will want to familiarize yourself with these principles to better arrange bar item links in your application.

• For each bar item that represents a button or sub-menu, you can assign both large and small images. By default, such an item can be displayed using a large image with text, a small image with text and a small image without text. The BarItemLink.RibbonStyle property allows you to control which of these options are available.
• If both large and small images are assigned to a bar item, the large image is used by default (if there is enough space to display it). Small images are used when the group's region is too small to display large images.
• If a bar item link is represented by a large image, no other link can be displayed above or below it.
• Only one, two or three bar item links with small images can be arranged vertically within a group.

Examples

• How to: Define a default ribbon category with commands