Table of Contents

Class AnsiControlSequence

Namespace
Microlithix.Text.Ansi.Element
Assembly
AnsiParser.dll

Represents a single ANSI control sequence from the parsed input.

public record AnsiControlSequence : IAnsiStreamParserElement, IAnsiStringParserElement, IEquatable<AnsiControlSequence>
Inheritance
AnsiControlSequence
Implements
Inherited Members

Remarks

See Control Sequences for a detailed description of ANSI control sequences and their formats.

Constructors

AnsiControlSequence(string, params Parameter[])

Creates a new AnsiControlSequence instance from a function string and variable number of parameters.

AnsiControlSequence(string, IList<Parameter>)

Creates a new AnsiControlSequence instance from a function string and a list of parameters.

Properties

Function

The Function property determines how the Parameters should be interpreted, and the actions that the consuming application should initiate when it receives the control sequence. It consists of a character in the range 0x40-0x7e, optionally preceded by one or more characters in the range 0x20-0x2f. See ControlFunction for a standardized list of control sequence functions.

Parameters

A list of zero or more Parameter instances parsed from the control sequence.

Methods

ConvertLegacySGRParameters()

Returns a copy of this element with any legacy SGR parameters converted to standard SGR parameters.

HasLegacySGRParameter()

Checks if this control sequence is an SGR sequence containing a legacy SGR parameter.

ToString()

Returns a string representation of this AnsiControlSequence.