Class CheckBox

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

Constructors

CheckBox()

Initializes a new instance of CheckBox based on the given text, using Computed layout.
Declaration
public CheckBox()

CheckBox(ustring, Boolean)

Initializes a new instance of CheckBox based on the given text, using Computed layout.
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 using Absolute layout.
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 using Absolute layout.
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

OnEnter(View)

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

OnToggled(Boolean)

Called when the Checked property changes. Invokes the Toggled event.
Declaration
public virtual void OnToggled(bool previousChecked)
Parameters
Type Name Description
System.Boolean previousChecked

PositionCursor()

Declaration
public override void PositionCursor()
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

Toggled

Toggled event, raised when the CheckBox is toggled.
Declaration
public event Action<bool> Toggled
Event Type
Type Description
System.Action<System.Boolean>
Remarks
Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state.

Implements

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