1. Home
  2. API
  3. XenoAtom.CommandLine
  4. Option

Option Class

Definition

Assembly XenoAtom.CommandLine.dll
Inherits Object → CommandNode
View source
Show inherited members (9)

Defines an option.

public abstract class Option : CommandNode, ICommandNodeDescriptor
Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (3)

Option(String, String?, Int32, Boolean)Creates a new instance of this class.
Option(String, String?, Int32)Creates a new instance of this class.
Option(String, String?)Creates a new instance of this class.

Properties (8)

DescriptionGets the description of this option.
EnvironmentVariableGets or sets the environment variable used as a fallback when this option is not provided explicitly on the command line.
EnvironmentVariableDelimiterGets or sets the delimiter used to split an environment variable value into multiple occurrences of this option.
HiddenGets a boolean indicating if this option is hidden.
MaxValueCountGets the maximum number of accepted values.
OptionValueTypeGets the type of this option (Required, Optional, None).
PrototypeGets the prototype of this option. E.g "v|version".
ValueCompleterGets or sets a completion provider for values of this option.

Methods (6)

GetNames()Gets the names of this option deduced from the prototype. E.g "v", "version".
GetValueSeparators()Gets the separators for this option. E.g ":", "=".
Invoke(OptionContext)Invoke this option after the parsing is complete.
OnParseComplete(OptionContext)Called when the parsing is complete.
Parse<T>(String?, OptionContext)Parses a value for this option.
ToString()