Class MenuButton

Namespace

PluginUI

Assembly

PluginUI.dll

Button opening an arbitrary menu (MenuItem tree): settings, "more" menus, file menus. Handle Opening to rebuild the entries right before the menu appears.

public class MenuButton : Control

Inheritance

object

UIElement

Control

MenuButton

Inherited Members

Control.Label

Control.Style

Control.EffectiveStyle

Control.Skin

Control.IsPressed

Control.MeasureOverride(Size)

Control.GetSkinState(Rect)

Control.OnRender(DrawingContext)

Control.RenderLabel(DrawingContext, Rect, VectorStyle)

Control.RenderValue(DrawingContext, Rect, VectorStyle)

Control.ValueText

Control.LayoutParts(VectorStyle, out Rect, out Rect, out Rect)

Control.CornerRadiusFor(Rect, VectorStyle)

Control.DrawBox(DrawingContext, Rect, VectorStyle, bool, bool, Color?)

Control.OnRenderOverlay(DrawingContext)

UIElement.Name

UIElement.Tag

UIElement.Parent

UIElement.Host

UIElement.VisualChildren

UIElement.Theme

UIElement.TextMeasurer

UIElement.Width

UIElement.Height

UIElement.MinWidth

UIElement.MinHeight

UIElement.MaxWidth

UIElement.MaxHeight

UIElement.Margin

UIElement.HorizontalAlignment

UIElement.VerticalAlignment

UIElement.Left

UIElement.Top

UIElement.Row

UIElement.Column

UIElement.RowSpan

UIElement.ColumnSpan

UIElement.Dock

UIElement.DesiredSize

UIElement.Bounds

UIElement.IsVisible

UIElement.IsEnabled

UIElement.IsEffectivelyEnabled

UIElement.UseOpacityLayer

UIElement.Opacity

UIElement.ClipToBounds

UIElement.IsHitTestVisible

UIElement.ToolTip

UIElement.GetToolTipText()

UIElement.Strings

UIElement.Cursor

UIElement.Focusable

UIElement.ContextMenu

UIElement.AllowFileDrop

UIElement.IsMouseOver

UIElement.IsFocused

UIElement.IsMouseCaptured

UIElement.MouseDown

UIElement.MouseUp

UIElement.MouseMove

UIElement.MouseWheel

UIElement.KeyDown

UIElement.SetBounds(float, float, float, float)

UIElement.InvalidateMeasure()

UIElement.InvalidateVisual()

UIElement.CaptureMouse()

UIElement.ReleaseMouseCapture()

UIElement.Focus()

UIElement.FindByName(string)

UIElement.DescendantsAndSelf()

UIElement.IsAncestorOf(UIElement)

UIElement.OnAttached()

UIElement.OnDetached()

UIElement.OnVisibilityChanged()

UIElement.Measure(Size)

UIElement.Arrange(Rect)

UIElement.ArrangeOverride(Rect)

UIElement.HitTest(Point)

UIElement.HitTestTree(Point)

UIElement.OnMouseUp(MouseEventArgs)

UIElement.OnMouseMove(MouseEventArgs)

UIElement.OnMouseWheel(MouseEventArgs)

UIElement.OnMouseEnter()

UIElement.OnMouseLeave()

UIElement.OnCaptureLost()

UIElement.OnKeyUp(KeyEventArgs)

UIElement.OnTextInput(TextInputEventArgs)

UIElement.OnGotFocus()

UIElement.OnLostFocus()

UIElement.OnFilesDropped(FilesDroppedEventArgs)

UIElement.OnDragOver(DragEventArgs)

UIElement.OnDragLeave()

UIElement.OnDrop(DragEventArgs)

UIElement.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

MenuButton()

Creates a menu button.

public MenuButton()

MenuButton(MenuButtonStyle, params MenuItem[])

Creates a menu button with entries.

public MenuButton(MenuButtonStyle look, params MenuItem[] items)

Parameters

look MenuButtonStyle

items MenuItem[]

Properties

DefaultSize

Natural size used when no explicit size is given.

protected override Size DefaultSize { get; }

Property Value

Size

IsMenuOpen

true while the menu is open.

public bool IsMenuOpen { get; }

Property Value

bool

Items

Menu entries.

public IList<MenuItem> Items { get; set; }

Property Value

IList<MenuItem>

Look

Visual style.

public MenuButtonStyle Look { get; set; }

Property Value

MenuButtonStyle

MenuPlacement

Menu placement relative to the button.

public PopupPlacement MenuPlacement { get; set; }

Property Value

PopupPlacement

ShowBackground

Draws the raised box (otherwise flat until hovered).

public bool ShowBackground { get; set; }

Property Value

bool

Text

Caption (text styles).

public string? Text { get; set; }

Property Value

string

Methods

OnKeyDown(KeyEventArgs)

Key pressed while focused (bubbles to parents).

protected override void OnKeyDown(KeyEventArgs e)

Parameters

e KeyEventArgs

OnMouseDown(MouseEventArgs)

Mouse button pressed over the element (or captured).

protected override void OnMouseDown(MouseEventArgs e)

Parameters

e MouseEventArgs

OpenMenu()

Opens the menu.

public void OpenMenu()

RenderVector(DrawingContext, Rect, VectorStyle)

Vector rendering of the widget area.

protected override void RenderVector(DrawingContext dc, Rect widget, VectorStyle style)

Parameters

dc DrawingContext

widget Rect

style VectorStyle

Events

Opening

Raised before the menu opens (update Items here).

public event Action<MenuButton>? Opening

Event Type

Action<MenuButton>