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.v22.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

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

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
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

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):

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.