Class Root

Namespace

OneImlx.Terminal.Commands.Parsers

Assembly

OneImlx.Terminal.dll

Represents a notional root command.

public sealed class Root

Inheritance

object

Root

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

A Root always has a LinkedCommand of type Root.

Constructors

Root(Command, Group?, SubCommand?)

Initializes a new instance.

public Root(Command linkedCommand, Group? childGroup = null, SubCommand? childSubCommand = null)

Parameters

linkedCommand Command

The command linked to the root.

childGroup Group

The child group.

childSubCommand SubCommand

The child sub-command.

Properties

ChildGroup

The immediate child group.

public Group? ChildGroup { get; set; }

Property Value

Group

ChildSubCommand

The child command.

public SubCommand? ChildSubCommand { get; set; }

Property Value

SubCommand

IsDefault

Indicates whether this root is a default root.

public bool IsDefault { get; }

Property Value

bool

LinkedCommand

The linked command of this root.

public Command LinkedCommand { get; }

Property Value

Command

Methods

Default(SubCommand?)

Returns the default root.

public static Root Default(SubCommand? subCommand = null)

Parameters

subCommand SubCommand

The child sub-command.

Returns

Root

ToString()

public override string ToString()

Returns

string