Option<T> 类

定义

命名空间:

System.CommandLine

程序集:

System.CommandLine.dll

一个符号，用于定义命名参数和该参数的值。

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)

类型参数

T

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

继承

Object

Symbol

IdentifierSymbol

Option

Option<T>

实现

IValueDescriptor IValueDescriptor<T>

构造函数

Option<T>(String, Func<T>, String)	一个符号，用于定义命名参数和该参数的值。
Option<T>(String, ParseArgument<T>, Boolean, String)	一个符号，用于定义命名参数和该参数的值。
Option<T>(String, String)	初始化 IdentifierSymbol 类的新实例。
Option<T>(String[], Func<T>, String)	一个符号，用于定义命名参数和该参数的值。
Option<T>(String[], ParseArgument<T>, Boolean, String)	一个符号，用于定义命名参数和该参数的值。
Option<T>(String[], String)	一个符号，用于定义命名参数和该参数的值。

属性

Aliases	获取可在命令行上用于指定符号的字符串集。 (继承自 IdentifierSymbol)
AllowMultipleArgumentsPerToken	获取一个值，该值指示是否允许每个选项标识符标记使用多个参数标记。 (继承自 Option)
ArgumentHelpName	获取或设置在帮助中显示时参数的名称。 (继承自 Option)
Arity	获取或设置 选项的 arity。
Description	获取或设置符号的说明。 (继承自 Symbol)
IsHidden	获取或设置一个值，该值指示符号是否隐藏。 (继承自 Symbol)
IsRequired	指示调用该选项的父命令时是否需要该选项。 (继承自 Option)
Name	获取或设置符号名称。 (继承自 Option)
Parents	获取父符号。 (继承自 Symbol)
ValueType	应 Type 将选项的参数分析为的 。 (继承自 Option)

方法

AddAlias(String)	添加别名。 (继承自 IdentifierSymbol)
AddValidator(ValidateSymbolResult<OptionResult>)	添加在选项与分析程序匹配时将调用的验证程序。 (继承自 Option)
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetCompletions()	获取符号的完成。 (继承自 Symbol)
GetCompletions(CompletionContext)	获取命令行完成的建议值。 (继承自 Option)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
HasAlias(String)	确定是否已定义别名。 (继承自 IdentifierSymbol)
HasAliasIgnoringPrefix(String)	指示选项上是否存在给定别名，而不考虑其前缀。 (继承自 Option)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
SetDefaultValue(Object)	设置选项的默认值。 (继承自 Option)
SetDefaultValueFactory(Func<Object>)	设置在需要选项的默认值时调用的委托。 (继承自 Option)
ToString()	返回表示当前对象的字符串。 (继承自 Symbol)

显式接口实现

IValueDescriptor.GetDefaultValue()	获取默认值（如果有）。 (继承自 Option)
IValueDescriptor.HasDefaultValue	获取一个值，该值指示是否存在默认值。 (继承自 Option)
IValueDescriptor.ValueName	获取值的名称。 (继承自 Option)

扩展方法

ExistingOnly<T>(Option<T>)	将选项配置为仅接受与现有文件或目录对应的值。
Parse(Option, String)	使用 选项分析命令行字符串值。
Parse(Option, String[])	使用 选项分析命令行字符串值。