webmaster442.windowsterminal.terminalformattedstringbuilder - webmaster442/WindowsTerminal GitHub Wiki
TerminalFormattedStringBuilder
Namespace: Webmaster442.WindowsTerminal
Formatted text output builder
public sealed class TerminalFormattedStringBuilder
Inheritance Object → TerminalFormattedStringBuilder Attributes NullableContextAttribute, NullableAttribute
Constructors
TerminalFormattedStringBuilder()
Create a new instance of TerminalFormattedStringBuilder
public TerminalFormattedStringBuilder()
Methods
Append(String)
Append a text to the formatted string
public TerminalFormattedStringBuilder Append(string text)
Parameters
text String
text
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
Append(Char)
Appends the string representation of a specified System.Char object to this instance.
public TerminalFormattedStringBuilder Append(char chr)
Parameters
chr Char
The UTF-16-encoded code unit to append.
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
Append(Char, Int32)
Appends a specified number of copies of the string representation of a Unicode character to this instance.
public TerminalFormattedStringBuilder Append(char chr, int repeatCount)
Parameters
chr Char
The UTF-16-encoded code unit to append.
repeatCount Int32
The number of times to append chr.
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
Append(Object)
Appends the string representation of a specified object to this instance.
public TerminalFormattedStringBuilder Append(object obj)
Parameters
obj Object
object to append
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendFormat(String, Object[])
Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Each format item is replaced by the string representation of a corresponding argument in a parameter array.
public TerminalFormattedStringBuilder AppendFormat(string format, Object[] args)
Parameters
format String
A composite format string.
args Object[]
An array of objects to format.
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendJoin<T>(Char, IEnumerable<T>)
Concatenates and appends the members of a collection, using the specified separator between each member.
public TerminalFormattedStringBuilder AppendJoin<T>(char separator, IEnumerable<T> values)
Type Parameters
T
The type of the members of values.
Parameters
separator Char
The character to use as a separator. separator is included in the concatenated and appended strings only if values has more than one element.
values IEnumerable<T>
A collection that contains the objects to concatenate and append to the current TerminalFormattedStringBuilder
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendJoin<T>(String, IEnumerable<T>)
Concatenates and appends the members of a collection, using the specified separator between each member.
public TerminalFormattedStringBuilder AppendJoin<T>(string separator, IEnumerable<T> values)
Type Parameters
T
The type of the members of values.
Parameters
separator String
The string to use as a separator. separator is included in the concatenated and appended strings only if values has more than one element.
values IEnumerable<T>
A collection that contains the objects to concatenate and append to the current TerminalFormattedStringBuilder
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendLine(String)
Append a line to the formatted string
public TerminalFormattedStringBuilder AppendLine(string text)
Parameters
text String
text
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendLine()
Append a line to the formatted string
public TerminalFormattedStringBuilder AppendLine()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendLink(String, String)
Append a clickable link
public TerminalFormattedStringBuilder AppendLink(string link, string text)
Parameters
link String
link url
text String
link display text
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
AppendLink(Uri, String)
Append a clickable link
public TerminalFormattedStringBuilder AppendLink(Uri uri, string text)
Parameters
uri Uri
link url
text String
link display text
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
New()
Clear internal buffer
public TerminalFormattedStringBuilder New()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
ResetFormat()
Reset all formatting
public TerminalFormattedStringBuilder ResetFormat()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
ToString()
Convert the formatted string to a string
public string ToString()
Returns
String a string with ANSI escape codes
WithBackgroundColor(TerminalColor)
Set background color to a standard color
public TerminalFormattedStringBuilder WithBackgroundColor(TerminalColor color)
Parameters
color TerminalColor
Color to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithBackgroundColor(ConsoleColor)
Set background color to a standard color
public TerminalFormattedStringBuilder WithBackgroundColor(ConsoleColor color)
Parameters
color ConsoleColor
Color to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithBackgroundColor(String)
Set background color to a 24 bit RGB color
public TerminalFormattedStringBuilder WithBackgroundColor(string color)
Parameters
color String
color in hex format (E.g: #000000) or rgb format (E.g: rgb(0, 0, 0)) or hsl format. (E.g: hsl(0, 0%, 0%))
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
Exceptions
FormatException The color was not one of the supported formats.
WithBackgroundColor(Byte, Byte, Byte)
Set background color to a 24 bit RGB color
public TerminalFormattedStringBuilder WithBackgroundColor(byte r, byte g, byte b)
Parameters
r Byte
red value
g Byte
green value
b Byte
blue value
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithBackgroundColor(Color)
Set background color to a 24 bit RGB color
public TerminalFormattedStringBuilder WithBackgroundColor(Color c)
Parameters
c Color
An RGB color to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithBackgroundColor(Int32)
Set background color to a 256 color index. Color index must be between 0 and 255
public TerminalFormattedStringBuilder WithBackgroundColor(int index)
Parameters
index Int32
color index to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithBold()
Set text to bold
public TerminalFormattedStringBuilder WithBold()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithForegroundColor(TerminalColor)
Set foreground color to a standard color
public TerminalFormattedStringBuilder WithForegroundColor(TerminalColor color)
Parameters
color TerminalColor
Color to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithForegroundColor(ConsoleColor)
Set foreground color to a standard color
public TerminalFormattedStringBuilder WithForegroundColor(ConsoleColor color)
Parameters
color ConsoleColor
Color to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithForegroundColor(String)
Set foreground color to a 24 bit RGB color
public TerminalFormattedStringBuilder WithForegroundColor(string color)
Parameters
color String
color in hex format (E.g: #ffffff) or rgb format (E.g: rgb(255, 255, 255)) or hsl format. (E.g: hsl(0, 0%, 100%))
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
Exceptions
FormatException The color was not one of the supported formats.
WithForegroundColor(Byte, Byte, Byte)
Set foreground color to a 24 bit RGB color
public TerminalFormattedStringBuilder WithForegroundColor(byte r, byte g, byte b)
Parameters
r Byte
red value
g Byte
green value
b Byte
blue value
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithForegroundColor(Color)
Set foreground color to a 24 bit RGB color
public TerminalFormattedStringBuilder WithForegroundColor(Color c)
Parameters
c Color
An RGB color to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithForegroundColor(Int32)
Set foreground color to a 256 color index. Color index must be between 0 and 255
public TerminalFormattedStringBuilder WithForegroundColor(int index)
Parameters
index Int32
color index to use
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithInverse()
Inverts text foreground and background colors
public TerminalFormattedStringBuilder WithInverse()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithItalic()
Set text to italic
public TerminalFormattedStringBuilder WithItalic()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithNerdFont(Int32)
Append a nerd font icon to the output. Terminal needs to have a nerd font installed Cheat sheet: https://www.nerdfonts.com/cheat-sheet
public TerminalFormattedStringBuilder WithNerdFont(int nerdFont)
Parameters
nerdFont Int32
Nerd font icon codepoint to display
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting
WithUnderline()
Set text to underline
public TerminalFormattedStringBuilder WithUnderline()
Returns
TerminalFormattedStringBuilder A TerminalFormattedStringBuilder to chain formatting