Command 类

定义

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

public ref class Command : System::CommandLine::IdentifierSymbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>
public class Command : System.CommandLine.IdentifierSymbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>
type Command = class
    inherit IdentifierSymbol
    interface seq<Symbol>
    interface IEnumerable
Public Class Command
Inherits IdentifierSymbol
Implements IEnumerable(Of Symbol)
继承
派生
实现

注解

将 Command 对象用于与特定字符串对应的操作 (命令名称) 。 有关只有一个操作的简单应用程序,请参阅 RootCommand 。 例如, dotnet run 使用 run 作为命令。

构造函数

Command(String, String)

初始化 Command 类的新实例。

属性

Aliases

获取可在命令行上用于指定符号的字符串集。

(继承自 IdentifierSymbol)
Arguments

表示命令的所有参数。

Children

获取子符号。

Description

获取或设置符号的说明。

(继承自 Symbol)
Handler

获取或设置 ICommandHandler 命令的 。 处理程序表示调用命令时将执行的操作。

IsHidden

获取或设置一个值,该值指示符号是否隐藏。

(继承自 Symbol)
Name

获取或设置符号名称。

(继承自 IdentifierSymbol)
Options

表示命令的所有选项,包括已应用于任何命令上级的全局选项。

Parents

获取父符号。

(继承自 Symbol)
Subcommands

表示命令的所有子命令。

TreatUnmatchedTokensAsErrors

获取或设置一个值,该值指示是否应将不匹配的标记视为错误。 例如,如果将 设置为 true ,并且提供了额外的命令或参数,则验证将失败。

方法

Add(Argument)

Argument将 添加到命令。

Add(Command)

将子命令添加到命令。

Add(Option)

Option将 添加到命令。

AddAlias(String)

添加别名。

(继承自 IdentifierSymbol)
AddArgument(Argument)

Argument将 添加到命令。

AddCommand(Command)

将子命令添加到命令。

AddGlobalOption(Option)

将全局 Option 添加到 命令。

AddOption(Option)

Option将 添加到命令。

AddValidator(ValidateSymbolResult<CommandResult>)

将自定义验证程序添加到命令。 验证程序可用于创建自定义验证逻辑。

Equals(Object)

确定指定对象是否等于当前对象。

(继承自 Object)
GetCompletions()

获取符号的完成。

(继承自 Symbol)
GetCompletions(CompletionContext)

获取命令行完成的建议值。

GetEnumerator()

获取一个枚举器,该枚举器表示命令的所有符号。

GetHashCode()

作为默认哈希函数。

(继承自 Object)
GetType()

获取当前实例的 Type

(继承自 Object)
HasAlias(String)

确定是否已定义别名。

(继承自 IdentifierSymbol)
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
ToString()

返回表示当前对象的字符串。

(继承自 Symbol)

显式接口实现

IEnumerable.GetEnumerator()

返回循环访问集合的枚举数。

扩展方法

Invoke(Command, String, IConsole)

分析和调用命令。

Invoke(Command, String[], IConsole)

分析和调用命令。

InvokeAsync(Command, String, IConsole)

分析和调用命令。

InvokeAsync(Command, String[], IConsole)

分析和调用命令。

Parse(Command, String)

使用指定的命令分析命令行字符串值。

Parse(Command, String[])

使用指定的命令分析数组字符串。

SetHandler(Command, Action)

基于 Action设置命令的处理程序。

SetHandler(Command, Func<Task>)

基于 Func<TResult>设置命令的处理程序。

SetHandler<T>(Command, Action<T>, IValueDescriptor[])

基于 Action<T>设置命令的处理程序。

SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])

基于 Func<T,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>设置命令的处理程序。

SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])

基于 Action<T1,T2>设置命令的处理程序。

SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])

基于 Func<T1,T2,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])

基于 Action<T1,T2,T3>设置命令的处理程序。

SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4>设置命令的处理程序。

SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])

基于 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>设置命令的处理程序。

SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])

基于 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>设置命令的处理程序。

适用于