RibbonOptionsExpandCollapseMenu.EnableExpandCollapseMenu Property

Gets or sets a value that specifies the availability of the Ribbon Display Options popup menu.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Behavior")]
[XtraSerializableProperty]
public DefaultBoolean EnableExpandCollapseMenu { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Property EnableExpandCollapseMenu As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	True to enable the Ribbon Display Options menu; otherwise, False.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Property Paths

You can access this nested property as listed below:

Object Type	Path to EnableExpandCollapseMenu
RibbonControl	.OptionsExpandCollapseMenu .EnableExpandCollapseMenu

Remarks

The following example demonstrates how to enable the Ribbon Display Options menu:

C#

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

private void Form1_Load(object sender, EventArgs e) {
    EnableRibbonExpandCollapseMenu();
}
void EnableRibbonExpandCollapseMenu() {
    ribbonControl1.OptionsExpandCollapseMenu.EnableExpandCollapseMenu = DefaultBoolean.True;
    ribbonControl1.OptionsExpandCollapseMenu.ShowRibbonLayoutGroup = DefaultBoolean.True;
    ribbonControl1.ExpandCollapseMenuShowing += RibbonControl1_ExpandCollapseMenuShowing;
}
private void RibbonControl1_ExpandCollapseMenuShowing(object sender, ExpandCollapseMenuShowingEventArgs e) {
    // Use 'e.Menu' to add new menu items aor customize the existing menu items.
    // e.Menu.AddItem(barItem);
    // e.Menu.ItemLinks[0].Caption = "CUSTOM_CAPTION";

    // Prevents the menu from being displayed.
    // e.Allow = false;
}

VB.NET

Imports DevExpress.Utils
Imports DevExpress.XtraBars.Ribbon

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    EnableRibbonExpandCollapseMenu()
End Sub
Private Sub EnableRibbonExpandCollapseMenu()
    ribbonControl1.OptionsExpandCollapseMenu.EnableExpandCollapseMenu = DefaultBoolean.True
    ribbonControl1.OptionsExpandCollapseMenu.ShowRibbonLayoutGroup = DefaultBoolean.True
    AddHandler ribbonControl1.ExpandCollapseMenuShowing, AddressOf RibbonControl1_ExpandCollapseMenuShowing
End Sub
Private Sub RibbonControl1_ExpandCollapseMenuShowing(ByVal sender As Object, ByVal e As ExpandCollapseMenuShowingEventArgs)
    ' Use e.Menu to add new menu items aor customize the existing menu items.
    ' e.Menu.AddItem(barItem);
    ' e.Menu.ItemLinks[0].Caption = "CUSTOM_CAPTION";

    ' Prevents the menu from being displayed.
    ' e.Allow = false;
End Sub

The following screenshot shows the result: