RibbonControl.Pages Property

Provides access to the Ribbon Control’s main pages.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[Browsable(false)]
[XtraSerializableProperty(false, true, false)]
public RibbonPageCollection Pages { get; }

VB.NET

<Browsable(False)>
<XtraSerializableProperty(False, True, False)>
Public ReadOnly Property Pages As RibbonPageCollection

Property Value

Type	Description
RibbonPageCollection	A RibbonPageCollection object that represents the collection of main pages.

Remarks

The RibbonControl’s pages belong to either the default or custom page categories. Pages that belong to the default category are considered to be the main pages of a Ribbon application, while pages that belong to custom categories are designed to provide context dependant commands. These pages should not be visible all the time, but displayed only when necessary.

The Pages collection stores “main” pages, that belong to the default category. These pages are also called unassigned, as they are not explicitly associated with any custom category. The default category can be accessed via the RibbonControl.DefaultPageCategory property. Its RibbonPageCategory.Pages property returns the collection of unassigned pages, the same value as the Pages property.

Use the Pages property to add, remove or access the RibbonControl’s “main” pages.

The Ribbon Control also allows contextual tab pages to be implemented, as in the Microsoft Office 2007 UI. To create a contextual tab page, first create a custom category (a RibbonPageCategory object) and add it to the RibbonControl.PageCategories property. Then create a Ribbon page, that will represent the contextual tab, and add it to the category’s RibbonPageCategory.Pages collection. See Categories and Contextual Tabs to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Pages property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-merge-end-user-designer-ribbon-to-the-mdi-parent-form-ribbon-e1479/CS/RibbonForm1.cs#L41

    designerForm.RibbonControl.SelectedPage = designerForm.RibbonControl.Pages[ribbon.SelectedPage.Text];
}

protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017/CS/ReadOnlyRangesInCodeExample/Form1.cs#L18

InitializeComponent();
ribbonControl1.SelectedPage = ribbonControl1.Pages[1];
myUserList.AddRange(new MyUser[]{

how-to-customize-a-message-dialog-displayed-when-runtime-errors-occur-e5052/CS/MessageBoxServiceExample/Form1.cs#L11

InitializeComponent();
ribbonControl1.SelectedPage = ribbonControl1.Pages["Test"];
#region #replaceservice

utility-for-creating-a-mail-merge-template-e3661/CS/Form1.cs#L29

    }
    ribbonControl1.SelectedPage = ribbonControl1.Pages["Mailings"];
}

VB.NET

Reporting_how-to-merge-end-user-designer-ribbon-to-the-mdi-parent-form-ribbon-e1479/VB/RibbonForm1.vb#L41

    designerForm.RibbonControl.SelectedPage = designerForm.RibbonControl.Pages(ribbon.SelectedPage.Text)
End Sub

how-to-customize-a-message-dialog-displayed-when-runtime-errors-occur-e5052/VB/MessageBoxServiceExample/Form1.vb#L10

            InitializeComponent()
            ribbonControl1.SelectedPage = ribbonControl1.Pages("Test")
'            #Region "#replaceservice"

utility-for-creating-a-mail-merge-template-e3661/VB/Form1.vb#L31

    End Using
    ribbonControl1.SelectedPage = ribbonControl1.Pages("Mailings")
End Sub