Class WrappedWriter
Wrapped writer similar to less and more commands on Unix
Inheritance
Namespace: Terminaux.Writer.ConsoleWriters
Assembly: Terminaux.dll
Syntax
public static class WrappedWriterMethods
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
| Type | Name | Description |
|---|---|---|
| string | text | Text to write. If it's shorter than the console height, it just prints the text |
| bool | force | Forces the text viewer to open, even if the text doesn't exceed the console height |
| object[] | args | 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
| Type | Name | Description |
|---|---|---|
| string | text | 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. |
| bool | force | Forces the text viewer to open, even if the text doesn't exceed the console height |
| object[] | args | Arguments to format the text |
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
| Type | Name | Description |
|---|---|---|
| string | text | Text to write. If it's shorter than the console height, it just prints the text |
| Color | foregroundColor | A foreground color that will be changed to. |
| Color | backgroundColor | A background color that will be changed to. |
| bool | force | Forces the text viewer to open, even if the text doesn't exceed the console height |
| object[] | args | 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
| Type | Name | Description |
|---|---|---|
| string | text | Text to write. If it's shorter than the console height, it just prints the text |
| ThemeColorType | color | A color that will be changed to. |
| bool | force | Forces the text viewer to open, even if the text doesn't exceed the console height |
| object[] | args | 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
| Type | Name | Description |
|---|---|---|
| string | text | Text to write. If it's shorter than the console height, it just prints the text |
| ThemeColorType | foregroundColor | A foreground color that will be changed to. |
| ThemeColorType | backgroundColor | A background color that will be changed to. |
| bool | force | Forces the text viewer to open, even if the text doesn't exceed the console height |
| object[] | args | Arguments to format the text |
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
| 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. |
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
| 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. |
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
| 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 |
| ThemeColorType | colorType | A type of colors that will be changed. |
| object[] | vars | 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
| 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 |
| 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. |
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
| 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. |