Table of Contents

Class PopoverMenu

Namespace
Terminal.Gui
Assembly
Terminal.Gui.dll

Provides a cascading menu that pops over all other content. Can be used as a context menu or a drop-down all other content. Can be used as a context menu or a drop-down menu as part of MenuBarv2 as part of MenuBarv2.

public class PopoverMenu : PopoverBaseImpl, IDisposable, ISupportInitializeNotification, ISupportInitialize, IPopover, IDesignable
Inheritance
PopoverMenu
Implements
Inherited Members

Remarks

To use as a context menu, register the popover menu with Popover and call MakeVisible(Point?).

Constructors

PopoverMenu()

Initializes a new instance of the PopoverMenu class.

PopoverMenu(IEnumerable<MenuItemv2>?)
PopoverMenu(IEnumerable<View>?)

Initializes a new instance of the PopoverMenu class. If any of the elements of menuItems is null, a see Line will be created instead.

PopoverMenu(Menuv2?)

Initializes a new instance of the PopoverMenu class with the specified root Menuv2.

Properties

DefaultKey

The default key for activating popover menus.

Key

Specifies the key that will activate the context menu.

MouseFlags

The mouse flags that will cause the popover menu to be visible. The default is Button3Clicked which is typically the right mouse button.

Root

Gets or sets the Menuv2 that is the root of the Popover Menu.

Methods

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

EnableForDesign<TContext>(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.

GetAllSubMenus()

Gets all the submenus in the PopoverMenu.

MakeVisible(Point?)

Makes the popover menu visible and locates it at idealScreenPosition. The actual position of the menu will be adjusted to ensure the menu fully fits on the screen, and the mouse cursor is over the first cell of the first MenuItem.

OnAccepted(CommandEventArgs)

Called when the user has accepted an item in this menu (or submenu. This is used to determine when to hide the menu.

OnAccepting(CommandEventArgs)

Called when the user is accepting the state of the View and the Accept has been invoked. Set CommandEventArgs.Cancel to true and return true to stop processing.

OnKeyDownNotHandled(Key)

Called when the user has pressed key it wasn't handled by KeyDown and was not bound to a key binding.

OnSubViewAdded(View)

Called when a SubView has been added to this View.

OnVisibleChanged()

Called when Visible has changed.

RaiseAccepted(ICommandContext?)

Raises the OnAccepted(CommandEventArgs)/Accepted event indicating a menu (or submenu) was accepted and the Menus in the PopoverMenu were hidden. Use this to determine when to hide the PopoverMenu.

SetPosition(Point?)

Locates the popover menu at idealScreenPosition. The actual position of the menu will be adjusted to ensure the menu fully fits on the screen, and the mouse cursor is over the first cell of the first MenuItem (if possible).

Events

Accepted

Raised when the user has accepted an item in this menu (or submenu. This is used to determine when to hide the menu.

KeyChanged

Raised when Key is changed.

Edit this page