Class VtSequenceTools

Provides all the tools for manipulating with the VT sequences

Inheritance

object

VtSequenceTools

Namespace: Terminaux.Sequences

Assembly: Terminaux.dll

Syntax

public static class VtSequenceTools

Methods

DetermineTypeFromText(string)

Determines the VT sequence type from the given text

Declaration

public static VtSequenceType DetermineTypeFromText(string Text)

Parameters

Type	Name	Description
string	Text	Text that contains escape sequences

Returns

Type	Description
VtSequenceType	The type that contains all the VT escape sequence types found in the Text

FilterVTSequences(string, string, VtSequenceType)

Filters all of the VT sequences with support for multiple types

Declaration

public static string FilterVTSequences(string Text, string replace = "", VtSequenceType types = VtSequenceType.All)

Parameters

Type	Name	Description
string	Text	The text that contains the VT sequences
string	replace	Replace the sequences with this text
VtSequenceType	types	VT sequence types

Returns

Type	Description
string	The text that doesn't contain the VT sequences

IsMatchVTSequences(string, VtSequenceType)

Does the string contain all of the VT sequences or a VT sequence of any type?

Declaration

public static bool IsMatchVTSequences(string Text, VtSequenceType type = VtSequenceType.All)

Parameters

Type	Name	Description
string	Text	The text that contains the VT sequences
VtSequenceType	type	VT sequence type

Returns

Type	Description
bool	True if any of the provided VT types are found; otherwise, false.

IsMatchVTSequencesSpecific(string, VtSequenceType)

Does the string contain all of the VT sequences or a VT sequence of any specific type?

Declaration

public static ReadOnlyDictionary<VtSequenceType, bool> IsMatchVTSequencesSpecific(string Text, VtSequenceType type = VtSequenceType.All)

Parameters

Type	Name	Description
string	Text	The text that contains the VT sequences
VtSequenceType	type	VT sequence type

Returns

Type	Description
ReadOnlyDictionary<VtSequenceType, bool>	A dictionary of each VT sequence type with either true/false for any type test.

MatchVTSequences(string, VtSequenceType)

Matches all of the VT sequences

Declaration

public static ReadOnlyDictionary<VtSequenceType, VtSequenceInfo[]> MatchVTSequences(string Text, VtSequenceType type = VtSequenceType.All)

Parameters

Type	Name	Description
string	Text	The text that contains the VT sequences
VtSequenceType	type	VT sequence type

Returns

Type	Description
ReadOnlyDictionary<VtSequenceType, VtSequenceInfo[]>	The array of VtSequenceInfo that contain the information for the found VT sequences

SplitVTSequences(string, VtSequenceType)

Splits all of the VT sequences

Declaration

public static string[] SplitVTSequences(string Text, VtSequenceType types = VtSequenceType.All)

Parameters

Type	Name	Description
string	Text	The text that contains the VT sequences
VtSequenceType	types	VT sequence types

Returns

Type	Description
string[]	The group of texts that don't contain the VT sequences