Logo fantomas

RichTextBuilder Type

Accumulates rich text. Adjacent parts with the same classification are merged, so that where one append ended is not visible in the result. AppendString has the same name and signature as the StringBuilder extension in lib.fs, so that message formatting code can be moved over to rich text without being rewritten, and can then be converted to emit classified parts one message at a time.

Constructors

Constructor Description

RichTextBuilder()

Full Usage: RichTextBuilder()

Returns: RichTextBuilder

Instance members

Instance member Description

this.Append

Full Usage: this.Append

Parameters:
    format : (RichText -> string) -> string

Appends a message whose arguments are spliced in by the given function, for messages that mix classified and plain arguments. See RichMessage.

format : (RichText -> string) -> string

this.Append

Full Usage: this.Append

Parameters:

Appends a message from a resource file, classifying each of its arguments

message : ResourceString<(string -> string -> string -> string -> string)>
a0 : RichText
a1 : RichText
a2 : RichText
a3 : RichText

this.Append

Full Usage: this.Append

Parameters:

Appends a message from a resource file, classifying each of its arguments

message : ResourceString<(string -> string -> string -> string)>
a0 : RichText
a1 : RichText
a2 : RichText

this.Append

Full Usage: this.Append

Parameters:

Appends a message from a resource file, classifying each of its arguments

message : ResourceString<(string -> string -> string)>
a0 : RichText
a1 : RichText

this.Append

Full Usage: this.Append

Parameters:

Appends a message from FSStrings, classifying each of its arguments. The FSComp accessors are generated with overloads taking classified arguments, so those are called directly and their result appended; the FSStrings ones are declared by hand and have no such overload.

message : ResourceString<(string -> string)>
a0 : RichText

this.Append

Full Usage: this.Append

Parameters:

Appends the parts of another rich text

value : RichText

this.Append

Full Usage: this.Append

Parameters:

Appends a single tagged part

value : TaggedText

this.Append

Full Usage: this.Append

Parameters:
    value : string

Appends unclassified text, tagged TextTag.Text

value : string

this.IsEmpty

Full Usage: this.IsEmpty

Returns: bool

Gets whether nothing has been appended

Returns: bool

this.ToRichText

Full Usage: this.ToRichText

Returns: RichText

Gets the accumulated text

Returns: RichText

Type something to start searching.