OptionsNavPane.NavPaneState Property

Gets or sets the NavBarControl’s expansion state when the NavigationPane paint style is applied.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v19.1.dll

Declaration

C#

[DefaultValue(NavPaneState.Expanded)]
[XtraSerializableProperty(XtraSerializationVisibility.Visible)]
public virtual NavPaneState NavPaneState { get; set; }

VB.NET

<DefaultValue(NavPaneState.Expanded)>
<XtraSerializableProperty(XtraSerializationVisibility.Visible)>
Public Overridable Property NavPaneState As NavPaneState

Property Value

Type	Default	Description
NavPaneState	**Expanded**	A NavPaneState value that specifies the control’s expansion state.

Available values:

Name	Description
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:

Library	Object Type	Path to NavPaneState
WinForms Controls	NavBarControl	.OptionsNavPane.NavPaneState
Reporting	XRDesignToolBox	.OptionsNavPane.NavPaneState

Remarks

When the NavigationPane paint style is applied, the NavBarControl can be minimized to save space and then restored if necessary. Use the 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NavPaneState 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-automatically-expand-collapse-the-navigation-pane-when-its-size-changed-e1009/CS/Q139896/Form1.cs#L20

if (navBarControl1.Width <= 50) {
    if (navBarControl1.OptionsNavPane.NavPaneState == NavPaneState.Expanded) {
        navBarControl1.OptionsNavPane.NavPaneState = NavPaneState.Collapsed;

how-to-show-the-navpaneform-programmatically-e2199/CS/WindowsApplication1/Form1.cs#L25

{
    if (navBarControl1.OptionsNavPane.NavPaneState == NavPaneState.Collapsed)
    {

VB.NET

how-to-automatically-expand-collapse-the-navigation-pane-when-its-size-changed-e1009/VB/Q139896/Form1.vb#L22

If navBarControl1.Width <= 50 Then
    If navBarControl1.OptionsNavPane.NavPaneState = NavPaneState.Expanded Then
        navBarControl1.OptionsNavPane.NavPaneState = NavPaneState.Collapsed