Class TextWriterHighlightedColor

Console text writer with color support

Inheritance

object

TextWriterHighlightedColor

Namespace: Terminaux.Writer.ConsoleWriters

Assembly: Terminaux.dll

Syntax

public static class TextWriterHighlightedColor

Methods

| Edit this page View Source

Render(bool, string, params object[])

Outputs the text into the terminal prompt.

Declaration

public static string Render(bool legacy, string Text, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

| Edit this page View Source

Render(string, params object[])

Outputs the text into the terminal prompt.

Declaration

public static string Render(string Text, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

| Edit this page View Source

RenderColor(bool, string, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static string RenderColor(bool legacy, string Text, Color color, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

| Edit this page View Source

RenderColor(string, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static string RenderColor(string Text, Color color, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

Returns

Type	Description
string

| Edit this page View Source

RenderColorBack(bool, string, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static string RenderColorBack(bool legacy, string Text, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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

| Edit this page View Source

RenderColorBack(string, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static string RenderColorBack(string Text, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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

| Edit this page View Source

Write(bool, string, bool, params object[])

Outputs the text into the terminal prompt.

Declaration

public static void Write(bool legacy, string Text, bool Line, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
bool	Line	Whether to print a new line or not
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

Write(bool, string, params object[])

Outputs the text into the terminal prompt.

Declaration

public static void Write(bool legacy, string Text, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

Write(string, bool, params object[])

Outputs the text into the terminal prompt.

Declaration

public static void Write(string Text, bool Line, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
bool	Line	Whether to print a new line or not
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

Write(string, params object[])

Outputs the text into the terminal prompt.

Declaration

public static void Write(string Text, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteColor(bool, string, bool, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColor(bool legacy, string Text, bool Line, Color color, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
bool	Line	Whether to print a new line or not
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteColor(bool, string, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColor(bool legacy, string Text, Color color, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteColor(string, bool, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColor(string Text, bool Line, Color color, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
bool	Line	Whether to print a new line or not
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteColor(string, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColor(string Text, Color color, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteColorBack(bool, string, bool, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColorBack(bool legacy, string Text, bool Line, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
bool	Line	Whether to print a new line or not
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.

| Edit this page View Source

WriteColorBack(bool, string, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColorBack(bool legacy, string Text, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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.

| Edit this page View Source

WriteColorBack(string, bool, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColorBack(string Text, bool Line, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
bool	Line	Whether to print a new line or not
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.

| Edit this page View Source

WriteColorBack(string, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support.

Declaration

public static void WriteColorBack(string Text, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
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.

| Edit this page View Source

WriteForReader(bool, string, TermReaderSettings?, bool, params object[])

Outputs the text into the terminal prompt. Use for TermReader custom bindings.

Declaration

public static void WriteForReader(bool legacy, string Text, TermReaderSettings? settings, bool Line, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
bool	Line	Whether to print a new line or not
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReader(bool, string, TermReaderSettings?, params object[])

Outputs the text into the terminal prompt. Use for TermReader custom bindings.

Declaration

public static void WriteForReader(bool legacy, string Text, TermReaderSettings? settings, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReader(string, TermReaderSettings?, bool, params object[])

Outputs the text into the terminal prompt. Use for TermReader custom bindings.

Declaration

public static void WriteForReader(string Text, TermReaderSettings? settings, bool Line, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
bool	Line	Whether to print a new line or not
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReader(string, TermReaderSettings?, params object[])

Outputs the text into the terminal prompt. Use for TermReader custom bindings.

Declaration

public static void WriteForReader(string Text, TermReaderSettings? settings, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReaderColor(bool, string, TermReaderSettings?, bool, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColor(bool legacy, string Text, TermReaderSettings? settings, bool Line, Color color, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
bool	Line	Whether to print a new line or not
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReaderColor(bool, string, TermReaderSettings?, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColor(bool legacy, string Text, TermReaderSettings? settings, Color color, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReaderColor(string, TermReaderSettings?, bool, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColor(string Text, TermReaderSettings? settings, bool Line, Color color, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
bool	Line	Whether to print a new line or not
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReaderColor(string, TermReaderSettings?, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColor(string Text, TermReaderSettings? settings, Color color, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
Color	color	A color that will be changed to.
object[]	vars	Variables to format the message before it's written.

| Edit this page View Source

WriteForReaderColorBack(bool, string, TermReaderSettings?, bool, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColorBack(bool legacy, string Text, TermReaderSettings? settings, bool Line, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
bool	Line	Whether to print a new line or not
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.

| Edit this page View Source

WriteForReaderColorBack(bool, string, TermReaderSettings?, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColorBack(bool legacy, string Text, TermReaderSettings? settings, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
bool	legacy	Use RenderSetConsoleColor(Color, bool, bool, bool) instead of text formatting
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
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.

| Edit this page View Source

WriteForReaderColorBack(string, TermReaderSettings?, bool, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColorBack(string Text, TermReaderSettings? settings, bool Line, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
bool	Line	Whether to print a new line or not
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.

| Edit this page View Source

WriteForReaderColorBack(string, TermReaderSettings?, Color, Color, params object[])

Outputs the text into the terminal prompt with custom color support. Use for TermReader custom bindings.

Declaration

public static void WriteForReaderColorBack(string Text, TermReaderSettings? settings, Color ForegroundColor, Color BackgroundColor, params object[] vars)

Parameters

Type	Name	Description
string	Text	A sentence that will be written to the terminal prompt. Supports {0}, {1}, ...
TermReaderSettings	settings	Terminal reader settings
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.