Argument 类

定义

命名空间:

System.CommandLine

程序集:

System.CommandLine.dll

一个符号，用于定义可在命令行上传递给 命令 或 选项的值。

public ref class Argument : System::CommandLine::Symbol, System::CommandLine::Binding::IValueDescriptor

public class Argument : System.CommandLine.Symbol, System.CommandLine.Binding.IValueDescriptor

type Argument = class
    inherit Symbol
    interface IValueDescriptor

Public Class Argument
Inherits Symbol
Implements IValueDescriptor

继承

Object

Symbol

Argument

派生

System.CommandLine.Argument<T>

实现

IValueDescriptor

构造函数

Argument()	初始化 Argument 类的新实例。
Argument(String, String)	初始化 Argument 类的新实例。

属性

Arity	获取或设置 参数的 arity。
Completions	获取参数的完成源的列表。
Description	获取或设置符号的说明。 (继承自 Symbol)
HasDefaultValue	指定是否为 参数定义默认值。
HelpName	帮助输出中用于描述参数的名称。
IsHidden	获取或设置一个值，该值指示符号是否隐藏。 (继承自 Symbol)
Name	获取或设置符号的名称。 (继承自 Symbol)
Parents	获取父符号。 (继承自 Symbol)
ValueType	获取或设置 Type 参数标记 () 将转换为的 。

方法

AddValidator(ValidateSymbolResult<ArgumentResult>)	将自定义 ValidateSymbolResult<T> 添加到 参数。 验证程序可用于根据用户输入提供自定义错误。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetCompletions()	获取符号的完成。 (继承自 Symbol)
GetCompletions(CompletionContext)	获取命令行完成的建议值。
GetDefaultValue()	获取 参数的默认值。
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
SetDefaultValue(Object)	设置 参数的默认值。
SetDefaultValueFactory(Func<ArgumentResult,Object>)	设置当需要参数的默认值时要调用的委托。
SetDefaultValueFactory(Func<Object>)	设置当需要参数的默认值时要调用的委托。
ToString()	返回表示当前对象的字符串。

显式接口实现

IValueDescriptor.ValueName

获取值的名称。

扩展方法

Parse(Argument, String)	使用参数分析命令行字符串值。
Parse(Argument, String[])	使用参数分析命令行字符串值。