RibbonControl.SelectedPage Property

Gets or sets the currently selected page.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[DefaultValue(null)]
[Browsable(false)]
public RibbonPage SelectedPage { get; set; }

VB.NET

<DefaultValue(Nothing)>
<Browsable(False)>
Public Property SelectedPage As RibbonPage

Property Value

Type	Default	Description
RibbonPage	*null*	A RibbonPage object that represents the page currently selected. null (Nothing in Visual Basic) if the RibbonControl.Pages collection is empty.

Remarks

If the current ribbon is merged with another ribbon as a child, use the RibbonControl.SelectPage method.

Example

The following example demonstrates how to create contextual tab pages in the RibbonControl in code.

In the example, a RibbonControl control is created containing one permanently displayed page (“Home”) and two contextual pages (“Format” and “Clipboard”). The contextual pages are combined into a custom page category (“Selection”).

Contextual pages are hidden when they are created. They are made visible later via the category’s RibbonPageCategory.Visible property.

The following image demonstrates code execution:

C#

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

// Create a RibbonControl.
RibbonControl Ribbon = new RibbonControl();
// Assign a collection of images that will be used by bar items.
Ribbon.Images = imageCollection1;            
// Create a page and associate it with the default category.
RibbonPage pageHome = new RibbonPage("Home");
Ribbon.Pages.Add(pageHome);
// Create a custom Selection page category.
RibbonPageCategory catSelection = new RibbonPageCategory("Selection", Color.LightPink, false);
Ribbon.PageCategories.Add(catSelection);
// Create two contextual pages (Format an Clipboard)in the Selection category.
RibbonPage contextPageFormat = new RibbonPage("Format");
RibbonPage contextPageClipboard = new RibbonPage("Clipboard");
catSelection.Pages.AddRange(new RibbonPage[] {contextPageFormat, contextPageClipboard});

// Customize the Format page by adding a Format group with two bar items to it.
RibbonPageGroup groupFormat = new RibbonPageGroup("Format");
groupFormat.AllowTextClipping = false;
// Add two items to the Format group
BarButtonItem itemCopy = new BarButtonItem(Ribbon.Manager, "Copy", 0);
BarButtonItem itemCut = new BarButtonItem(Ribbon.Manager, "Cut", 1);
groupFormat.ItemLinks.AddRange(new BarItem[] {itemCopy, itemCut});
contextPageFormat.Groups.Add(groupFormat);
// Subscribe to an event which fires when any item is clicked.
Ribbon.ItemClick += new ItemClickEventHandler(Ribbon_ItemClick);

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

//...

// Make the Selection category visible
catSelection.Visible = true;
// Activate the category's first page.
Ribbon.SelectedPage = catSelection.Pages[0];


// Respond to item clicking.
void Ribbon_ItemClick(object sender, ItemClickEventArgs e) {
    //...
}

VB.NET

Imports DevExpress.XtraBars.Ribbon
Imports DevExpress.XtraBars

' Create a RibbonControl.
Dim Ribbon As RibbonControl = New RibbonControl()
' Assign a collection of images that will be used by bar items.
Ribbon.Images = imageCollection1
' Create a page and associate it with the default category.
Dim pageHome As RibbonPage = New RibbonPage("Home")
Ribbon.Pages.Add(pageHome)
' Create a custom Selection page category.
Dim catSelection As RibbonPageCategory = New RibbonPageCategory("Selection", Color.LightPink, False)
Ribbon.PageCategories.Add(catSelection)
' Create two contextual pages (Format an Clipboard)in the Selection category.
Dim contextPageFormat As RibbonPage = New RibbonPage("Format")
Dim contextPageClipboard As RibbonPage = New RibbonPage("Clipboard")
catSelection.Pages.AddRange(New RibbonPage() {contextPageFormat, contextPageClipboard})

' Customize the Format page by adding a Format group with two bar items to it.
Dim groupFormat As RibbonPageGroup = New RibbonPageGroup("Format")
groupFormat.AllowTextClipping = False
' Add two items to the Format group
Dim itemCopy As BarButtonItem = New BarButtonItem(Ribbon.Manager, "Copy", 0)
Dim itemCut As BarButtonItem = New BarButtonItem(Ribbon.Manager, "Cut", 1)
groupFormat.ItemLinks.AddRange(New BarItem() {itemCopy, itemCut})
contextPageFormat.Groups.Add(groupFormat)
' Subscribe to an event which fires when any item is clicked.
AddHandler Ribbon.ItemClick, AddressOf Ribbon_ItemClick
'Ribbon.ItemClick += New ItemClickEventHandler(Ribbon_ItemClick)

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

'...

' Make the Selection category visible
catSelection.Visible = True
' Activate the category's first page.
Ribbon.SelectedPage = catSelection.Pages(0)


' Respond to item clicking.
Sub Ribbon_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    '...
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectedPage 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#

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/CS/DXApplication9/Form1.cs#L41

InitializeRichEditControl();
ribbonControl.SelectedPage = homeRibbonPage1;
string path = @"DemoDoc.docx";

an-example-of-using-a-cell-range-as-a-data-source-t483776/CS/RangeDataSourceForSnap/Form1.cs#L16

    snapControl1.LoadDocument("report.snx");
    ribbonControl1.SelectedPage = dataRibbonPage1;
}

expandoobjects-data-binding-and-mail-merge-in-xtrarichedit-e3752/CS/ExpandoObject_MailMerge/Form1.cs#L21

ribbonControl1.SelectedPage = mailingsRibbonPage1;

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];
}

how-to-implement-mail-merge-in-a-richeditcontrol-e1680/CS/MailMerge/Form1.cs#L16

InitializeComponent();
ribbonControl1.SelectedPage = mailingsRibbonPage1;
richEditControl1.LoadDocument("invitation.rtf", DocumentFormat.Rtf);

VB.NET

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/VB/DXApplication9/Form1.vb#L40

InitializeRichEditControl()
ribbonControl.SelectedPage = homeRibbonPage1
Dim path As String = "DemoDoc.docx"

an-example-of-using-a-cell-range-as-a-data-source-t483776/VB/RangeDataSourceForSnap/Form1.vb#L18

    snapControl1.LoadDocument("report.snx")
    ribbonControl1.SelectedPage = dataRibbonPage1
End Sub

expandoobjects-data-binding-and-mail-merge-in-xtrarichedit-e3752/VB/ExpandoObject_MailMerge/Form1.vb#L20

ribbonControl1.SelectedPage = mailingsRibbonPage1

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-implement-mail-merge-in-a-richeditcontrol-e1680/VB/MailMerge/Form1.vb#L15

InitializeComponent()
ribbonControl1.SelectedPage = mailingsRibbonPage1
richEditControl1.LoadDocument("invitation.rtf", DocumentFormat.Rtf)