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

| Improve this Doc View Source

CheckBox()

Initializes a new instance of CheckBox based on the given text, using Computed layout.
Declaration
public CheckBox()
| Improve this Doc View Source

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.
| Improve this Doc View Source

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
| Improve this Doc View Source

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

Properties

| Improve this Doc View Source

Checked

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

Methods

| Improve this Doc View Source

MouseEvent(MouseEvent)

Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

OnEnter(View)

Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

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
| Improve this Doc View Source

PositionCursor()

Declaration
public override void PositionCursor()
Overrides
| Improve this Doc View Source

ProcessHotKey(KeyEvent)

Declaration
public override bool ProcessHotKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

ProcessKey(KeyEvent)

Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

UpdateTextFormatterText()

Declaration
protected override void UpdateTextFormatterText()
Overrides

Events

| Improve this Doc View Source

Toggled

Toggled event, raised when the CheckBox is toggled.
Declaration
public event Action<bool> Toggled
Event Type
Type Description
System.Action<System.Boolean>

Implements

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