Command 类

定义

命名空间:

System.CommandLine

程序集:

System.CommandLine.dll

包:

System.CommandLine v3.0.0-preview.1.26104.118

Source:

Command.cs

表示应用程序执行的特定作。

public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable

public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable

type Command = class
    inherit Symbol
    interface IEnumerable

Public Class Command
Inherits Symbol
Implements IEnumerable

继承

Object

Symbol

Command

派生

System.CommandLine.RootCommand

实现

IEnumerable

注解

将 Command 对象用于对应于特定字符串（命令名称）的作。 有关只有一个作的简单应用程序，请参阅 RootCommand。 例如， dotnet run 用作 run 命令。

构造函数

名称	说明
Command(String, String)	初始化 Command 类的新实例。

属性

名称	说明
Action	获取或设置 CommandLineAction 命令。 处理程序表示在调用命令时将执行的作。
Aliases	获取可用于命令行指定命令的唯一字符串集。
Arguments	获取命令的所有参数。
Children	获取子符号。
Description	获取或设置符号的说明。 (继承自 Symbol)
Hidden	获取或设置一个值，该值指示是否隐藏符号。 (继承自 Symbol)
Name	获取符号的名称。 (继承自 Symbol)
Options	获取命令的所有选项。
Parents	获取父符号。 (继承自 Symbol)
Subcommands	获取命令的所有子命令。
TreatUnmatchedTokensAsErrors	获取或设置一个值，该值指示是否应将不匹配的令牌视为错误。
Validators	获取命令的验证程序。 验证程序可用于创建自定义验证逻辑。

方法

名称	说明
Add(Argument)	向命令添加 a Argument 。
Add(Command)	向命令添加 a Command 。
Add(Option)	向命令添加一个 Option 。
GetCompletions(CompletionContext)	获取符号的完成。
Parse(IReadOnlyList<String>, ParserConfiguration)	使用命令分析数组字符串。
Parse(String, ParserConfiguration)	使用命令分析命令行字符串值。
SetAction(Action<ParseResult>)	设置在调用命令时要运行的同步作。
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)	调用命令时设置异步作。
SetAction(Func<ParseResult,CancellationToken,Task>)	设置在调用命令时要运行的异步作。
SetAction(Func<ParseResult,Int32>)	设置在调用命令时要运行的同步作。
SetAction(Func<ParseResult,Task<Int32>>)	设置在调用命令时要运行的异步作。
SetAction(Func<ParseResult,Task>)	设置在调用命令时要运行的异步作。
ToString()	返回一个表示当前对象的字符串。 (继承自 Symbol)

显式接口实现

名称	说明
IEnumerable.GetEnumerator()	返回循环访问集合的枚举器。