Class BoundedText

Bounded text renderable

Inheritance
object
BoundedText
Implements
Namespace: Terminaux.Writer.CyclicWriters
Assembly: Terminaux.dll
Syntax
public class BoundedText : IStaticRenderable

Constructors

| Edit this page View Source

BoundedText(Mark?, params object[])

Makes a new instance of the bounded text renderer

Declaration
public BoundedText(Mark? text = null, params object[] vars)
Parameters
Type Name Description
Mark text

Text to use
object[] vars

Variables to format the text with

Properties

| Edit this page View Source

BackgroundColor

Background color of the text

Declaration
public Color BackgroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

Column

[Position-wise] Specifies a zero-based column index

Declaration
public int Column { get; set; }
Property Value
Type Description
int
| Edit this page View Source

ForegroundColor

Foreground color of the text

Declaration
public Color ForegroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

Height

Right margin of the aligned figlet text

Declaration
public int Height { get; set; }
Property Value
Type Description
int
| Edit this page View Source

IncrementRate

[Line-wise] Specifies an incrementation rate

Declaration
public int IncrementRate { get; }
Property Value
Type Description
int
| Edit this page View Source

Left

Left position

Declaration
public int Left { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Line

[Line-wise] Specifies a zero-based line index

Declaration
public int Line { get; set; }
Property Value
Type Description
int
| Edit this page View Source

PositionWise

Whether to form a bounded text position-wise or line-wise

Declaration
public bool PositionWise { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Row

[Position-wise] Specifies a zero-based row index

Declaration
public int Row { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Settings

Text settings to use

Declaration
public TextSettings Settings { get; set; }
Property Value
Type Description
TextSettings
| Edit this page View Source

Text

A text to render

Declaration
public string Text { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Top

Top position

Declaration
public int Top { get; set; }
Property Value
Type Description
int
| Edit this page View Source

UseColors

Whether to use colors or not

Declaration
public bool UseColors { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Width

Left margin of the aligned figlet text

Declaration
public int Width { get; set; }
Property Value
Type Description
int

Methods

| Edit this page View Source

Render()

Renders an aligned figlet text

Declaration
public string Render()
Returns
Type Description
string

Rendered text that will be used by the renderer

Implements