Class InfoBox

Informational box class

Inheritance

object

InfoBox

Namespace: Terminaux.Inputs.Styles.Infobox.Tools

Assembly: Terminaux.dll

Syntax

public class InfoBox

Properties

Dimensions

Processed dimensions of the infobox

Declaration

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

Property Value

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

Elements

A list of renderable elements in a container

Declaration

public Container Elements { get; set; }

Property Value

Type	Description
Container

Positioning

Positioning settings

Declaration

public InfoBoxPositioning Positioning { get; }

Property Value

Type	Description
InfoBoxPositioning

Settings

Informational box settings

Declaration

public InfoBoxSettings Settings { get; set; }

Property Value

Type	Description
InfoBoxSettings

Text

Text that will be rendered inside the informational box

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

Methods

Render(ref int, int, bool, bool)

Renders this informational box

Declaration

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

Parameters

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

Returns

Type	Description
string