Option 类

定义

定义命名参数的符号和该参数的值。

public ref class Option : System::CommandLine::IdentifierSymbol, System::CommandLine::Binding::IValueDescriptor
public class Option : System.CommandLine.IdentifierSymbol, System.CommandLine.Binding.IValueDescriptor
type Option = class
    inherit IdentifierSymbol
    interface IValueDescriptor
Public Class Option
Inherits IdentifierSymbol
Implements IValueDescriptor
继承
派生
实现

构造函数

Option(String, String, Type, Func<Object>, ArgumentArity)

初始化 Option 类的新实例。

Option(String[], String, Type, Func<Object>, ArgumentArity)

初始化 Option 类的新实例。

属性

Aliases

获取可在命令行上使用以指定符号的字符串集。

(继承自 IdentifierSymbol)
AllowMultipleArgumentsPerToken

获取一个值,该值指示是否允许每个选项标识符标记使用多个参数标记。

ArgumentHelpName

获取或设置在帮助中显示时参数的名称。

Arity

获取或设置 选项的 arity。

Description

获取或设置符号的说明。

(继承自 Symbol)
IsHidden

获取或设置一个值,该值指示符号是否隐藏。

(继承自 Symbol)
IsRequired

指示调用其父命令时选项是否是必需的。

Name

获取或设置符号名称。

Parents

获取父符号。

(继承自 Symbol)
ValueType

Type应将选项的参数分析为的 。

方法

AddAlias(String)

添加别名。

(继承自 IdentifierSymbol)
AddValidator(ValidateSymbolResult<OptionResult>)

添加在选项与分析程序匹配时将调用的验证程序。

Equals(Object)

确定指定对象是否等于当前对象。

(继承自 Object)
GetCompletions()

获取符号的完成。

(继承自 Symbol)
GetCompletions(CompletionContext)

获取命令行完成的建议值。

GetHashCode()

作为默认哈希函数。

(继承自 Object)
GetType()

获取当前实例的 Type

(继承自 Object)
HasAlias(String)

确定别名是否已定义。

(继承自 IdentifierSymbol)
HasAliasIgnoringPrefix(String)

指示选项上是否存在给定别名,而不考虑其前缀。

MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
SetDefaultValue(Object)

设置 选项的默认值。

SetDefaultValueFactory(Func<Object>)

设置在需要 选项的默认值时调用的委托。

ToString()

返回表示当前对象的字符串。

(继承自 Symbol)

显式接口实现

IValueDescriptor.GetDefaultValue()

获取默认值(如果有)。

IValueDescriptor.HasDefaultValue

获取一个值,该值指示是否存在默认值。

IValueDescriptor.ValueName

获取值的名称。

扩展方法

Parse(Option, String)

使用 选项分析命令行字符串值。

Parse(Option, String[])

使用 选项分析命令行字符串值。

适用于

另请参阅