Class FigletColor

Figlet writer

Inheritance

object

FigletColor

Namespace: Terminaux.Writer.FancyWriters

Assembly: Terminaux.dll

Syntax

[Obsolete("This is considered a legacy method of writing this fancy text and will be removed in a future version of Terminaux. Please use its cyclic writer equivalent.")]
public static class FigletColor

Methods

RenderFiglet(string, Color, int, int, params object[])

Renders the figlet text

Declaration

public static string RenderFiglet(string Text, Color ForegroundColor, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
Color	ForegroundColor	A foreground color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderFiglet(string, Color, Color, int, int, params object[])

Renders the figlet text

Declaration

public static string RenderFiglet(string Text, Color ForegroundColor, Color BackgroundColor, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderFiglet(string, FigletFont, Color, int, int, params object[])

Renders the figlet text

Declaration

public static string RenderFiglet(string Text, FigletFont FigletFont, Color ForegroundColor, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
FigletFont	FigletFont	Figlet font to use in the text.
Color	ForegroundColor	A foreground color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderFiglet(string, FigletFont, Color, Color, int, int, params object[])

Renders the figlet text

Declaration

public static string RenderFiglet(string Text, FigletFont FigletFont, Color ForegroundColor, Color BackgroundColor, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
FigletFont	FigletFont	Figlet font to use in the text.
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderFigletPlain(string, int, int, params object[])

Renders the figlet text

Declaration

public static string RenderFigletPlain(string Text, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderFigletPlain(string, FigletFont, int, int, params object[])

Renders the figlet text

Declaration

public static string RenderFigletPlain(string Text, FigletFont FigletFont, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
FigletFont	FigletFont	Figlet font to use in the text.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

Returns

Type	Description
string

WriteFigletColor(string, Color, int, int, params object[])

Writes the figlet text

Declaration

public static void WriteFigletColor(string Text, Color Color, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
Color	Color	A color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

WriteFigletColor(string, FigletFont, Color, int, int, params object[])

Writes the figlet text

Declaration

public static void WriteFigletColor(string Text, FigletFont FigletFont, Color Color, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
FigletFont	FigletFont	Figlet font to use in the text.
Color	Color	A color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

WriteFigletColorBack(string, Color, Color, int, int, params object[])

Writes the figlet text

Declaration

public static void WriteFigletColorBack(string Text, Color ForegroundColor, Color BackgroundColor, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

WriteFigletColorBack(string, FigletFont, Color, Color, int, int, params object[])

Writes the figlet text

Declaration

public static void WriteFigletColorBack(string Text, FigletFont FigletFont, Color ForegroundColor, Color BackgroundColor, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
FigletFont	FigletFont	Figlet font to use in the text.
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

WriteFigletPlain(string, int, int, params object[])

Writes the figlet text

Declaration

public static void WriteFigletPlain(string Text, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

WriteFigletPlain(string, FigletFont, int, int, params object[])

Writes the figlet text

Declaration

public static void WriteFigletPlain(string Text, FigletFont FigletFont, int leftMargin = 0, int rightMargin = 0, params object[] Vars)

Parameters

Type	Name	Description
string	Text	Text to be written. If nothing, the entire line is filled with the separator.
FigletFont	FigletFont	Figlet font to use in the text.
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.