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.v19.2.dll

Declaration

C#

[DXCategory("Behavior")]
[DefaultValue(DefaultBoolean.Default)]
[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	Corresponds to a Boolean value of true.
False	Corresponds to a Boolean value of false.
Default	The value is determined by the current object’s parent object setting (e.g., a control setting).

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.

Related GitHub Examples

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

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/CS/TabsLayoutCustomization.Module.Win/Controllers/RibbonCustomizationWindowController.cs#L23

    ribbon.PageHeaderMinWidth = 100;
    ribbon.ShowExpandCollapseButton = DefaultBoolean.False;
}

VB.NET

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/VB/TabsLayoutCustomization.Module.Win/Controllers/RibbonCustomizationWindowController.vb#L19

    ribbon.PageHeaderMinWidth = 100
    ribbon.ShowExpandCollapseButton = DefaultBoolean.False
End If