ButtonEventclass

Keyboard (and mouse) key press `Sandbox.UI.PanelEvent`.

object→ButtonEvent

Namespace: Sandbox.UI
Assembly: Sandbox.Engine
Declaration: public class Sandbox.UI.ButtonEvent

Constructors1

Showing 1 constructors

protected ButtonEvent(Sandbox.UI.ButtonEvent original)PROTECTEDCONSTRUCTOR

Parameter	Type	Description
original	`ButtonEvent`	—

Methods2

Showing 2 methods

public virtual Sandbox.UI.ButtonEvent <Clone>$()PUBLICVIRTUAL

Returns:ButtonEvent—

protected virtual bool PrintMembers(System.Text.StringBuilder builder)PROTECTEDVIRTUAL

Parameter	Type	Description
builder	`StringBuilder`	—

Returns:bool—

Properties9

Showing 9 properties

public string Sandbox.UI.ButtonEvent.Button { get; set; }PUBLICGETSET

The button that triggered the event.

Returns:string—

protected virtual System.Type Sandbox.UI.ButtonEvent.EqualityContract { get; set; }PROTECTEDVIRTUALGETSET

Returns:Type—

public bool Sandbox.UI.ButtonEvent.HasAlt { get; set; }PUBLICGETSET

Whether `Alt` key was being held down at the time of the event.

Returns:bool—

public bool Sandbox.UI.ButtonEvent.HasCtrl { get; set; }PUBLICGETSET

Whether `Control` key was being held down at the time of the event.

Returns:bool—

public bool Sandbox.UI.ButtonEvent.HasShift { get; set; }PUBLICGETSET

Whether `Shift` key was being held down at the time of the event.

Returns:bool—

public Sandbox.KeyboardModifiers Sandbox.UI.ButtonEvent.KeyboardModifiers { get; set; }PUBLICGETSET

The keyboard modifier keys that were held down at the moment the event triggered.

Returns:KeyboardModifiers—

public bool Sandbox.UI.ButtonEvent.Pressed { get; set; }PUBLICGETSET

Whether the button was pressed in, or release.

Returns:bool—

public bool Sandbox.UI.ButtonEvent.StopPropagation { get; set; }PUBLICGETSET

Set to to prevent the event from propagating to the parent panel.

Returns:bool—

public int Sandbox.UI.ButtonEvent.VirtualKey { get; set; }PUBLICGETSET

Returns:int—

UpdateActiveState()

Button

Constructors

protected ButtonEvent(Sandbox.UI.ButtonEvent original)

Methods

public virtual Sandbox.UI.ButtonEvent <Clone>$()

protected virtual System.Boolean PrintMembers(System.Text.StringBuilder builder)

Properties

public System.String Sandbox.UI.ButtonEvent.Button { get; set; }

protected virtual System.Type Sandbox.UI.ButtonEvent.EqualityContract { get; set; }

public System.Boolean Sandbox.UI.ButtonEvent.HasAlt { get; set; }

public System.Boolean Sandbox.UI.ButtonEvent.HasCtrl { get; set; }

public System.Boolean Sandbox.UI.ButtonEvent.HasShift { get; set; }

public Sandbox.KeyboardModifiers Sandbox.UI.ButtonEvent.KeyboardModifiers { get; set; }

public System.Boolean Sandbox.UI.ButtonEvent.Pressed { get; set; }

public System.Boolean Sandbox.UI.ButtonEvent.StopPropagation { get; set; }

public System.Int32 Sandbox.UI.ButtonEvent.VirtualKey { get; set; }

Metadata

ButtonEventclass

Constructors1

Methods2

Properties9

On this page