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 オブジェクトを使用します。 アクションが 1 つだけの単純なアプリケーションについては、「」を参照してください RootCommand 。 たとえば、 dotnet run は コマンドとして を使用 run します。

コンストラクター

Command(String, String)

コマンド クラスの新しいインスタンスを初期化します。

プロパティ

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>設定します。

適用対象