OfficeNavigationBar Class

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

Namespace : DevExpress.XtraBars.Navigation

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DXLicenseWinForms]
public class OfficeNavigationBar :
    XtraControl,
    IButtonsPanelOwnerEx,
    IButtonsPanelOwner,
    IAppearanceOwner,
    IOfficeNavigationBar,
    INavigationBar,
    ISupportInitialize,
    IXtraResizableControl,
    IToolTipControlClient,
    ISupportLookAndFeel,
    ISupportImageDragDrop,
    ISupportXtraSerializer,
    ISupportJsonXtraSerializer,
    IXtraSerializable,
    IStringImageProvider

<DXLicenseWinForms>
Public Class OfficeNavigationBar
    Inherits XtraControl
    Implements IButtonsPanelOwnerEx,
               IButtonsPanelOwner,
               IAppearanceOwner,
               IOfficeNavigationBar,
               INavigationBar,
               ISupportInitialize,
               IXtraResizableControl,
               IToolTipControlClient,
               ISupportLookAndFeel,
               ISupportImageDragDrop,
               ISupportXtraSerializer,
               ISupportJsonXtraSerializer,
               IXtraSerializable,
               IStringImageProvider

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 OfficeNavigationBar.Items property. A click on an item can be handled via the OfficeNavigationBar.ItemClick event.

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

An external NavBarControl‘s groups can be displayed as an OfficeNavigationBar ‘s items.
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.

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 OfficeNavigationBar.QueryPeekFormContent event. See OfficeNavigationBar.ShowPeekFormOnItemHover to learn more.

The OfficeNavigationBar supports the Customization Button ( ), whose visibility and position is specified by the OfficeNavigationBar.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 OfficeNavigationBar.MaxItemCount property.

Implements

IXtraResizableControl

Inheritance

Object MarshalByRefObject Component Control DevExpress.XtraEditors.XtraControl OfficeNavigationBar