Skip to main content

RibbonControl.ShowExpandCollapseButton Property

Gets or sets whether the Ribbon Control displays a button that allows an end-user to hide/restore the RibbonControl’s pages.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

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

Property Value

Type Default Description
DefaultBoolean Default

A DefaultBoolean value that specifies the visibility of the button that allows an end-user to hide/restore the RibbonControl’s pages.

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

Remarks

Clicking the Expand/Collapse button hides and restores the RibbonControl’s pages. It’s equivalent to toggling the RibbonControl.Minimized property.

The Expand/Collapse button is displayed on the right of the Ribbon Control and to the left of the page header items, if any (see the RibbonControl.PageHeaderItemLinks topic):

Ribbon_ExpandCollapseButton

The following list details the available values of the ShowExpandCollapseButton property:

  • The ShowExpandCollapseButton property is set to Default

    The Expand/Collapse button is available starting from the Office2010 style (see the RibbonControl.RibbonStyle property).

  • The ShowExpandCollapseButton property is set to True

    The Expand/Collapse button is available in all Ribbon styles.

  • The ShowExpandCollapseButton property is set to False

    The Expand/Collapse button is never visible.

To access a bar item that represents the expand/collapse button, use RibbonControl.ExpandCollapseItem.

See Also