RootCommand クラス

定義

名前空間:

System.CommandLine

アセンブリ:

System.CommandLine.dll

パッケージ:

System.CommandLine v3.0.0-rc.1.26425.128

ソース:

RootCommand.cs

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

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

注釈

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

コンストラクター

Name	説明
RootCommand(String)	アプリケーションが実行するメイン アクションを表します。

プロパティ

Name	説明
Action	コマンドの CommandLineAction を取得または設定します。 ハンドラーは、コマンドが呼び出されたときに実行されるアクションを表します。 (継承元 Command)
Aliases	コマンド ラインでコマンドを指定するために使用できる文字列の一意のセットを取得します。 (継承元 Command)
Arguments	コマンドのすべての引数を取得します。 (継承元 Command)
Children	子シンボルを取得します。 (継承元 Command)
Description	シンボルの説明を取得または設定します。 (継承元 Symbol)
Directives	ルート コマンドで有効なすべてのディレクティブを表します。
ExecutableName	現在実行中の実行可能ファイルの名前。
ExecutablePath	現在実行中の実行可能ファイルへのパス。
HelpName	ヘルプ出力のルート コマンドに使用される名前を取得または設定します。
Hidden	シンボルが非表示かどうかを示す値を取得または設定します。 (継承元 Symbol)
Name	シンボルの名前を取得します。 (継承元 Symbol)
Options	コマンドのすべてのオプションを取得します。 (継承元 Command)
Parents	親シンボルを取得します。 (継承元 Symbol)
Subcommands	コマンドのすべてのサブコマンドを取得します。 (継承元 Command)
TreatUnmatchedTokensAsErrors	一致しないトークンをエラーとして扱う必要があるかどうかを示す値を取得または設定します。 (継承元 Command)
Validators	コマンドに対する検証コントロールを取得します。 検証コントロールを使用して、カスタム検証ロジックを作成できます。 (継承元 Command)

メソッド

Name	説明
Add(Argument)	コマンドに Argument を追加します。 (継承元 Command)
Add(Command)	コマンドに Command を追加します。 (継承元 Command)
Add(Directive)	コマンドに Directive を追加します。
Add(Option)	コマンドに Option を追加します。 (継承元 Command)
GetCompletions(CompletionContext)	シンボルの入力候補を取得します。 (継承元 Command)
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)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Symbol)

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

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

拡張メソッド

Name	説明
UseCommandHandler<THandler>(Command)	アプリケーションが実行するメイン アクションを表します。