RibbonPageCategory.Visible Property

Gets or sets whether the current category is visible.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public bool Visible { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Property Visible As Boolean

Property Value

Type	Default	Description
Boolean	true	true if the category is visible; otherwise, false.

Remarks

If the Visible property is set to false, all pages that belong to the current category are hidden. To control the visibility of individual pages, use the RibbonPage.Visible property.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the Visible 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#

winforms-spreadsheet-use-cell-range-as-data-source/CS/RangeDataSource/Form1.cs#L81

dataRibbonPage1.Visible = true;
sheetPageCategory.Visible = true;
ribbonControl1.Minimized = false;

VB.NET

winforms-spreadsheet-use-cell-range-as-data-source/VB/RangeDataSource/Form1.vb#L86

dataRibbonPage1.Visible = True
sheetPageCategory.Visible = True
ribbonControl1.Minimized = False