A newer version of this page is available. Switch to the current version.

RibbonPageGroup Class

Represents a group within a Ribbon Page.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

[SmartTagSupport(typeof(RibbonPageGroupDesignTimeBoundsProvider), SmartTagSupportAttribute.SmartTagCreationMode.Auto)]
public class RibbonPageGroup :
    BaseRibbonComponent,
    ISupportRibbonKeyTip,
    ISupportMergeOrder,
    IDXImageUriClient,
    ICloneable
<SmartTagSupport(GetType(RibbonPageGroupDesignTimeBoundsProvider), SmartTagSupportAttribute.SmartTagCreationMode.Auto)>
Public Class RibbonPageGroup
    Inherits BaseRibbonComponent
    Implements ISupportRibbonKeyTip,
               ISupportMergeOrder,
               IDXImageUriClient,
               ICloneable

Remarks

The RibbonPageGroup class represents a group within a RibbonPage. All groups owned by a page are specified by the RibbonPage.Groups property. You can use this property to add and remove specific groups.

RibbonPageGroup_TwoGroups

To add commands to the group use the RibbonPageGroup.ItemLinks property.

For more information on groups see Ribbon Page Group.

Examples

This example demonstrates how to create a RibbonControl with one page ("Home") and two page groups ("File" and "File 2").

Ribbon_CreateTwoGroups_Ex

Ribbon commands are called bar items, as they are all derived from the BarItem class. This example creates three bar items - the Open, Close and Print buttons, encapsulated by the BarButtonItem objects. The Close and Print buttons are only added to the first group, while the Open button is added to both of the groups.

When bar items are created in code, ensure the following:

  1. All bar items are added to the RibbonControl.Items collection.

    This example demonstrates three ways of creating bar items while adding them to the RibbonControl.Items collection.

  2. All bar items have their BarItem.Id properties initialized to unique values. This ensures correct functioning of the bar item (de)serialization mechanism.

    The BarItem.Id properties can be initialized with the BarManager.GetNewItemId method accessible from the RibbonControl.Manager object. See the code below.

using DevExpress.XtraBars.Ribbon;
using DevExpress.XtraBars;

// Create a RibbonControl
RibbonControl ribbon = new RibbonControl();
this.Controls.Add(ribbon);
// Assign the image collection that will provide images for bar items.
ribbon.Images = imageCollection1;

// Create a Ribbon page.
RibbonPage page1 = new RibbonPage("Home");
// Create a Ribbon page group.
RibbonPageGroup group1 = new RibbonPageGroup("File");
// Create another Ribbon page group.
RibbonPageGroup group2 = new RibbonPageGroup("File 2");

// Create a button item using the CreateButton method.
// The created item is automatically added to the item collection of the RibbonControl.
BarButtonItem itemOpen = ribbon.Items.CreateButton("Open...");
itemOpen.ImageIndex = 0;
itemOpen.Id = ribbon.Manager.GetNewItemId(); //Ensures correct runtime layout (de)serialization.
itemOpen.ItemClick += new ItemClickEventHandler(itemOpen_ItemClick);

// Create a button item using its constructor.
// The constructor automatically adds the created item to the RibbonControl's item collection.
BarButtonItem itemClose = new BarButtonItem(ribbon.Manager, "Close");
itemClose.ImageIndex = 1;
itemClose.Id = ribbon.Manager.GetNewItemId(); //Ensures correct runtime layout (de)serialization.
itemClose.ItemClick += new ItemClickEventHandler(itemClose_ItemClick);

// Create a button item using the default constructor.
BarButtonItem itemPrint = new BarButtonItem();
// Manually add the created item to the item collection of the RibbonControl.
ribbon.Items.Add(itemPrint);
itemPrint.Caption = "Print";
itemPrint.ImageIndex = 2;
itemPrint.Id = ribbon.Manager.GetNewItemId(); //Ensures correct runtime layout (de)serialization.
itemPrint.ItemClick += new ItemClickEventHandler(itemPrint_ItemClick);

// Add the created items to the group using the AddRange method. 
// This method will create bar item links for the items and then add the links to the group.
group1.ItemLinks.AddRange(new BarItem[] { itemOpen, itemClose, itemPrint });
// Add the Open bar item to the second group.
group2.ItemLinks.Add(itemOpen);
// Add the created groups to the page.
page1.Groups.Add(group1);
page1.Groups.Add(group2);
// Add the page to the RibbonControl.
ribbon.Pages.Add(page1);
//...


void itemPrint_ItemClick(object sender, ItemClickEventArgs e) {
   //...
}

void itemClose_ItemClick(object sender, ItemClickEventArgs e) {
   //...
}

void itemOpen_ItemClick(object sender, ItemClickEventArgs e) {
   //...
}

Inheritance

Object
MarshalByRefObject
Component
DevExpress.XtraBars.BaseBarComponent
DevExpress.XtraBars.Ribbon.BaseRibbonComponent
RibbonPageGroup
See Also