RootCommand 类

定义

命名空间:

System.CommandLine

程序集:

System.CommandLine.dll

包:

System.CommandLine v3.0.0-preview.1.26104.118

Source:

RootCommand.cs

表示应用程序执行的主要作。

public ref class RootCommand : System::CommandLine::Command

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

继承

Object

Symbol

Command

RootCommand

注解

对于执行一个作的应用程序，请使用没有任何子命令的 RootCommand 对象。 将子命令添加到需要特定字符串标识的作的应用程序的根目录。 例如，“dir”不使用任何子命令。 请参阅 Command 具有多个作的应用程序。

构造函数

名称	说明
RootCommand(String)	表示应用程序执行的主要作。

属性

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

方法

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

显式接口实现

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