Class FigletWhereColor

Figlet writer (positional)

Inheritance

object

FigletWhereColor

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 FigletWhereColor

Methods

RenderFigletWhere(string, int, int, bool, Color, int, int, params object[])

Renders the figlet text with position support

Declaration

public static string RenderFigletWhere(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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

RenderFigletWhere(string, int, int, bool, Color, Color, int, int, params object[])

Renders the figlet text with position support

Declaration

public static string RenderFigletWhere(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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

RenderFigletWhere(string, int, int, bool, FigletFont, Color, int, int, params object[])

Renders the figlet text with position support

Declaration

public static string RenderFigletWhere(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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

RenderFigletWhere(string, int, int, bool, FigletFont, Color, Color, int, int, params object[])

Renders the figlet text with position support

Declaration

public static string RenderFigletWhere(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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

RenderFigletWherePlain(string, int, int, bool, int, int, params object[])

Renders the figlet text with position support

Declaration

public static string RenderFigletWherePlain(string Text, int Left, int Top, bool Return, 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	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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

RenderFigletWherePlain(string, int, int, bool, FigletFont, int, int, params object[])

Renders the figlet text with position support

Declaration

public static string RenderFigletWherePlain(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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

WriteFigletWhereColor(string, int, int, bool, Color, int, int, params object[])

Writes the figlet text with position support

Declaration

public static void WriteFigletWhereColor(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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.

WriteFigletWhereColor(string, int, int, bool, FigletFont, Color, int, int, params object[])

Writes the figlet text with position support

Declaration

public static void WriteFigletWhereColor(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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.

WriteFigletWhereColorBack(string, int, int, bool, Color, Color, int, int, params object[])

Writes the figlet text with position support

Declaration

public static void WriteFigletWhereColorBack(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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.

WriteFigletWhereColorBack(string, int, int, bool, FigletFont, Color, Color, int, int, params object[])

Writes the figlet text with position support

Declaration

public static void WriteFigletWhereColorBack(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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.

WriteFigletWherePlain(string, int, int, bool, int, int, params object[])

Writes the figlet text with position support

Declaration

public static void WriteFigletWherePlain(string Text, int Left, int Top, bool Return, 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	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	leftMargin	The left margin
int	rightMargin	The right margin
object[]	Vars	Variables to format the message before it's written.

WriteFigletWherePlain(string, int, int, bool, FigletFont, int, int, params object[])

Writes the figlet text with position support

Declaration

public static void WriteFigletWherePlain(string Text, int Left, int Top, bool Return, 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.
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
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.