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.Collections.IEnumerable
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, IEnumerable
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 specified by the first uppercase letter in the button.

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(ustring, Boolean)

Initializes a new instance of Button based on the given text at position 0,0
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 set, this makes the button the default button in the current view. IsDefault
Remarks
The size of the Button is computed based on the text length.

Button(Int32, Int32, ustring)

Initializes a new instance of Button at the given coordinates, 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 size of the Button is computed based on the text length.

Button(Int32, Int32, ustring, Boolean)

Initializes a new instance of Button at the given coordinates, based on the given text, and with the specified IsDefault value
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 set, this makes the button the default button in the current view, which means that if the user presses return on a view that does not handle return, it will be treated as if he had clicked on the button
Remarks
If the value for is_default is true, a special decoration is used, and the enter key on a dialog would implicitly activate this button.

Fields

Clicked

Clicked System.Action, raised when the button is clicked.
Declaration
public Action Clicked
Field Value
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.

Properties

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

The text displayed by this Button.
Declaration
public ustring Text { get; set; }
Property Value
Type Description
NStack.ustring

Methods

MouseEvent(MouseEvent)

Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
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 region)
Parameters
Type Name Description
Rect region
Overrides

Implements

System.Collections.IEnumerable