Table of Contents

Class TuiElement

Namespace
AshConsoleGraphics
Assembly
AshConsoleGraphics.dll

Element of a screen

public abstract class TuiElement
Inheritance
TuiElement
Derived
Inherited Members

Constructors

TuiElement(Placement, int, int)

Initializes a new element

protected TuiElement(Placement p, int x, int y)

Parameters

p Placement

The relative placement method

x int

The relative x offset

y int

The relative x offset

Properties

Buffer

public Buffer Buffer { get; }

Property Value

Buffer

OffsetX

Offset in the X coordinate from its relative position

public int OffsetX { get; set; }

Property Value

int

OffsetY

Offset in the Y coordinate from its relative position

public int OffsetY { get; set; }

Property Value

int

Placement

Relative placement to its parent screen

public Placement Placement { get; set; }

Property Value

Placement

needToGenBuffer

Set this to true when the buffer needs to be regenerated

protected bool needToGenBuffer { get; set; }

Property Value

bool

Methods

BufferNeedsToBeGenerated()

In most cases, the base implementation is enough

protected virtual bool BufferNeedsToBeGenerated()

Returns

bool

GenerateBuffer()

The method that generates the element's buffer

protected abstract Buffer GenerateBuffer()

Returns

Buffer

GetTopLeftPosition(int, int)

public (int, int) GetTopLeftPosition(int Xsize, int Ysize)

Parameters

Xsize int
Ysize int

Returns

(int, int)

TriggerUpdate()

public void TriggerUpdate()

Events

OnParentResize

Will be called when parent screen resizes

public event EventHandler<ResizeArgs> OnParentResize

Event Type

EventHandler<ResizeArgs>