RootCommand クラス

定義

名前空間:

System.CommandLine

アセンブリ:

System.CommandLine.dll

アプリケーションが実行するメイン アクションを表します。

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

IdentifierSymbol

Command

RootCommand

注釈

1 つのアクションを実行するアプリケーションにはサブコマンドを指定せずに RootCommand オブジェクトを使用します。 特定の文字列で識別されるアクションを必要とするアプリケーションのルートにサブコマンドを追加します。 たとえば、'dir' ではサブコマンドは使用されません。 複数のアクションを持つアプリケーションについては、「」を参照してください Command 。

コンストラクター

RootCommand(String)

アプリケーションが実行するメイン アクションを表します。

プロパティ

Aliases	コマンド ラインでシンボルを指定するために使用できる文字列のセットを取得します。 (継承元 IdentifierSymbol)
Arguments	コマンドのすべての引数を表します。 (継承元 Command)
Children	子シンボルを取得します。 (継承元 Command)
Description	シンボルの説明を取得または設定します。 (継承元 Symbol)
ExecutableName	現在実行中の実行可能ファイルの名前。
ExecutablePath	現在実行中の実行可能ファイルへのパス。
Handler	コマンドの を ICommandHandler 取得または設定します。 ハンドラーは、コマンドが呼び出されたときに実行されるアクションを表します。 (継承元 Command)
IsHidden	シンボルが非表示かどうかを示す値を取得または設定します。 (継承元 Symbol)
Name	シンボル名を取得または設定します。 (継承元 IdentifierSymbol)
Options	コマンドの先祖に適用されたグローバル オプションを含む、コマンドのすべてのオプションを表します。 (継承元 Command)
Parents	親シンボルを取得します。 (継承元 Symbol)
Subcommands	コマンドのすべてのサブコマンドを表します。 (継承元 Command)
TreatUnmatchedTokensAsErrors	一致しないトークンをエラーとして扱う必要があるかどうかを示す値を取得または設定します。 たとえば、 を に true 設定し、追加のコマンドまたは引数を指定すると、検証は失敗します。 (継承元 Command)

メソッド

Add(Argument)	コマンドに を Argument 追加します。 (継承元 Command)
Add(Command)	サブコマンドを コマンドに追加します。 (継承元 Command)
Add(Option)	コマンドに を Option 追加します。 (継承元 Command)
AddAlias(String)	エイリアスを追加します。 (継承元 IdentifierSymbol)
AddArgument(Argument)	コマンドに を Argument 追加します。 (継承元 Command)
AddCommand(Command)	サブコマンドを コマンドに追加します。 (継承元 Command)
AddGlobalOption(Option)	コマンドにグローバル Option を追加します。 (継承元 Command)
AddOption(Option)	コマンドに を Option 追加します。 (継承元 Command)
AddValidator(ValidateSymbolResult<CommandResult>)	コマンドにカスタム検証コントロールを追加します。 検証コントロールを使用して、カスタム検証ロジックを作成できます。 (継承元 Command)
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetCompletions()	シンボルの入力候補を取得します。 (継承元 Symbol)
GetCompletions(CompletionContext)	コマンド ライン入力候補の推奨値を取得します。 (継承元 Command)
GetEnumerator()	コマンドのすべてのシンボルを表す列挙子を取得します。 (継承元 Command)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
HasAlias(String)	エイリアスが既に定義されているかどうかを判断します。 (継承元 IdentifierSymbol)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Symbol)

明示的なインターフェイスの実装

IEnumerable.GetEnumerator()

コレクションを反復処理する列挙子を返します。 (継承元 Command)

拡張メソッド

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