Class FigletText

Figlet text renderable

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

Constructors

| Edit this page View Source

FigletText(FigletFont, Mark?, params object[])

Makes a new instance of the aligned figlet text renderer

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

Figlet font to render with
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

Font

Figlet font to render the text with

Declaration
public FigletFont Font { get; set; }
Property Value
Type Description
FigletFont
| 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

Left

Left position

Declaration
[Obsolete("FigletWhereColor is going to be obsolete soon. Use renderable positioning system instead.")]
public int Left { get; set; }
Property Value
Type Description
int
| Edit this page View Source

LeftMargin

Left margin of the aligned figlet text

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

RightMargin

Right margin of the aligned figlet text

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

Text

Top position

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

Top

Top position

Declaration
[Obsolete("FigletWhereColor is going to be obsolete soon. Use renderable positioning system instead.")]
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

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