Class TextWriterWhereColor

Console text writer with color support (positional write)

Inheritance

object

TextWriterWhereColor

Namespace: Terminaux.Writer.ConsoleWriters

Assembly: Terminaux.dll

Syntax

public static class TextWriterWhereColor

Methods

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

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, bool Return, int RightMargin, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderWhere(string, int, int, bool, int, ThemeColorType, params object[])

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, bool Return, int RightMargin, ThemeColorType ForegroundColor = ThemeColorType.NeutralText, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
ThemeColorType	ForegroundColor	A foreground color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderWhere(string, int, int, bool, int, ThemeColorType, ThemeColorType, params object[])

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, bool Return, int RightMargin, ThemeColorType ForegroundColor = ThemeColorType.NeutralText, ThemeColorType BackgroundColor = ThemeColorType.Background, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
ThemeColorType	ForegroundColor	A foreground color that will be changed to.
ThemeColorType	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, bool Return, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderWhere(string, int, int, bool, ThemeColorType, params object[])

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, bool Return, ThemeColorType ForegroundColor = ThemeColorType.NeutralText, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
ThemeColorType	ForegroundColor	A foreground color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderWhere(string, int, int, bool, ThemeColorType, ThemeColorType, params object[])

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, bool Return, ThemeColorType ForegroundColor = ThemeColorType.NeutralText, ThemeColorType BackgroundColor = ThemeColorType.Background, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
ThemeColorType	ForegroundColor	A foreground color that will be changed to.
ThemeColorType	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderWhere(string, int, int, ThemeColorType, params object[])

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, ThemeColorType ForegroundColor = ThemeColorType.NeutralText, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
ThemeColorType	ForegroundColor	A foreground color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

RenderWhere(string, int, int, ThemeColorType, ThemeColorType, params object[])

Renders the text with location support.

Declaration

public static string RenderWhere(string msg, int Left, int Top, ThemeColorType ForegroundColor = ThemeColorType.NeutralText, ThemeColorType BackgroundColor = ThemeColorType.Background, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
ThemeColorType	ForegroundColor	A foreground color that will be changed to.
ThemeColorType	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhereColor(string msg, int Left, int Top, bool Return, int RightMargin, Color ForegroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
Color	ForegroundColor	A foreground color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhereColor(string msg, int Left, int Top, bool Return, Color ForegroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhereColor(string msg, int Left, int Top, Color ForegroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
Color	ForegroundColor	A foreground color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhereColorBack(string msg, int Left, int Top, bool Return, int RightMargin, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhereColorBack(string msg, int Left, int Top, bool Return, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWhereColorBack(string msg, int Left, int Top, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWherePlain(string msg, int Left, int Top, bool Return, int RightMargin, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWherePlain(string msg, int Left, int Top, bool Return, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Renders the text with location support.

Declaration

public static string RenderWherePlain(string msg, int Left, int Top, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

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

Outputs the text into the terminal prompt with location support.

Declaration

public static void WriteWhere(string msg, int Left, int Top, bool Return, int RightMargin, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
object[]	vars	Variables to format the message before it's written.

WriteWhere(string, int, int, bool, int, ThemeColorType, params object[])

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhere(string msg, int Left, int Top, bool Return, int RightMargin, ThemeColorType colorType = ThemeColorType.NeutralText, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
ThemeColorType	colorType	A type of colors that will be changed.
object[]	vars	Variables to format the message before it's written.

WriteWhere(string, int, int, bool, int, ThemeColorType, ThemeColorType, params object[])

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhere(string msg, int Left, int Top, bool Return, int RightMargin, ThemeColorType colorTypeForeground = ThemeColorType.NeutralText, ThemeColorType colorTypeBackground = ThemeColorType.Background, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
ThemeColorType	colorTypeForeground	A type of colors that will be changed for the foreground color.
ThemeColorType	colorTypeBackground	A type of colors that will be changed for the background color.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support.

Declaration

public static void WriteWhere(string msg, int Left, int Top, bool Return, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
object[]	vars	Variables to format the message before it's written.

WriteWhere(string, int, int, bool, ThemeColorType, params object[])

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhere(string msg, int Left, int Top, bool Return, ThemeColorType colorType = ThemeColorType.NeutralText, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
ThemeColorType	colorType	A type of colors that will be changed.
object[]	vars	Variables to format the message before it's written.

WriteWhere(string, int, int, bool, ThemeColorType, ThemeColorType, params object[])

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhere(string msg, int Left, int Top, bool Return, ThemeColorType colorTypeForeground = ThemeColorType.NeutralText, ThemeColorType colorTypeBackground = ThemeColorType.Background, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
ThemeColorType	colorTypeForeground	A type of colors that will be changed for the foreground color.
ThemeColorType	colorTypeBackground	A type of colors that will be changed for the background color.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support.

Declaration

public static void WriteWhere(string msg, int Left, int Top, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
object[]	vars	Variables to format the message before it's written.

WriteWhere(string, int, int, ThemeColorType, params object[])

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhere(string msg, int Left, int Top, ThemeColorType colorType = ThemeColorType.NeutralText, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
ThemeColorType	colorType	A type of colors that will be changed.
object[]	vars	Variables to format the message before it's written.

WriteWhere(string, int, int, ThemeColorType, ThemeColorType, params object[])

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhere(string msg, int Left, int Top, ThemeColorType colorTypeForeground = ThemeColorType.NeutralText, ThemeColorType colorTypeBackground = ThemeColorType.Background, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
ThemeColorType	colorTypeForeground	A type of colors that will be changed for the foreground color.
ThemeColorType	colorTypeBackground	A type of colors that will be changed for the background color.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhereColor(string msg, int Left, int Top, bool Return, int RightMargin, Color color, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhereColor(string msg, int Left, int Top, bool Return, Color color, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhereColor(string msg, int Left, int Top, Color color, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhereColorBack(string msg, int Left, int Top, bool Return, int RightMargin, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhereColorBack(string msg, int Left, int Top, bool Return, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support, and sets colors as needed.

Declaration

public static void WriteWhereColorBack(string msg, int Left, int Top, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
Color	ForegroundColor	A foreground color that will be changed to.
Color	BackgroundColor	A background color that will be changed to.
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support.

Declaration

public static void WriteWherePlain(string msg, int Left, int Top, bool Return, int RightMargin, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
int	RightMargin	The right margin
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support.

Declaration

public static void WriteWherePlain(string msg, int Left, int Top, bool Return, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
bool	Return	Whether or not to return to old position
object[]	vars	Variables to format the message before it's written.

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

Outputs the text into the terminal prompt with location support.

Declaration

public static void WriteWherePlain(string msg, int Left, int Top, params object[] vars)

Parameters

Type	Name	Description
string	msg	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
int	Left	Column number in console
int	Top	Row number in console
object[]	vars	Variables to format the message before it's written.