Class TuiMultiLineFramedTextBox

Namespace

AshConsoleGraphics.Interactive

Assembly

AshConsoleGraphics.dll

A textbox where you can write inside a frame that can be several lines in height

public class TuiMultiLineFramedTextBox : TuiWritable

Inheritance

object

TuiElement

TuiSelectable

TuiWritable

TuiMultiLineFramedTextBox

Inherited Members

TuiWritable.Text

TuiWritable.Length

TuiWritable.CanWriteChar

TuiWritable.OnLengthChange

TuiWritable.HandleKey(ConsoleKeyInfo)

TuiWritable.DelChar()

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

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

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

public TuiMultiLineFramedTextBox(string t, int xs, int ys, Placement p, int x, int y, CharFormat? ff = null, CharFormat? tf = null, CharFormat? pf = null)

Parameters

t string

Initial text

xs int

Box X size

ys int

Box Y size

p Placement

x int

y int

ff CharFormat

Frame format

tf CharFormat

Text format

pf CharFormat

Selector format

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

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

public TuiMultiLineFramedTextBox(string t, int xs, int ys, Placement p, int x, int y, CharFormat? ff, CharFormat? sff, CharFormat? tf, CharFormat? stf, CharFormat? pf)

Parameters

t string

Initial text

xs int

Box X size

ys int

Box Y size

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

pf CharFormat

Selector format

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

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

public TuiMultiLineFramedTextBox(string chars, string t, int xs, int ys, Placement p, int x, int y, CharFormat? ff = null, CharFormat? tf = null, CharFormat? pf = null)

Parameters

chars string

Frame charchters

t string

Initial text

xs int

Box X size

ys int

Box Y size

p Placement

x int

y int

ff CharFormat

Frame format

tf CharFormat

Text format

pf CharFormat

Selector format

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

Initializes a new multiline textbox

public TuiMultiLineFramedTextBox(string chars, string t, int xs, int ys, Placement p, int x, int y, CharFormat? ff, CharFormat? sff, CharFormat? tf, CharFormat? stf, CharFormat? pf)

Parameters

chars string

Frame charchters

t string

Initial text

xs int

Box X size

ys int

Box Y size

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

pf CharFormat

Selector format

Properties

BoxXsize

The visible X size of the box. Length is xsize * ysize

public int BoxXsize { get; set; }

Property Value

int

BoxYsize

The visible Y size of the box. Length is xsize * ysize

public int BoxYsize { get; set; }

Property Value

int

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 selector pads '>' '<' 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