NavigationPane Class

The page container with vertically arranged built-in flat tabs, displaying one page at a time in an expandable area, which can be resized, maximized and collapsed. Supports animation effects when navigating through pages. See Navigation Pane.

Namespace: DevExpress.XtraBars.Navigation

Assembly: DevExpress.XtraBars.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public class NavigationPane :
    NavigationFrame,
    INavigationPane,
    INavigationFrame,
    ISupportBatchUpdate,
    IButtonsPanelOwner,
    IButtonPanelControlAppearanceOwner,
    IAppearanceOwner,
    IScreenBoundsProvider,
    IToolTipControlClient,
    IStringImageProvider

VB.NET

Public Class NavigationPane
    Inherits NavigationFrame
    Implements INavigationPane,
               INavigationFrame,
               ISupportBatchUpdate,
               IButtonsPanelOwner,
               IButtonPanelControlAppearanceOwner,
               IAppearanceOwner,
               IScreenBoundsProvider,
               IToolTipControlClient,
               IStringImageProvider

Remarks

NavigationPane is a tab container of NavigationPage objects, to which you can place you custom controls. You can access and customize the page collection with the NavigationFrame.Pages inherited property.

Visually, the NavigationPane is divided into two areas - page header area and expandable page content area.

The Page header area displays vertically aligned page headers, which act as tabs. Each tab can display a page image (the NavigationPage.Image or NavigationPage.ImageUri property) and/or page caption (the NavigationPage.PageText or NavigationPage.Caption property). The ShowMode property, accessed through the NavigationPane.PageProperties section, specifies which of these elements should be shown.

Clicking a page header (tab) expands the resizable pane displaying the contents of the current page. This pane has its own header that contains the page caption (the NavigationPage.Caption property), custom header buttons (the NavigationPage.CustomHeaderButtons collection), collapse button and maximize/restore button.

At design time, you can use the NavigationPane‘s smart tag to add new NavigationPages. Dedicated navigation elements help you to quickly switch between pages, add and delete pages at design time (see the figure below). These navigation elements are not available at runtime.

The following lists shows some additional properties to customize the control’s behavior:

• NavigationPane.ItemOrientation - Gets or sets page header orientation for all NavigationPages that belong to this NavigationPane.
• NavigationPane.RegularSize - Gets or sets the size of this NavigationPane‘s content area when the pane is in its regular state.
• NavigationPane.AllowResize - Gets or sets whether end-users are allowed to resize the NavigationPane‘s content area by dragging its border.
• NavigationPane.State - Gets or sets this NavigationPane‘s current state.
• NavigationFrame.AllowTransitionAnimation - Gets or sets whether or not changing the frame’s selected page is followed by animation effects.
• NavigationFrame.SelectedPage - Gets or sets the currently selected page.

Inheritance

Object

MarshalByRefObject

Component

Control

ControlBase

NavigationFrame

NavigationPane

TabPane