Class TuiFramedTextBox

Namespace

AshConsoleGraphics.Interactive

Assembly

AshConsoleGraphics.dll

A textbox where you can write inside a frame

public class TuiFramedTextBox : TuiWritable

Inheritance

object

TuiElement

TuiSelectable

TuiWritable

TuiFramedTextBox

Inherited Members

TuiWritable.Cursor

TuiWritable.Text

TuiWritable.Length

TuiWritable.CanWriteChar

TuiWritable.OnLengthChange

TuiWritable.HandleKey(ConsoleKeyInfo)

TuiWritable.DelChar()

TuiSelectable.LeftSelector

TuiSelectable.RightSelector

TuiSelectable.Selected

TuiSelectable.OnSelection

TuiSelectable.KeyFunctions

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

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

TuiSelectable.DeleteAllKeyEvents()

TuiElement.OffsetX

TuiElement.OffsetY

TuiElement.Placement

TuiElement.Buffer

TuiElement.needToGenBuffer

TuiElement.OnParentResize

TuiElement.TriggerUpdate()

TuiElement.GetTopLeftPosition(int, int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TuiFramedTextBox(string, int, Placement, int, int, CharFormat?, CharFormat?, CharFormat?, CharFormat?)

Initializes a new textbox with default frame chars ('┌┐└┘──││') and same colors for selected and not selected

public TuiFramedTextBox(string t, int l, Placement p, int x, int y, CharFormat? ff = null, CharFormat? tf = null, CharFormat? curfor = null, CharFormat? pf = null)

Parameters

t string

Initial text

l int

Textbox length

p Placement

x int

y int

ff CharFormat

Frame format

tf CharFormat

Text format

curfor CharFormat

Cursor format

pf CharFormat

Selector format

TuiFramedTextBox(string, int, Placement, int, int, CharFormat?, CharFormat?, CharFormat?, CharFormat?, CharFormat?, CharFormat?)

Initializes a new textbox with default frame chars ('┌┐└┘──││')

public TuiFramedTextBox(string t, int l, Placement p, int x, int y, CharFormat? ff, CharFormat? sff, CharFormat? tf, CharFormat? stf, CharFormat? curfor, CharFormat? pf)

Parameters

t string

Initial text

l int

Textbox length

p Placement

x int

y int

ff CharFormat

Not selected frame format

sff CharFormat

Selected frame format

tf CharFormat

Not selected text format

stf CharFormat

Selected text format

curfor CharFormat

Cursor format

pf CharFormat

Selector format

TuiFramedTextBox(string, string, int, Placement, int, int, CharFormat?, CharFormat?, CharFormat?, CharFormat?)

Initializes a new textbox with the same colors when selected and not selected

public TuiFramedTextBox(string chars, string t, int l, Placement p, int x, int y, CharFormat? ff = null, CharFormat? tf = null, CharFormat? curfor = null, CharFormat? pf = null)

Parameters

chars string

Frame charchters

t string

Initial text

l int

Textbox length

p Placement

x int

y int

ff CharFormat

Frame format

tf CharFormat

Text format

curfor CharFormat

Cursor format

pf CharFormat

Selector format

TuiFramedTextBox(string, string, int, Placement, int, int, CharFormat?, CharFormat?, CharFormat?, CharFormat?, CharFormat?, CharFormat?)

Initializes a new textbox

public TuiFramedTextBox(string chars, string t, int l, Placement p, int x, int y, CharFormat? ff, CharFormat? sff, CharFormat? tf, CharFormat? stf, CharFormat? curfor, CharFormat? pf)

Parameters

chars string

Frame charchters

t string

Initial text

l int

Textbox length

p Placement

x int

y int

ff CharFormat

Not selected frame format

sff CharFormat

Selected frame format

tf CharFormat

Not selected text format

stf CharFormat

Selected text format

curfor CharFormat

Cursor format

pf CharFormat

Selector format

Properties

CursorFormat

Format of the cursor

public CharFormat? CursorFormat { get; set; }

Property Value

CharFormat

FrameChars

Frame charachters. An example would be '┌┐└┘──││'

public char[] FrameChars { get; set; }

Property Value

char[]

FrameFormat

Not selected frame charachter format

public CharFormat? FrameFormat { get; set; }

Property Value

CharFormat

SelectedFrameFormat

Selected frame charachter format

public CharFormat? SelectedFrameFormat { get; set; }

Property Value

CharFormat

SelectedTextFormat

Selected text charachter format

public CharFormat? SelectedTextFormat { get; set; }

Property Value

CharFormat

SelectorFormat

Format of the selectors that surround the element when selcted

public CharFormat? SelectorFormat { get; set; }

Property Value

CharFormat

TextFormat

Not selected text charachter format

public CharFormat? TextFormat { get; set; }

Property Value

CharFormat

Methods

BufferNeedsToBeGenerated()

In most cases, the base implementation is enough

protected override bool BufferNeedsToBeGenerated()

Returns

bool

GenerateBuffer()

The method that generates the element's buffer

protected override Buffer GenerateBuffer()

Returns

Buffer