Skip to content
ConsoleMonster

API Reference

Class

RichTextBuilder

Edit on GitHub
Namespace ConsoleMonster.Text
Assembly ConsoleMonster
Source RichTextBuilder.cs:10
Modifiers sealed

Builds RichText fluently: new RichTextBuilder().Append("SPF ", ConsoleColor.Gray).Append("PASS", ThemeToken.Pass, TextDecoration.Bold).Build().

Inheritance

  • Object
  • RichTextBuilder

Usage

Explore 4 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 4

Constructors

public RichTextBuilder() #
RichTextBuilder.cs:10

Methods

Append 3 overloads
public RichTextBuilder Append(String? text, RichStyle style = default) #
RichTextBuilder.cs:17
Returns: RichTextBuilder

Appends literal text.

Parameters

text System.String? requiredposition: 0
The text (shown as written).
style ConsoleMonster.Styling.RichStyle = default optionalposition: 1
The style.

Returns

This builder.

public RichTextBuilder Append(String? text, RichColor foreground, TextDecoration decoration = None, RichColor background = default) #
RichTextBuilder.cs:28
Returns: RichTextBuilder

Appends literal text with a foreground colour, decorations and an optional background.

Parameters

text System.String? requiredposition: 0
The text.
foreground ConsoleMonster.Styling.RichColor requiredposition: 1
The foreground (a ConsoleColor, theme role or colour converts implicitly).
decoration ConsoleMonster.Styling.TextDecoration = None optionalposition: 2
Decorations.
background ConsoleMonster.Styling.RichColor = default optionalposition: 3
The background.

Returns

This builder.

public RichTextBuilder Append(RichText? text) #
RichTextBuilder.cs:50
Returns: RichTextBuilder

Appends other rich text.

Parameters

text ConsoleMonster.Text.RichText? requiredposition: 0
The text.

Returns

This builder.

public RichTextBuilder AppendLine() #
RichTextBuilder.cs:58
Returns: RichTextBuilder

Appends a line break.

Returns

This builder.

public RichTextBuilder AppendMarkup(String? markup) #
RichTextBuilder.cs:42
Returns: RichTextBuilder

Appends markup.

Parameters

markup System.String? requiredposition: 0
The markup.

Returns

This builder.

public RichText Build() #
RichTextBuilder.cs:62
Returns: RichText

Creates the rich text.

Returns

The rich text.