PopupMenu.ShowNavigationHeader Property

Gets or sets whether the navigation header that provides navigation through the menu hierarchy, is shown at the top of the current PopupMenu. This property is in effect when the current PopupMenu is displayed in the Inplace popup show mode.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Appearance")]
public DefaultBoolean ShowNavigationHeader { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<DXCategory("Appearance")>
Public Property ShowNavigationHeader As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean value that specifies whether the navigation header is shown at the top of the current popup menu.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Remarks

Depending on whether PopupMenus are managed by the BarManager or RibbonControl, you can use the BarManager.PopupShowMode or the RibbonControl.PopupShowMode property to specify the way menus appear.

If the Inplace popup show mode is enabled, menus (PopupMenu) and sub-menus (BarCustomContainerItem) can display navigation headers that provide navigation through the menu hierarchy. This header is enabled for those menus and sub-menus whose ShowNavigationHeader and BarCustomContainerItem.ShowNavigationHeader properties, respectively, are set to Default or True. The sub-menu’s navigation header contains links to the root menu and previous sub-menus and allows an end-user to navigate backwards. Link titles are represented by the menu and sub-menu captions (see PopupMenu.MenuCaption and BarCustomContainerItem.MenuCaption). So, if a caption is not specified, the link to this menu or sub-menu cannot be displayed.

The caption of the currently shown menu or sub-menu is displayed as the last link in its navigation header. If the navigation header is enabled, the PopupMenu.ShowCaption and BarCustomContainerItem.ShowMenuCaption properties are not in effect.

The following image shows the File menu whose ShowNavigationHeader property is set to True. As it is the root menu, its navigation header contains the menu caption.

The following image shows the Save sub-menu. Its header contains the menu caption and the link to the previous File menu. It allows an end-user to navigate backwards to the File menu.

Set the ShowNavigationHeader property to False to hide the navigation header within the current PopupMenu. To specify this setting for a particular sub-menu, use the BarCustomContainerItem.ShowNavigationHeader property.