Class Button

Button is a View that provides an item that invokes an System.Action when activated by the user.
Inheritance
System.Object
Responder
View
Button
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks

Provides a button showing text invokes an System.Action when clicked on with a mouse or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') in the button text.

Use HotKeySpecifier to change the hotkey specifier from the default of ('_').

If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey.

When the button is configured as the default (IsDefault) and the user presses the ENTER key, if no other View processes the KeyEvent, the Button's System.Action will be invoked.

Constructors

Button()

Initializes a new instance of Button using Computed layout.
Declaration
public Button()
Remarks
The width of the Button is computed based on the text length. The height will always be 1.

Button(ustring, Boolean)

Initializes a new instance of Button using Computed layout.
Declaration
public Button(ustring text, bool is_default = false)
Parameters
Type Name Description
NStack.ustring text The button's text
System.Boolean is_default If true, a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button.
Remarks
The width of the Button is computed based on the text length. The height will always be 1.

Button(Int32, Int32, ustring)

Initializes a new instance of Button using Absolute layout, based on the given text
Declaration
public Button(int x, int y, ustring text)
Parameters
Type Name Description
System.Int32 x X position where the button will be shown.
System.Int32 y Y position where the button will be shown.
NStack.ustring text The button's text
Remarks
The width of the Button is computed based on the text length. The height will always be 1.

Button(Int32, Int32, ustring, Boolean)

Initializes a new instance of Button using Absolute layout, based on the given text.
Declaration
public Button(int x, int y, ustring text, bool is_default)
Parameters
Type Name Description
System.Int32 x X position where the button will be shown.
System.Int32 y Y position where the button will be shown.
NStack.ustring text The button's text
System.Boolean is_default If true, a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button.
Remarks
The width of the Button is computed based on the text length. The height will always be 1.

Properties

AutoSize

Declaration
public override bool AutoSize { get; set; }
Property Value
Type Description
System.Boolean
Overrides

HotKey

Declaration
public override Key HotKey { get; set; }
Property Value
Type Description
Key
Overrides

HotKeySpecifier

Declaration
public override Rune HotKeySpecifier { get; set; }
Property Value
Type Description
System.Rune
Overrides

IsDefault

Gets or sets whether the Button is the default action to activate in a dialog.
Declaration
public bool IsDefault { get; set; }
Property Value
Type Description
System.Boolean true if is default; otherwise, false.

Text

Declaration
public override ustring Text { get; set; }
Property Value
Type Description
NStack.ustring
Overrides

Methods

MouseEvent(MouseEvent)

Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean
Overrides

OnClicked()

Virtual method to invoke the Clicked event.
Declaration
public virtual void OnClicked()

OnEnter(View)

Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view
Returns
Type Description
System.Boolean
Overrides

PositionCursor()

Declaration
public override void PositionCursor()
Overrides

ProcessColdKey(KeyEvent)

Declaration
public override bool ProcessColdKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides

ProcessHotKey(KeyEvent)

Declaration
public override bool ProcessHotKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides

ProcessKey(KeyEvent)

Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides

Redraw(Rect)

Declaration
public override void Redraw(Rect bounds)
Parameters
Type Name Description
Rect bounds
Overrides

Events

Clicked

Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault)
Declaration
public event Action Clicked
Event Type
Type Description
System.Action
Remarks
Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard.

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize