Class TuiCheckBox

Namespace

AshConsoleGraphics.Interactive

Assembly

AshConsoleGraphics.dll

Checkbox (on/off)

public class TuiCheckBox : TuiSelectable

Inheritance

object

TuiElement

TuiSelectable

TuiCheckBox

Derived

TuiFramedCheckBox

Inherited Members

TuiSelectable.Selected

TuiSelectable.OnSelection

TuiSelectable.KeyFunctions

TuiSelectable.SubKeyEvent(ConsoleKey, ConsoleModifiers, Action<TuiSelectable, ConsoleKeyInfo>)

TuiSelectable.SubKeyEvent(ConsoleKey, Action<TuiSelectable, ConsoleKeyInfo>)

TuiSelectable.DeleteAllKeyEvents()

TuiSelectable.HandleKey(ConsoleKeyInfo)

TuiElement.OffsetX

TuiElement.OffsetY

TuiElement.Placement

TuiElement.Buffer

TuiElement.needToGenBuffer

TuiElement.OnParentResize

TuiElement.TriggerUpdate()

TuiElement.BufferNeedsToBeGenerated()

TuiElement.GetTopLeftPosition(int, int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TuiCheckBox(char, char, bool, Placement, int, int, CharFormat?, CharFormat?)

Initializes a new framed checkbox with the same colors when selected and not selected

public TuiCheckBox(char u, char c, bool b, Placement p, int x, int y, CharFormat? cf = null, CharFormat? pf = null)

Parameters

u char

Unchecked char

c char

Checked char

b bool

If the checkbox is initially checked or not

p Placement

x int

y int

cf CharFormat

Check format

pf CharFormat

Selector format

TuiCheckBox(char, char, bool, Placement, int, int, CharFormat?, CharFormat?, CharFormat?)

Initializes a new framed checkbox

public TuiCheckBox(char u, char c, bool b, Placement p, int x, int y, CharFormat? cf, CharFormat? scf, CharFormat? pf)

Parameters

u char

Unchecked char

c char

Checked char

b bool

If the checkbox is initially checked or not

p Placement

x int

y int

cf CharFormat

Not selected check format

scf CharFormat

Selected check format

pf CharFormat

Selector format

Properties

CheckFormat

Not selected check charachter format

public CharFormat? CheckFormat { get; set; }

Property Value

CharFormat

Checked

If its checked or not

public bool Checked { get; set; }

Property Value

bool

CheckedChar

Check carachter when the checkbox is checked

public char CheckedChar { get; set; }

Property Value

char

SelectedCheckFormat

Selected check charachter format

public CharFormat? SelectedCheckFormat { get; set; }

Property Value

CharFormat

SelectorFormat

Format of the selector pads '>' '<' that surround the element when selcted

public CharFormat? SelectorFormat { get; set; }

Property Value

CharFormat

UnCheckedChar

Check carachter when the checkbox is unchecked

public char UnCheckedChar { get; set; }

Property Value

char

Methods

GenerateBuffer()

The method that generates the element's buffer

protected override Buffer GenerateBuffer()

Returns

Buffer