Class MenuBar | Terminal.Gui v2 (original) (raw)

Namespace

Assembly

Terminal.Gui.dll

Provides a menu bar that spans the top of a Toplevel View with drop-down and cascading menus.

By default, any sub-sub-menus (sub-menus of the MenuItems added to MenuBarItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By settingUseSubMenusSingleFrame to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar.

[Obsolete("Use MenuBarv2 instead.", false)]
public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable

Inheritance

MenuBar

Implements

Inherited Members

Constructors

MenuBar()

Initializes a new instance of the MenuBar.

Properties

HotKeySpecifier

The specifier character for the hot keys.

IsMenuOpen

true if the menu is open; otherwise true.

Key

The Key used to activate or close the menu bar by keyboard. The default is F9.

LastFocused

Gets the view that was last focused before opening the menu.

Menus

Gets or sets the array of MenuBarItems for the menu. Only set this after theMenuBar is visible.

MenusBorderStyle

The default LineStyle for Menus's border. The default isSingle.

UseKeysUpDownAsKeysLeftRight

Used for change the navigation key style.

UseSubMenusSingleFrame

Gets or sets if the sub-menus must be displayed in a single or multiple frames.

By default, any sub-sub-menus (sub-menus of the main MenuItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting UseSubMenusSingleFrame totrue, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar.

Visible

Gets or sets a value indicating whether this View is visible.

Methods

CloseMenu(bool)

Closes the Menu programmatically if open and not canceled (as though F9 were pressed).

EnableForDesign(ref TContext)

Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

OnDrawingContent()

Called when the View's content is to be drawn. The default implementation does nothing.

OnMenuAllClosed()

Virtual method that will invoke the MenuAllClosed.

OnMenuClosing(MenuBarItem, bool, bool)

Virtual method that will invoke the MenuClosing.

OnMenuOpened()

Virtual method that will invoke the MenuOpened event if it's defined.

OnMenuOpening(MenuBarItem)

Virtual method that will invoke the MenuOpening event if it's defined.

OnMouseEvent(MouseEventArgs)

Called when a mouse event occurs within the view's Viewport.