Command クラス

定義

名前空間:: System.CommandLine

アセンブリ:: System.CommandLine.dll

パッケージ:: System.CommandLine v3.0.0-rc.1.26425.128

パッケージ:: System.CommandLine.Experimental v0.3.0-alpha.19577.1

ソース:: Command.cs

ソース:: Command.cs

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

コンストラクター

Name	説明
Command(String, String)	Command クラスの新しいインスタンスを初期化します。

プロパティ

Name	説明
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	コマンドに対する検証コントロールを取得します。検証コントロールを使用して、カスタム検証ロジックを作成できます。

メソッド

Name	説明
Add(Argument)	コマンドに Argument を追加します。
Add(Command)	コマンドに 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)

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

Name	説明
ICommand.Argument	アプリケーションが実行する特定のアクションを表します。
ICommand.Arguments	アプリケーションが実行する特定のアクションを表します。
ICommand.Options	アプリケーションが実行する特定のアクションを表します。
IEnumerable.GetEnumerator()	コレクションを反復処理する列挙子を返します。
ISymbol.Children	アプリケーションが実行する特定のアクションを表します。 (継承元 Symbol)

拡張メソッド

Name	説明
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)	アプリケーションが実行する特定のアクションを表します。

適用対象

フィードバック

このページはお役に立ちましたか?