Class MarkupTools

Markup parsing and processing tools

Inheritance

object

MarkupTools

Namespace

Terminaux.Writer.CyclicWriters.Renderer.Markup @ Terminaux.dll

Syntax

public static class MarkupTools

Methods

GetMarkupInfo(string)

Gets a list of markup information instances

Returns

MarkupInfo[]

Array of parsed markup representations

Declaration

public static MarkupInfo[] GetMarkupInfo(string markup)

Parameters

Name	Type	Description
markup	string	Markup representation

GetMarkupInfo(Mark?)

Gets a list of markup information instances

Returns

MarkupInfo[]

Array of parsed markup representations

Declaration

public static MarkupInfo[] GetMarkupInfo(Mark? mark)

Parameters

Name	Type	Description
mark	Mark	Markup instance

GetMarkupInfo(WideString)

Gets a list of markup information instances

Returns

MarkupInfo[]

Array of parsed markup representations

Declaration

public static MarkupInfo[] GetMarkupInfo(WideString markup)

Parameters

Name	Type	Description
markup	WideString	Markup representation

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

Parses the markup representation

Returns

string

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

Declaration

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

Parameters

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

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

Parses the markup representation

Returns

string

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

Declaration

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

Parameters

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

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

Parses the markup representation

Returns

string

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

Declaration

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

Parameters

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

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

Parses the markup representation

Returns

bool

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

Declaration

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

Parameters

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

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

Parses the markup representation

Returns

bool

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

Declaration

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

Parameters

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

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

Parses the markup representation

Returns

bool

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

Declaration

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

Parameters

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