BarOptions.BarState Property

Gets or sets whether the bar is collapsed or in its normal state.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[XtraSerializableProperty]
[DefaultValue(BarState.Expanded)]
public virtual BarState BarState { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue(BarState.Expanded)>
Public Overridable Property BarState As BarState

Property Value

Type	Default	Description
DevExpress.XtraBars.BarState	**Expanded**	A BarState enumerator value that specifies the bar’s expansion state.

Property Paths

You can access this nested property as listed below:

Object Type	Path to BarState
Bar	.OptionsBar.BarState

Remarks

If the BarOptions.AllowCollapse property is set to true, a bar can be collapsed. An end-user can collapse a bar by double-clicking its drag widget. The BarState property allows the bar’s expansion state to be changed in code.

Related GitHub Examples

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

how-to-create-a-bar-that-can-be-automatically-hidden-e2507/CS/WindowsApplication1/Classes/AutoHideBar.cs#L50

{
    if (OptionsBar.BarState == BarState.Expanded)
        return base.CalcBarEndSize();

VB.NET

how-to-create-a-bar-that-can-be-automatically-hidden-e2507/VB/WindowsApplication1/Classes/AutoHideBar.vb#L46

Protected Overrides Function CalcBarEndSize() As Size
    If OptionsBar.BarState = BarState.Expanded Then
        Return MyBase.CalcBarEndSize()