HelpOption クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
コマンド ライン ヘルプを表示する必要があることを示す標準オプション。
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- 継承
コンストラクター
| 名前 | 説明 |
|---|---|
| HelpOption() |
Commandに追加すると、コマンド ラインで次のいずれかのオプションが指定されたときにヘルプを表示するようにアプリケーションが構成されます。 |
| HelpOption(String, String[]) |
Commandに追加すると、コマンド ラインで名前またはエイリアスの 1 つが指定されたときにヘルプを表示するようにアプリケーションが構成されます。 |
プロパティ
| 名前 | 説明 |
|---|---|
| Action |
Option の CommandLineAction を取得または設定します。 ハンドラーは、Option が呼び出されたときに実行されるアクションを表します。 |
| Aliases |
コマンド ラインで Option を指定するために使用できる文字列の一意のセットを取得します。 (継承元 Option) |
| AllowMultipleArgumentsPerToken |
各オプション識別子トークンに対して複数の引数トークンが許可されるかどうかを示す値を取得します。 (継承元 Option) |
| Arity |
オプションのアリティを取得または設定します。 (継承元 Option) |
| CompletionSources |
オプションの入力候補ソースの一覧を取得します。 (継承元 Option) |
| Description |
シンボルの説明を取得または設定します。 (継承元 Symbol) |
| HasDefaultValue |
オプションに既定値を定義するかどうかを指定します。 (継承元 Option) |
| HelpName |
オプションの値の使用法ヘルプに表示されるプレースホルダー名を取得または設定します。
値は山かっこで囲まれます ( |
| Hidden |
シンボルが非表示かどうかを示す値を取得または設定します。 (継承元 Symbol) |
| Name |
シンボルの名前を取得します。 (継承元 Symbol) |
| Parents |
親シンボルを取得します。 (継承元 Symbol) |
| Recursive |
true に設定すると、このオプションは直接の親コマンドに適用され、サブコマンドに再帰的に適用されます。 (継承元 Option) |
| Required |
オプションが親コマンドの呼び出し時に必要かどうかを示します。 (継承元 Option) |
| Validators |
オプションがパーサーによって一致したときに呼び出される検証コントロール。 (継承元 Option) |
| ValueType |
コマンド ライン ヘルプを表示する必要があることを示す標準オプション。 |
メソッド
| 名前 | 説明 |
|---|---|
| GetCompletions(CompletionContext) |
シンボルの入力候補を取得します。 (継承元 Option) |
| GetDefaultValue() |
オプションの既定値を取得します。 (継承元 Option) |
| ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Symbol) |
