OptionResult Class

Definition

Namespace:

System.CommandLine.Parsing

Assembly:

System.CommandLine.dll

A result produced when parsing an Option.

public ref class OptionResult : System::CommandLine::Parsing::SymbolResult

public class OptionResult : System.CommandLine.Parsing.SymbolResult

type OptionResult = class
    inherit SymbolResult

Public Class OptionResult
Inherits SymbolResult

Inheritance

Object

SymbolResult

OptionResult

Properties

Children	Child symbol results in the parse tree. (Inherited from SymbolResult)
ErrorMessage	An error message for this symbol result. (Inherited from SymbolResult)
IsImplicit	Indicates whether the result was created implicitly and not due to the option being specified on the command line.
LocalizationResources	Localization resources used to produce messages for this symbol result. (Inherited from SymbolResult)
Option	The option to which the result applies.
Parent	The parent symbol result in the parse tree. (Inherited from SymbolResult)
Symbol	The symbol to which the result applies. (Inherited from SymbolResult)
Token	The token that was parsed to specify the option.
Tokens	The list of tokens associated with this symbol result during parsing. (Inherited from SymbolResult)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindResultFor(Argument)	Finds a result for the specific argument anywhere in the parse tree, including parent and child symbol results. (Inherited from SymbolResult)
FindResultFor(Command)	Finds a result for the specific command anywhere in the parse tree, including parent and child symbol results. (Inherited from SymbolResult)
FindResultFor(Option)	Finds a result for the specific option anywhere in the parse tree, including parent and child symbol results. (Inherited from SymbolResult)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValueForArgument(Argument)	Gets the parsed or default value for the specified argument. (Inherited from SymbolResult)
GetValueForArgument<T>(Argument<T>)	Gets the parsed or default value for the specified argument. (Inherited from SymbolResult)
GetValueForOption(Option)	Gets the parsed or default value for the specified option. (Inherited from SymbolResult)
GetValueForOption<T>(Option<T>)	Gets the parsed or default value for the specified option. (Inherited from SymbolResult)
GetValueOrDefault()	Gets the parsed value or the default value for Option.
GetValueOrDefault<T>()	Gets the parsed value or the default value for Option.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from SymbolResult)