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
    [Collapse]OfficeNavigationBar Properties
      AllowDrag Property
      AllowGlyphSkinning Property
      AllowHtmlDraw Property
      AllowItemSelection Property
      AnimateItemPressing Property
      AppearanceItem Property
      AutoSize Property
      AutoSizeInLayoutControl Property
      Compact Property
      CustomizationButtonVisibility Property
      Dock Property
      HorizontalContentAlignment Property
      IsDesignMode Property
      IsLockUpdate Property
      IsRightToLeft Property
      ItemPadding Property
      Items Property
      ItemSkinning Property
      LookAndFeel Property
      MaxItemCount Property
      MenuManager Property
      NavigationClient Property
      OptionsPeekFormButtonPanel Property
      Orientation Property
      PeekFormShowDelay Property
      PeekFormSize Property
      PeekItem Property
      SelectedItem Property
      ShowPeekFormOnItemHover Property
      ShowToolTips Property
      ToolTipController Property
    [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.NavigationClient Property

Gets or sets the control that provides a source of selectable objects that will be represented as items in the OfficeNavigationBar. If item selection is enabled (see AllowItemSelection), the OfficeNavigationBar will provide means for selecting (activating) the bound control's source objects.

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

Expanded Syntax

Property value

Type: INavigationBarClient
The control that provides a source of selectable objects that will be represented as items in the OfficeNavigationBar.
The default is null.

Expanded Remarks

When you set the NavigationClient property to an INavigationBarClient object, for each element in the INavigationBarClient.ItemsSource list, a ClientNavigationBarItem is automatically added to the Items collection. When you select any ClientNavigationBarItem (for instance, by clicking or via the SelectedItem property), the corresponding object in the INavigationBarClient is selected (activated) and vice versa. This feature can be disabled with the AllowItemSelection property.

When ClientNavigationBarItems are automatically added to the Items collection, the RegisterItem event fires, which allows for additional item customization. When you clear the NavigationClient property, the UnregisterItem event fires for each automatically added item.

Currently, the NavBarControl can be assigned to the NavigationClient property, as it implements the IOfficeNavigationBarClient interface, which is a descendant of the INavigationBarClient interface. The NavBarControl's INavigationBarClient.ItemsSource property specifies a collection of NavBarGroups (the NavBarControl.Groups collection).

If you assign a NavBarControl to the NavigationClient property, the OfficeNavigationBar obtains nav bar groups and creates items in the Items collection that will represent these groups.

The created items have the same captions as the linked nav bar groups. A click on these items activates the corresponding group in the NavBarControl. Conversely, when you manually activate a certain group in the NavBarControl, the corresponding item in the OfficeNavigationBar is selected.

Group activation is supported by the NavBarControl when it is painted in the NavigationPane or SideBar style (see Views). When the NavigationPane style is used and the NavBarControl is linked to the OfficeNavigationBar, the NavBarControl's built-in group selector is automatically hidden.

Expanded See Also

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