Class WrappedWriter

Wrapped writer similar to less and more commands on Unix

Inheritance

object

WrappedWriter

Namespace

Terminaux.Writer.ConsoleWriters @ Terminaux.dll

Syntax

public static class WrappedWriter

Methods

OpenWrapped(string, Color, Color, bool, params object?[]?)

Opens the text viewer similar to less and more commands on Unix

Declaration

public static void OpenWrapped(string text, Color foregroundColor, Color backgroundColor, bool force = false, params object?[]? args)

Parameters

Name	Type	Description
text	string	Text to write. If it's shorter than the console height, it just prints the text
foregroundColor	Color	A foreground color that will be changed to.
backgroundColor	Color	A background color that will be changed to.
force	bool	Forces the text viewer to open, even if the text doesn't exceed the console height
args	object[]	Arguments to format the text

OpenWrapped(string, Color, bool, params object?[]?)

Opens the text viewer similar to less and more commands on Unix

Declaration

public static void OpenWrapped(string text, Color color, bool force = false, params object?[]? args)

Parameters

Name	Type	Description
text	string	Text to write. If it's shorter than the console height, it just prints the text
color	Color	A color that will be changed to.
force	bool	Forces the text viewer to open, even if the text doesn't exceed the console height
args	object[]	Arguments to format the text

OpenWrapped(string, bool, params object?[]?)

Opens the text viewer similar to less and more commands on Unix

Declaration

public static void OpenWrapped(string text, bool force = false, params object?[]? args)

Parameters

Name	Type	Description
text	string	Text to write. If it's shorter than the console height, it just prints the text
force	bool	Forces the text viewer to open, even if the text doesn't exceed the console height
args	object[]	Arguments to format the text

OpenWrapped(string, ThemeColorType, bool, params object?[]?)

Opens the text viewer similar to less and more commands on Unix

Declaration

public static void OpenWrapped(string text, ThemeColorType color = ThemeColorType.NeutralText, bool force = false, params object?[]? args)

Parameters

Name	Type	Description
text	string	Text to write. If it's shorter than the console height, it just prints the text
color	ThemeColorType	A color that will be changed to.
force	bool	Forces the text viewer to open, even if the text doesn't exceed the console height
args	object[]	Arguments to format the text

OpenWrapped(string, ThemeColorType, ThemeColorType, bool, params object?[]?)

Opens the text viewer similar to less and more commands on Unix

Declaration

public static void OpenWrapped(string text, ThemeColorType foregroundColor, ThemeColorType backgroundColor, bool force = false, params object?[]? args)

Parameters

Name	Type	Description
text	string	Text to write. If it's shorter than the console height, it just prints the text
foregroundColor	ThemeColorType	A foreground color that will be changed to.
backgroundColor	ThemeColorType	A background color that will be changed to.
force	bool	Forces the text viewer to open, even if the text doesn't exceed the console height
args	object[]	Arguments to format the text

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

Writes the text in a pager similar to less and more commands on Unix

Declaration

public static void WriteWrapped(string Text, bool Line, Color foregroundColor, Color backgroundColor, params object[] vars)

Parameters

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

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

Writes the text in a pager similar to less and more commands on Unix

Declaration

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

Parameters

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

WriteWrapped(string, bool, ThemeColorType, params object[])

Outputs the text into the terminal prompt, wraps the long terminal output if needed, and sets colors as needed.

Declaration

public static void WriteWrapped(string Text, bool Line, ThemeColorType colorType = ThemeColorType.NeutralText, params object[] vars)

Parameters

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

WriteWrapped(string, bool, ThemeColorType, ThemeColorType, params object[])

Outputs the text into the terminal prompt, wraps the long terminal output if needed, and sets colors as needed.

Declaration

public static void WriteWrapped(string Text, bool Line, ThemeColorType colorTypeForeground = ThemeColorType.NeutralText, ThemeColorType colorTypeBackground = ThemeColorType.Background, params object[] vars)

Parameters

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

WriteWrappedPlain(string, bool, params object[])

Writes the text in a pager similar to less and more commands on Unix

Declaration

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

Parameters

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