RootCommand 类

定义

命名空间:: System.CommandLine

程序集:: System.CommandLine.dll

程序包:: System.CommandLine v3.0.0-rc.1.26425.128

程序包:: System.CommandLine.Experimental v0.3.0-alpha.19577.1

Source:: RootCommand.cs

Source:: RootCommand.cs

Source:: RootCommand.cs

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

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

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)
Argument	已过时. 表示应用程序执行的主要作。 (继承自 Command)
Arguments	获取命令的所有参数。 (继承自 Command)
Children	获取子符号。 (继承自 Command)
Description	获取或设置符号的说明。 (继承自 Symbol)
Directives	表示根命令下有效的所有指令。
ExecutableName	当前正在运行的可执行文件的名称。
ExecutablePath	当前正在运行的可执行文件的路径。
ExeName	表示应用程序执行的主要作。
ExePath	表示应用程序执行的主要作。
Handler	表示应用程序执行的主要作。 (继承自 Command)
HelpName	获取或设置帮助输出中根命令的名称。
Hidden	获取或设置一个值，该值指示是否隐藏符号。 (继承自 Symbol)
IsHidden	表示应用程序执行的主要作。 (继承自 Symbol)
Name	表示应用程序执行的主要作。
Name	获取符号的名称。 (继承自 Symbol)
Options	获取命令的所有选项。 (继承自 Command)
Parents	获取父符号。 (继承自 Symbol)
RawAliases	表示应用程序执行的主要作。 (继承自 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)
Add(Symbol)	表示应用程序执行的主要作。 (继承自 Command)
AddAlias(String)	表示应用程序执行的主要作。 (继承自 Command)
AddAliasInner(String)	表示应用程序执行的主要作。 (继承自 Symbol)
AddArgument(Argument)	表示应用程序执行的主要作。 (继承自 Command)
AddCommand(Command)	表示应用程序执行的主要作。 (继承自 Command)
AddOption(Option)	表示应用程序执行的主要作。 (继承自 Command)
AddValidator(ValidateSymbol<CommandResult>)	表示应用程序执行的主要作。 (继承自 Command)
ClearAliases()	表示应用程序执行的主要作。 (继承自 Symbol)
GetCompletions(CompletionContext)	获取符号的完成。 (继承自 Command)
GetEnumerator()	表示应用程序执行的主要作。 (继承自 Command)
HasAlias(String)	表示应用程序执行的主要作。 (继承自 Symbol)
HasRawAlias(String)	表示应用程序执行的主要作。 (继承自 Symbol)
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)
Suggest(String)	表示应用程序执行的主要作。 (继承自 Symbol)
ToString()	返回一个表示当前对象的字符串。 (继承自 Symbol)

显式接口实现

名称	说明
ICommand.Argument	表示应用程序执行的主要作。 (继承自 Command)
ICommand.Arguments	表示应用程序执行的主要作。 (继承自 Command)
ICommand.Options	表示应用程序执行的主要作。 (继承自 Command)
IEnumerable.GetEnumerator()	返回循环访问集合的枚举器。 (继承自 Command)
ISymbol.Children	表示应用程序执行的主要作。 (继承自 Symbol)

扩展方法

名称	说明
ConfigureFromMethod(Command, MethodInfo, Object)	表示应用程序执行的主要作。
Invoke(Command, String, IConsole)	表示应用程序执行的主要作。
Invoke(Command, String[], IConsole)	表示应用程序执行的主要作。
InvokeAsync(Command, String, IConsole)	表示应用程序执行的主要作。
InvokeAsync(Command, String[], IConsole)	表示应用程序执行的主要作。
Parse(Command, String, IReadOnlyCollection<Char>)	表示应用程序执行的主要作。
Parse(Command, String[])	表示应用程序执行的主要作。
ToAsyncEnumerable<TSource>(IEnumerable<TSource>)	将 IEnumerable<T> 转换为 IAsyncEnumerable<T>。
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)	根据指定的键选择器和元素选择器函数从 FrozenDictionary<TKey,TValue> 创建 IEnumerable<T>。
ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	根据指定的键选择器函数创建一个FrozenDictionary<TKey,TValue>IEnumerable<T>。
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)	使用指定的值创建一个 FrozenSet<T> 。
ToImmutableArray<TSource>(IEnumerable<TSource>)	从指定的集合创建不可变数组。
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)	枚举和转换序列，并使用指定的键和值比较器生成其内容的不可变字典。
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)	枚举和转换序列，并使用指定的键比较器生成其内容的不可变字典。
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	枚举和转换序列，并生成其内容的不可变字典。
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	基于序列的某些转换构造不可变字典。
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	从现有元素集合构造不可变字典，将转换函数应用于源键。
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)	枚举序列，生成其内容的不可变哈希集，并为集类型使用指定的相等比较器。
ToImmutableHashSet<TSource>(IEnumerable<TSource>)	枚举序列并生成其内容的不可变哈希集。
ToImmutableList<TSource>(IEnumerable<TSource>)	枚举序列并生成其内容的不可变列表。
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)	枚举和转换序列，并使用指定的键和值比较器生成其内容的不可变排序字典。
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)	枚举和转换序列，并使用指定的键比较器生成其内容的不可变排序字典。
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	枚举和转换序列，并生成其内容的不可变排序字典。
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)	枚举序列，生成其内容的不可变排序集，并使用指定的比较器。
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)	枚举序列并生成其内容的不可变排序集。
UseCommandHandler<THandler>(Command)	表示应用程序执行的主要作。

适用于

反馈

此页面是否有帮助？