Class ParserOptions

Namespace

OneImlx.Terminal.Configuration.Options

Assembly

OneImlx.Terminal.dll

The command parser options.

public sealed class ParserOptions

Inheritance

object

ParserOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

OptionAliasPrefix

The option alias prefix. Defaults to -.

public string OptionAliasPrefix { get; set; }

Property Value

string

Remarks

The option alias prefix cannot be null or whitespace.

OptionPrefix

The option prefix. Defaults to --.

public string OptionPrefix { get; set; }

Property Value

string

Remarks

The option prefix cannot be null or whitespace.

OptionValueSeparator

The option value separator. Defaults to .

public string OptionValueSeparator { get; set; }

Property Value

string

Remarks

The option value separator must be a single Unicode character, and it can be a single whitespace.

ParseHierarchy

Determines whether to parse the command hierarchy. Defaults to null.

public bool? ParseHierarchy { get; set; }

Property Value

bool?

Remarks

A command hierarchy is a structure of commands in the specified command route starting with a root, followed by nested groups and an executing command. Typically, for production use cases, the command hierarchy is not required.

Separator

The command string separator. Defaults to a single whitespace.

public string Separator { get; set; }

Property Value

string

Remarks

The command string separator must be a single Unicode character, and it can be a whitespace character.

ValueDelimiter

An argument or option value delimiter. It is used to extract a value within the configured delimiter.

public string ValueDelimiter { get; set; }

Property Value

string