Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Collapse]DevExpress.XtraBars.Navigation
   [Expand]AccordionControl Class
   [Expand]AccordionControlElement Class
   [Expand]AccordionControlElementBase Class
    BackColorMode Enumeration
    ElementStyle Enumeration
    ExpandElementMode Enumeration
   [Expand]ExpandStateChangingEventArgs Class
    ExpandStateChangingEventHandler Delegate
   [Expand]ITileNavButton Interface
   [Expand]NavButton Class
   [Expand]NavElement Class
   [Expand]NavigationBarItem Class
   [Expand]NavigationFrame Class
   [Expand]NavigationPage Class
   [Expand]NavigationPageBase Class
   [Expand]NavigationPageDefaultProperties Class
   [Expand]NavigationPageProperties Class
   [Expand]NavigationPane Class
   [Collapse]OfficeNavigationBar Class
     OfficeNavigationBar Members
     OfficeNavigationBar Constructor
    [Expand]OfficeNavigationBar Properties
    [Expand]OfficeNavigationBar Events
    [Expand]OfficeNavigationBar Methods
    ScrollBarMode Enumeration
   [Expand]TabNavigationPage Class
   [Expand]TabPane Class
   [Expand]TileBar Class
   [Expand]TileBarDropDownContainer Class
   [Expand]TileBarDropDownOptions Class
   [Expand]TileBarDropDownShowingEventArgs Class
   [Expand]TileBarGroup Class
   [Expand]TileBarItem Class
    TileBarItemSize Enumeration
   [Expand]TileNavButtonCollection Class
   [Expand]TileNavCategory Class
   [Expand]TileNavCategoryCollection Class
   [Expand]TileNavElement Class
   [Expand]TileNavItem Class
   [Expand]TileNavItemCollection Class
   [Expand]TileNavPane Class
   [Expand]TileNavPaneDropDownOptions Class
    TileNavPaneMainButtonBehavior Enumeration
   [Expand]TileNavSubItem Class
   [Expand]TileNavSubItemCollection Class
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

OfficeNavigationBar Class

The MS Outlook-inspired navigation bar that supports integration with the NavBarControl.

Namespace:DevExpress.XtraBars.Navigation
Assembly:DevExpress.XtraBars.v17.2.dll

Expanded Syntax

Expanded Remarks

The OfficeNavigationBar is capable of displaying navigation links (items), which can be clicked to invoke a specific functionality. Items can be added and accessed with the Items property. A click on an item can be handled via the ItemClick event.

The main feature of the OfficeNavigationBar control is its ability to integrate with a NavBarControl. Two integration scenarios are supported:

  1. An external NavBarControl's groups can be displayed as an OfficeNavigationBar's items.

    Once you assign a NavBarControl to the NavigationClient property, the OfficeNavigationBar fetches groups from the NavBarControl.Groups collection and adds items to the Items collection that correspond to the NavBarControl's groups. At runtime, when an end-user clicks any of these items, a corresponding group is automatically activated in the bound NavBarControl.

    The following animation shows a NavBarControl (painted in the NavigationPane style and containing two groups - Mail and Organizer) and an OfficeNavigationBar control bound to this NavBarControl. The OfficeNavigationBar displays two links used to activate the nav bar groups:

    Note that group activation is only noticeable when the NavBarControl is painted using the NavigationPane or SideBar View. See Views.

    When the Navigation Pane View is applied to the NavBarControl, the group selector is automatically hidden from the NavBarControl after it is bound to the OfficeNavigationBar.

  2. When the NavBarControl is collapsed and is painted using the NavigationPane style, you can embed any control (including the OfficeNavigationBar) into the collapsed NavBarControl. Embedding the OfficeNavigationBar is useful if you want to display custom items in the collapsed NavBarControl to emulate the UI found in MS Outlook 2013.

    To accomplish this task, create an OfficeNavigationBar and assign it to the NavBarControl's OptionsNavPane.CollapsedNavPaneContentControl or NavBarGroup's NavBarGroup.CollapsedNavPaneContentControl property. Set the Orientation property to Vertical, since the collapsed Navigation Pane has a vertical orientation. Add required items and buttons to the OfficeNavigationBar using the Items collection.

For OfficeNavigationBar items, a popup Peek Form can be displayed to provide custom content for end-users. By default, the Peek Form is displayed when hovering over items.

The content for the Peek Form needs to be provided via the QueryPeekFormContent event. See ShowPeekFormOnItemHover to learn more.

The OfficeNavigationBar supports the Customization Button (), whose visibility and position is specified by the CustomizationButtonVisibility property. A click on the Customization Button invokes a dialog that allows an end-user to change the order of items and customize the number of visible items. The number of visible items can be set in code via the MaxItemCount property.

The currently applied skin controls the OfficeNavigationBar's background and the font and foreground color of items. If the ItemSkinning option is enabled, an item's background is painted according to the current skin. For instance, in some skins, items will have a solid background only when hovered, in other skins, items will be rendered as buttons, etc. You can also customize the item appearance settings using the AppearanceItem property.

Expanded Inheritance Hierarchy

System.Object
    System.MarshalByRefObject
       System.ComponentModel.Component
          System.Windows.Forms.Control
             OfficeNavigationBar

Expanded See Also

How would you rate this topic?​​​​​​​