Command 类

定义

命名空间:: System.CommandLine

程序集:: System.CommandLine.dll

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

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

Source:: Command.cs

Source:: Command.cs

Source:: Command.cs

重要

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

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

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

public ref class Command : System::CommandLine::Symbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>, System::CommandLine::ICommand

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

public class Command : System.CommandLine.Symbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>, System.CommandLine.ICommand

type Command = class
    inherit Symbol
    interface IEnumerable

type Command = class
    inherit Symbol
    interface ICommand
    interface ISymbol
    interface ISuggestionSource
    interface seq<Symbol>
    interface IEnumerable

Public Class Command
Inherits Symbol
Implements IEnumerable

Public Class Command
Inherits Symbol
Implements ICommand, IEnumerable(Of Symbol)

继承: Object

Symbol
Command

派生: System.CommandLine.RootCommand

实现: IEnumerable IEnumerable<Symbol> ICommand ISuggestionSource ISymbol

注解

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

构造函数

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

属性

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

方法

名称	说明
Add(Argument)	向命令添加 a Argument 。
Add(Command)	向命令添加 a Command 。
Add(Option)	向命令添加一个 Option 。
Add(Symbol)	表示应用程序执行的特定操作。
AddAlias(String)	表示应用程序执行的特定操作。
AddAliasInner(String)	表示应用程序执行的特定操作。 (继承自 Symbol)
AddArgument(Argument)	表示应用程序执行的特定操作。
AddCommand(Command)	表示应用程序执行的特定操作。
AddOption(Option)	表示应用程序执行的特定操作。
AddValidator(ValidateSymbol<CommandResult>)	表示应用程序执行的特定操作。
ClearAliases()	表示应用程序执行的特定操作。 (继承自 Symbol)
GetCompletions(CompletionContext)	获取符号的完成。
GetEnumerator()	表示应用程序执行的特定操作。
HasAlias(String)	表示应用程序执行的特定操作。 (继承自 Symbol)
HasRawAlias(String)	表示应用程序执行的特定操作。 (继承自 Symbol)
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>)	设置在调用命令时要运行的异步作。
Suggest(String)	表示应用程序执行的特定操作。 (继承自 Symbol)
ToString()	返回一个表示当前对象的字符串。 (继承自 Symbol)

显式接口实现

名称	说明
ICommand.Argument	表示应用程序执行的特定操作。
ICommand.Arguments	表示应用程序执行的特定操作。
ICommand.Options	表示应用程序执行的特定操作。
IEnumerable.GetEnumerator()	返回循环访问集合的枚举器。
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)	表示应用程序执行的特定操作。

适用于

反馈

此页面是否有帮助？