Option Class

Definition

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v2.0.0

Source:

Option.cs

A symbol defining a named parameter and a value for that parameter.

public ref class Option abstract : System::CommandLine::Symbol

public abstract class Option : System.CommandLine.Symbol

type Option = class
    inherit Symbol

Public MustInherit Class Option
Inherits Symbol

Inheritance

Object

Symbol

Option

Derived

System.CommandLine.Help.HelpOption

System.CommandLine.Option<T>

System.CommandLine.VersionOption

Constructors

Name	Description
Option(String, String[])	Initializes a new instance of the Option class.

Properties

Name	Description
Action	Gets or sets the CommandLineAction for the Option. The handler represents the action that will be performed when the Option is invoked.
Aliases	Gets the unique set of strings that can be used on the command line to specify the Option.
AllowMultipleArgumentsPerToken	Gets a value that indicates whether multiple argument tokens are allowed for each option identifier token.
Arity	Gets or sets the arity of the option.
CompletionSources	Gets the list of completion sources for the option.
Description	Gets or sets the description of the symbol. (Inherited from Symbol)
HasDefaultValue	Specifies if a default value is defined for the option.
HelpName	Gets or sets the name of the Option when displayed in help.
Hidden	Gets or sets a value indicating whether the symbol is hidden. (Inherited from Symbol)
Name	Gets the name of the symbol. (Inherited from Symbol)
Parents	Gets the parent symbols. (Inherited from Symbol)
Recursive	When set to true, this option will be applied to its immediate parent command or commands and recursively to their subcommands.
Required	Indicates whether the option is required when its parent command is invoked.
Validators	Validators that will be called when the option is matched by the parser.
ValueType	Gets the Type that the option's parsed tokens will be converted to.

Methods

Name	Description
GetCompletions(CompletionContext)	Gets completions for the symbol.
GetDefaultValue()	Gets the default value for the option.
ToString()	Returns a string that represents the current object. (Inherited from Symbol)