Class HelpOptions

Namespace

OneImlx.Terminal.Configuration.Options

Assembly

OneImlx.Terminal.dll

The help options.

public sealed class HelpOptions

Inheritance

object

HelpOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Enabled

Enables the help.

public bool Enabled { get; set; }

Property Value

bool

OptionAlias

The help option alias.

public string OptionAlias { get; set; }

Property Value

string

Remarks

Unless disabled, the help option alias is automatically added to the command options. The OptionAlias must be unique across all option aliases for all commands.

OptionDescription

The help description.

public string OptionDescription { get; set; }

Property Value

string

OptionId

The help option identifier.

public string OptionId { get; set; }

Property Value

string

Remarks

Unless disabled, the help option identifier is automatically added to the command options. The OptionId must be unique across all option identifiers for all commands.