Class InfoBox

Informational box class

Inheritance

object

InfoBox

Namespace

Terminaux.Inputs.Styles.Infobox.Tools @ Terminaux.dll

Syntax

public class InfoBox

Properties

Dimensions

Processed dimensions of the infobox

Property Value

(int maxWidth, int maxHeight, int maxRenderWidth, int borderX, int borderY, int maxTextHeight, int linesLength)

Declaration

public (int maxWidth, int maxHeight, int maxRenderWidth, int borderX, int borderY, int maxTextHeight, int linesLength) Dimensions { get; }

Elements

A list of renderable elements in a container

Property Value

Container

Declaration

public Container Elements { get; set; }

IncrementationRate

Incrementation rate for text in this infobox

Property Value

int

Declaration

public int IncrementationRate { get; }

Positioning

Positioning settings

Property Value

InfoBoxPositioning

Declaration

public InfoBoxPositioning Positioning { get; }

Settings

Informational box settings

Property Value

InfoBoxSettings

Declaration

public InfoBoxSettings Settings { get; set; }

Text

Text that will be rendered inside the informational box

Property Value

string

Declaration

public string Text { get; set; }

Methods

Erase()

Erases this informational box

Returns

string

A buffered string you can render to the console

Declaration

public string Erase()

Render(int, bool, bool)

Renders this informational box

Returns

string

A buffered string you can render to the console

Declaration

public string Render(int currIdx = 0, bool drawBar = false, bool writeBinding = false)

Parameters

Name	Type	Description
currIdx	int	Current index of text line in the text area
drawBar	bool	Whether to draw the slider bar for the text area or not
writeBinding	bool	Whether to write the key bindings in the upper right corner of the box or not

Render(ref int, int, bool, bool)

Renders this informational box

Returns

string

A buffered string you can render to the console

Declaration

public string Render(ref int increment, int currIdx, bool drawBar, bool writeBinding)

Parameters

Name	Type	Description
increment	int	Incrementation rate for paged text in the text area (usually passed initialized to 0)
currIdx	int	Current index of text line in the text area
drawBar	bool	Whether to draw the slider bar for the text area or not
writeBinding	bool	Whether to write the key bindings in the upper right corner of the box or not