RibbonPageCategoryCollection Class

Represents a collection of RibbonPageCategory objects.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[ListBindable(false)]
public class RibbonPageCategoryCollection :
    CollectionBase,
    IList,
    ICollection,
    IEnumerable

VB.NET

<ListBindable(False)>
Public Class RibbonPageCategoryCollection
    Inherits CollectionBase
    Implements IList,
               ICollection,
               IEnumerable

Related API Members

The following members return RibbonPageCategoryCollection objects:

• RibbonControl.MergedCategories
• RibbonControl.PageCategories
• RibbonPageCategory.Collection

Remarks

This class represents a collection of RibbonPageCategory objects. It provides methods to add, remove and access elements in the collection.

The RibbonControl provides the RibbonControl.PageCategories property representing a collection of custom page categories. Use custom page categories to implement contextual tabs, as in the Microsoft Office 2007 UI. See Categories and Contextual Tabs to learn more.

Example

The following example creates the DevExpress WinForms Ribbon Control with two contextual tabs/pages. The svgImageCollection1 was added and populated with SVG images at design time.

C#

using System.Drawing;
using DevExpress.XtraBars;
using DevExpress.XtraBars.Ribbon;
using DevExpress.XtraEditors;

namespace DXApplication19
{
    public partial class Form1 : XtraForm
    {
        public Form1()
        {
            InitializeComponent();
            // Create a RibbonControl.
            RibbonControl Ribbon = new RibbonControl();
            // Create the 'Home' page.
            RibbonPage pageHome = new RibbonPage("Home");
            Ribbon.Pages.Add(pageHome);
            // Create the 'Selection' page category.
            RibbonPageCategory catSelection = new RibbonPageCategory("Selection", Color.Orange, false);
            Ribbon.PageCategories.Add(catSelection);
            // Create 'Format' an 'Clipboard' contextual pages/tabs in the 'Selection' page category.
            RibbonPage contextPageFormat = new RibbonPage("Format");
            RibbonPage contextPageClipboard = new RibbonPage("Clipboard");
            catSelection.Pages.AddRange(new RibbonPage[] { contextPageFormat, contextPageClipboard });

            // Add the 'Edit' group with two bar items to the 'Format' page.
            RibbonPageGroup groupEdit = new RibbonPageGroup("Edit") { AllowTextClipping = false };
            // Add two bar items to the 'Edit' group.
            BarButtonItem itemCopy = new BarButtonItem(Ribbon.Manager, "Copy"){ RibbonStyle = RibbonItemStyles.Large};
            itemCopy.ImageOptions.SvgImage = svgImageCollection1["copy"];
            BarButtonItem itemCut = new BarButtonItem(Ribbon.Manager, "Cut") { RibbonStyle = RibbonItemStyles.Large };
            itemCut.ImageOptions.SvgImage = svgImageCollection1["cut"];
            groupEdit.ItemLinks.AddRange(new BarItem[] { itemCopy, itemCut });
            contextPageFormat.Groups.Add(groupEdit);
            Ribbon.ItemClick += new ItemClickEventHandler(Ribbon_ItemClick);

            // Add the RibbonControl to the form.
            this.Controls.Add(Ribbon);

            /* Contextual pages are hidden by default.
             * The following line displays the 'Selection' page category.
             */
            catSelection.Visible = true;
            // Activate the 'Format' contextual page/tab.
            Ribbon.SelectedPage = catSelection.Pages["Format"];
        }
        void Ribbon_ItemClick(object sender, ItemClickEventArgs e)
        {
            // Add your code to handle clicks on bar items.
        }
    }
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraBars
Imports DevExpress.XtraBars.Ribbon
Imports DevExpress.XtraEditors

Namespace DXApplication19
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            ' Create a RibbonControl.
            Dim Ribbon As New RibbonControl()
            ' Create the 'Home' page.
            Dim pageHome As New RibbonPage("Home")
            Ribbon.Pages.Add(pageHome)
            ' Create the 'Selection' page category.
            Dim catSelection As New RibbonPageCategory("Selection", Color.Orange, False)
            Ribbon.PageCategories.Add(catSelection)
            ' Create 'Format' an 'Clipboard' contextual pages/tabs in the 'Selection' page category.
            Dim contextPageFormat As New RibbonPage("Format")
            Dim contextPageClipboard As New RibbonPage("Clipboard")
            catSelection.Pages.AddRange(New RibbonPage() { contextPageFormat, contextPageClipboard })

            ' Add the 'Edit' group with two bar items to the 'Format' page.
            Dim groupEdit As New RibbonPageGroup("Edit") With {.AllowTextClipping = False}
            ' Add two bar items to the 'Edit' group.
            Dim itemCopy As New BarButtonItem(Ribbon.Manager, "Copy") With {.RibbonStyle = RibbonItemStyles.Large}
            itemCopy.ImageOptions.SvgImage = svgImageCollection1("copy")
            Dim itemCut As New BarButtonItem(Ribbon.Manager, "Cut") With {.RibbonStyle = RibbonItemStyles.Large}
            itemCut.ImageOptions.SvgImage = svgImageCollection1("cut")
            groupEdit.ItemLinks.AddRange(New BarItem() { itemCopy, itemCut })
            contextPageFormat.Groups.Add(groupEdit)
            AddHandler Ribbon.ItemClick, AddressOf Ribbon_ItemClick

            ' Add the RibbonControl to the form.
            Me.Controls.Add(Ribbon)

'             Contextual pages are hidden by default.
'             * The following line displays the 'Selection' page category.
'             
            catSelection.Visible = True
            ' Activate the 'Format' contextual page/tab.
            Ribbon.SelectedPage = catSelection.Pages("Format")
        End Sub
        Private Sub Ribbon_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
            ' Add your code to handle clicks on bar items.
        End Sub
    End Class
End Namespace

Inheritance

Object

CollectionBase

RibbonPageCategoryCollection