Class CheckBox

The CheckBox View shows an on/off toggle that the user can set
Inheritance
System.Object
Responder
View
CheckBox
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 CheckBox : View, IEnumerable

Constructors

CheckBox(ustring, Boolean)

Initializes a new instance of CheckBox based on the given text, uses Computed layout and sets the height and width.
Declaration
public CheckBox(ustring s, bool is_checked = false)
Parameters
Type Name Description
NStack.ustring s S.
System.Boolean is_checked If set to true is checked.

CheckBox(Int32, Int32, ustring)

Initializes a new instance of CheckBox based on the given text at the given position and a state.
Declaration
public CheckBox(int x, int y, ustring s)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
NStack.ustring s
Remarks
The size of CheckBox is computed based on the text length. This CheckBox is not toggled.

CheckBox(Int32, Int32, ustring, Boolean)

Initializes a new instance of CheckBox based on the given text at the given position and a state.
Declaration
public CheckBox(int x, int y, ustring s, bool is_checked)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
NStack.ustring s
System.Boolean is_checked
Remarks
The size of CheckBox is computed based on the text length.

Properties

Checked

The state of the CheckBox
Declaration
public bool Checked { get; set; }
Property Value
Type Description
System.Boolean

Text

The text displayed by this CheckBox
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

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

Events

Toggled

Toggled event, raised when the CheckBox is toggled.
Declaration
public event EventHandler Toggled
Event Type
Type Description
System.EventHandler
Remarks
Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard.

Implements

System.Collections.IEnumerable