Option<T> Class

Reference

Definition

Namespace:: System.CommandLine

Assembly:: System.CommandLine.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines a named parameter and a value for that parameter.

generic <typename T>
public ref class Option : System::CommandLine::Option, System::CommandLine::Binding::IValueDescriptor<T>

public class Option<T> : System.CommandLine.Option, System.CommandLine.Binding.IValueDescriptor<T>

type Option<'T> = class
    inherit Option
    interface IValueDescriptor<'T>
    interface IValueDescriptor

Public Class Option(Of T)
Inherits Option
Implements IValueDescriptor(Of T)

Type Parameters

T

The Type that the option's arguments are expected to be parsed as.

Inheritance: Object

Symbol

IdentifierSymbol

Option
Option<T>

Implements: IValueDescriptor IValueDescriptor<T>

Constructors

Option<T>(String, Func<T>, String)	Initializes a new instance of the Option<T> class.
Option<T>(String, ParseArgument<T>, Boolean, String)	Initializes a new instance of the Option<T> class.
Option<T>(String, String)	Initializes a new instance of the IdentifierSymbol class.
Option<T>(String[], Func<T>, String)	Initializes a new instance of the Option<T> class.
Option<T>(String[], ParseArgument<T>, Boolean, String)	Initializes a new instance of the Option<T> class.
Option<T>(String[], String)	Initializes a new instance of the Option<T> class.

Properties

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. (Inherited from Option)
ArgumentHelpName	Gets or sets the name of the argument when displayed in help. (Inherited from Option)
Arity	Gets or sets the arity of the option.
Description	Gets or sets the description of the symbol. (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. (Inherited from Option)
Name	Gets or sets the symbol name. (Inherited from Option)
Parents	Gets the parent symbols. (Inherited from Symbol)
ValueType	The Type that the option's arguments are expected to be parsed as. (Inherited from Option)

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. (Inherited from Option)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetCompletions()	Gets completions for the symbol. (Inherited from Symbol)
GetCompletions(CompletionContext)	Gets the suggested values for command line completion. (Inherited from Option)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
HasAlias(String)	Determines whether the alias has already been defined. (Inherited from IdentifierSymbol)
HasAliasIgnoringPrefix(String)	Indicates whether a given alias exists on the option, regardless of its prefix. (Inherited from Option)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SetDefaultValue(Object)	Sets the default value for the option. (Inherited from Option)
SetDefaultValueFactory(Func<Object>)	Sets a delegate to invoke when the default value for the option is required. (Inherited from Option)
ToString()	Returns a string that represents the current object. (Inherited from Symbol)

Explicit Interface Implementations

IValueDescriptor.GetDefaultValue()	Gets the default value, if any. (Inherited from Option)
IValueDescriptor.HasDefaultValue	Gets a value that indicates whether there is a default value. (Inherited from Option)
IValueDescriptor.ValueName	Gets the name of the value. (Inherited from Option)

Extension Methods

ExistingOnly<T>(Option<T>)	Configures an option to accept only values corresponding to a existing files or directories.
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

Jaa