Class MarkupTools

Markup parsing and processing tools

Inheritance

object

MarkupTools

Namespace: Terminaux.Writer.CyclicWriters.Renderer.Markup

Assembly: Terminaux.dll

Syntax

public static class MarkupTools

Methods

| Edit this page View Source

ParseMarkup(string, Color?, Color?, string)

Parses the markup representation

Declaration

public static string ParseMarkup(string markup, Color? foregroundColor = null, Color? backgroundColor = null, string initialFormat = "")

Parameters

Type	Name	Description
string	markup	Markup representation
Color	foregroundColor	Foreground color of the initial markup color. Overrides the initial format argument.
Color	backgroundColor	Background color of the initial markup color. Overrides the initial format argument.
string	initialFormat	Initial format. Overrides the foreground and the background color arguments.

Returns

Type	Description
string	A string that can be written to the console with the parsed markup representations

| Edit this page View Source

ParseMarkup(Mark?, Color?, Color?, string)

Parses the markup representation

Declaration

public static string ParseMarkup(Mark? mark, Color? foregroundColor = null, Color? backgroundColor = null, string initialFormat = "")

Parameters

Type	Name	Description
Mark	mark	Markup instance
Color	foregroundColor	Foreground color of the initial markup color. Overrides the initial format argument.
Color	backgroundColor	Background color of the initial markup color. Overrides the initial format argument.
string	initialFormat	Initial format. Overrides the foreground and the background color arguments.

Returns

Type	Description
string	A string that can be written to the console with the parsed markup representations

| Edit this page View Source

ParseMarkup(WideString, Color?, Color?, string)

Parses the markup representation

Declaration

public static string ParseMarkup(WideString markup, Color? foregroundColor = null, Color? backgroundColor = null, string initialFormat = "")

Parameters

Type	Name	Description
WideString	markup	Markup representation
Color	foregroundColor	Foreground color of the initial markup color. Overrides the initial format argument.
Color	backgroundColor	Background color of the initial markup color. Overrides the initial format argument.
string	initialFormat	Initial format. Overrides the foreground and the background color arguments.

Returns

Type	Description
string	A string that can be written to the console with the parsed markup representations

| Edit this page View Source

TryParseMarkup(string, Color?, Color?, string)

Parses the markup representation

Declaration

public static bool TryParseMarkup(string markup, Color? foregroundColor = null, Color? backgroundColor = null, string initialFormat = "")

Parameters

Type	Name	Description
string	markup	Markup representation
Color	foregroundColor	Foreground color of the initial markup color. Overrides the initial format argument.
Color	backgroundColor	Background color of the initial markup color. Overrides the initial format argument.
string	initialFormat	Initial format. Overrides the foreground and the background color arguments.

Returns

Type	Description
bool	A string that can be written to the console with the parsed markup representations

| Edit this page View Source

TryParseMarkup(Mark?, Color?, Color?, string)

Parses the markup representation

Declaration

public static bool TryParseMarkup(Mark? mark, Color? foregroundColor = null, Color? backgroundColor = null, string initialFormat = "")

Parameters

Type	Name	Description
Mark	mark	Markup instance
Color	foregroundColor	Foreground color of the initial markup color. Overrides the initial format argument.
Color	backgroundColor	Background color of the initial markup color. Overrides the initial format argument.
string	initialFormat	Initial format. Overrides the foreground and the background color arguments.

Returns

Type	Description
bool	A string that can be written to the console with the parsed markup representations

| Edit this page View Source

TryParseMarkup(WideString, Color?, Color?, string)

Parses the markup representation

Declaration

public static bool TryParseMarkup(WideString markup, Color? foregroundColor = null, Color? backgroundColor = null, string initialFormat = "")

Parameters

Type	Name	Description
WideString	markup	Markup representation
Color	foregroundColor	Foreground color of the initial markup color. Overrides the initial format argument.
Color	backgroundColor	Background color of the initial markup color. Overrides the initial format argument.
string	initialFormat	Initial format. Overrides the foreground and the background color arguments.

Returns

Type	Description
bool	A string that can be written to the console with the parsed markup representations