Back to Devexpress

OptionsNavPane.ActualNavPaneState Property

windowsforms-devexpress-dot-xtranavbar-dot-optionsnavpane-00c61824.md

latest3.1 KB
Original Source

OptionsNavPane.ActualNavPaneState Property

Gets the actual expansion state of the NavBarControl (in the NavigationPane paint style).

Namespace : DevExpress.XtraNavBar

Assembly : DevExpress.XtraNavBar.v25.2.dll

NuGet Package : DevExpress.Win

Declaration

csharp
[Browsable(false)]
public virtual NavPaneState ActualNavPaneState { get; }
vb
<Browsable(False)>
Public Overridable ReadOnly Property ActualNavPaneState As NavPaneState

Property Value

TypeDescription
NavPaneState

A NavPaneState value that specifies the control’s actual expansion state.

|

Available values:

NameDescription
Expanded

A NavBarControl is in its normal state.

| | Collapsed |

A NavBarControl is in its minimized state.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to ActualNavPaneState
NavBarControl

.OptionsNavPane .ActualNavPaneState

|

Remarks

When the NavigationPane paint style is applied, the NavBarControl can be minimized to save space and then restored if necessary. Use the OptionsNavPane.NavPaneState property to specify the control’s expansion state in code. An end-user can collapse and expand the NavBarControl by clicking the Expand button. Its visibility is specified by the OptionsNavPane.ShowExpandButton property.

The NavBarControl is collapsed and expanded using a sliding animation effect. Unlike the OptionsNavPane.NavPaneState property, the ActualNavPaneState property returns the current expansion state taking into account animation. Assume that a NavBarControl is in its normal state and an end-user clicks on the expand button. This immediately sets the OptionsNavPane.NavPaneState property to Collapsed and starts sliding animation. During animation, the ActualNavPaneState property will return Expanded and will return Collapsed only after animation has been finished.

See Also

NavPaneState

ShowExpandButton

OptionsNavPane Class

OptionsNavPane Members

DevExpress.XtraNavBar Namespace