Edit

Share via

Option Class

Definition

Namespace:
System.CommandLine
Assembly:
System.CommandLine.dll
Package:
System.CommandLine v2.0.0-rc.2.25502.107
Source:
Option.cs
Source:
Option.cs

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

public ref class Option abstract : System::CommandLine::Symbol
public ref class Option abstract : System::CommandLine::IdentifierSymbol, System::CommandLine::Binding::IValueDescriptor
public abstract class Option : System.CommandLine.Symbol
public abstract class Option : System.CommandLine.IdentifierSymbol, System.CommandLine.Binding.IValueDescriptor
type Option = class
    inherit Symbol
type Option = class
    inherit IdentifierSymbol
    interface IValueDescriptor
Public MustInherit Class Option
Inherits Symbol
Public MustInherit Class Option
Inherits IdentifierSymbol
Implements IValueDescriptor
Inheritance
Object
Symbol
Option
Inheritance
Object
Symbol
IdentifierSymbol
Option
Derived
Implements
IValueDescriptor

Constructors

Option(String, String[])

Initializes a new instance of the Option class.

Properties

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.
Aliases

Gets the set of strings that can be used on the command line to specify the symbol.

(Inherited from IdentifierSymbol)
AllowMultipleArgumentsPerToken

Gets a value that indicates whether multiple argument tokens are allowed for each option identifier token.
ArgumentHelpName

Gets or sets the name of the argument when displayed in help.
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)
IsHidden

Gets or sets a value indicating whether the symbol is hidden.

(Inherited from Symbol)
IsRequired

Indicates whether the option is required when its parent command is invoked.
Name

Gets or sets the symbol name.
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

AddAlias(String)

Adds an alias.

(Inherited from IdentifierSymbol)
AddValidator(ValidateSymbolResult<OptionResult>)

Adds a validator that will be called when the option is matched by the parser.
GetCompletions()

Gets completions for the symbol.

(Inherited from Symbol)
GetCompletions(CompletionContext)

Gets completions for the symbol.
GetDefaultValue()

Gets the default value for the option.
HasAlias(String)

Determines whether the specified alias has already been defined.

(Inherited from IdentifierSymbol)
HasAliasIgnoringPrefix(String)

Indicates whether a given alias exists on the option, regardless of its prefix.
SetDefaultValue(Object)

Sets the default value for the option.
SetDefaultValueFactory(Func<Object>)

Sets a delegate to invoke when the default value for the option is required.
ToString()

Returns a string that represents the current object.

(Inherited from Symbol)

Explicit Interface Implementations

IValueDescriptor.GetDefaultValue()

Gets the default value, if any.
IValueDescriptor.HasDefaultValue

Gets a value that indicates whether there is a default value.
IValueDescriptor.ValueName

Gets the name of the value.

Extension Methods

Parse(Option, String)

Parses a command line string value using an option.
Parse(Option, String[])

Parses a command line string value using an option.

Applies to

See also