Menuclass

public void Activate()PUBLIC

Do what a click on this row does. A submenu row opens, a checkable row toggles, a command runs and takes the whole menu down with it.

public Sandbox.UI.Menu AddMenu(string text, string icon = null)PUBLIC

Add a submenu. Same as `Sandbox.UI.Menu.AddOption(System.String,System.String,System.Action)` without an action.

public Sandbox.UI.Menu AddSeparator()PUBLIC

Add a line between rows.

public T AddWidget(T widget)PUBLIC

Add any panel as a row - a text entry, a slider, a heading. It's shown in the list like an option but the menu leaves it alone.

public void Clear()PUBLIC

Delete every row.

public void Close()PUBLIC

Hide this menu's options, and any open submenus.

public Sandbox.UI.Menu FindOption(string text)PUBLIC

The first option with this text, or null.

protected virtual void OnChildAdded(Sandbox.UI.Panel child)PROTECTEDVIRTUAL

A panel nested inside a menu - from Razor, or AddChild - is a row of it, not part of the row itself. It stays hidden in the row until the menu opens and moves it into the list.

protected virtual void OnClick(Sandbox.UI.MousePanelEvent e)PROTECTEDVIRTUAL

public virtual void OnDeleted()PUBLICVIRTUAL

protected virtual void OnMouseMove(Sandbox.UI.MousePanelEvent e)PROTECTEDVIRTUAL

protected virtual void OnMouseOut(Sandbox.UI.MousePanelEvent e)PROTECTEDVIRTUAL

protected virtual void OnMouseOver(Sandbox.UI.MousePanelEvent e)PROTECTEDVIRTUAL

public void Remove(Sandbox.UI.Panel row)PUBLIC

Take a row out without deleting it.

public bool Sandbox.UI.Menu.Checkable { get; set; }PUBLICGETSET

Clicking toggles `Sandbox.UI.Menu.Checked` instead of running `Sandbox.UI.Menu.Clicked`.

public bool Sandbox.UI.Menu.Checked { get; set; }PUBLICGETSET

Shows a check mark in the gutter.

public System.Action Sandbox.UI.Menu.Clicked { get; set; }PUBLICGETSET

Runs when the row is activated.

public bool Sandbox.UI.Menu.Enabled { get; set; }PUBLICGETSET

A disabled row is dimmed and does nothing when clicked.

public bool Sandbox.UI.Menu.HasOptions { get; set; }PUBLICGETSET

Does this row open a submenu?

public Sandbox.UI.Menu Sandbox.UI.Menu.Highlighted { get; set; }PUBLICGETSET

The row with the keyboard or hover highlight, in this menu's list.

public string Sandbox.UI.Menu.Icon { get; set; }PUBLICGETSET

Material icon shown in the gutter, before the text.

public bool Sandbox.UI.Menu.IsOpen { get; set; }PUBLICGETSET

Whether this menu's options are showing.

public bool Sandbox.UI.Menu.IsSeparator { get; set; }PUBLICGETSET

Draws a line between rows instead of a row.

public System.Collections.Generic.IReadOnlyList`1<Sandbox.UI.Menu> Sandbox.UI.Menu.Options { get; set; }PUBLICGETSET

The option rows of this menu, in order.

public Sandbox.UI.Menu Sandbox.UI.Menu.ParentMenu { get; set; }PUBLICGETSET

The menu this row is an option of. Null for a root menu.

public Sandbox.UI.Menu Sandbox.UI.Menu.RootMenu { get; set; }PUBLICGETSET

The top of this menu tree.

public System.Collections.Generic.IReadOnlyList`1<Sandbox.UI.Panel> Sandbox.UI.Menu.Rows { get; set; }PUBLICGETSET

Everything the list shows, in order - the options and any other panels added.

public string Sandbox.UI.Menu.Shortcut { get; set; }PUBLICGETSET

Shortcut text drawn on the right, like "Ctrl+S". Display only - nothing dispatches it yet.

public bool Sandbox.UI.Menu.StaysOpen { get; set; }PUBLICGETSET

Whether the menu stays up after this row is activated. Checkable rows do, so several can be flipped in one go; commands close the menu. Set it to say otherwise.

public string Sandbox.UI.Menu.Text { get; set; }PUBLICGETSET

The text shown on the row.

public System.Action`1<bool> Sandbox.UI.Menu.Toggled { get; set; }PUBLICGETSET

Runs with the new state when a checkable row is toggled. Setting it makes the row checkable.