Option<T> クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
名前付きパラメーターとそのパラメーターの値を定義するシンボル。
generic <typename T>
public ref class Option : System::CommandLine::Option
public class Option<T> : System.CommandLine.Option
type Option<'T> = class
inherit Option
Public Class Option(Of T)
Inherits Option
型パラメーター
- T
オプションの引数が解析されると想定される Type 。
- 継承
コンストラクター
| 名前 | 説明 |
|---|---|
| Option<T>(String, String[]) |
Option クラスの新しいインスタンスを初期化します。 |
プロパティ
| 名前 | 説明 |
|---|---|
| Action |
Option の CommandLineAction を取得または設定します。 ハンドラーは、Option が呼び出されたときに実行されるアクションを表します。 (継承元 Option) |
| Aliases |
コマンド ラインで Option を指定するために使用できる文字列の一意のセットを取得します。 (継承元 Option) |
| AllowMultipleArgumentsPerToken |
各オプション識別子トークンに対して複数の引数トークンが許可されるかどうかを示す値を取得します。 (継承元 Option) |
| Arity |
オプションのアリティを取得または設定します。 (継承元 Option) |
| CompletionSources |
オプションの入力候補ソースの一覧を取得します。 (継承元 Option) |
| CustomParser |
カスタム引数パーサーを取得または設定します。 |
| DefaultValueFactory |
既定値を作成するために呼び出すデリゲートを取得または設定します。 |
| Description |
シンボルの説明を取得または設定します。 (継承元 Symbol) |
| HasDefaultValue |
オプションに既定値を定義するかどうかを指定します。 (継承元 Option) |
| HelpName |
オプションの値の使用法ヘルプに表示されるプレースホルダー名を取得または設定します。
値は山かっこで囲まれます ( |
| Hidden |
シンボルが非表示かどうかを示す値を取得または設定します。 (継承元 Symbol) |
| Name |
シンボルの名前を取得します。 (継承元 Symbol) |
| Parents |
親シンボルを取得します。 (継承元 Symbol) |
| Recursive |
true に設定すると、このオプションは直接の親コマンドに適用され、サブコマンドに再帰的に適用されます。 (継承元 Option) |
| Required |
オプションが親コマンドの呼び出し時に必要かどうかを示します。 (継承元 Option) |
| Validators |
オプションがパーサーによって一致したときに呼び出される検証コントロール。 (継承元 Option) |
| ValueType |
オプションの解析されたトークンが変換される Type を取得します。 |
メソッド
| 名前 | 説明 |
|---|---|
| AcceptLegalFileNamesOnly() |
有効なファイル名を表す値のみを受け入れるようにオプションを構成します。 |
| AcceptLegalFilePathsOnly() |
有効なファイル パスを表す値のみを受け入れるようにオプションを構成します。 |
| AcceptOnlyFromAmong(String[]) |
指定した値のみを受け入れ、コマンド ライン補完として提案するオプションを構成します。 |
| GetCompletions(CompletionContext) |
シンボルの入力候補を取得します。 (継承元 Option) |
| GetDefaultValue() |
オプションの既定値を取得します。 (継承元 Option) |
| ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Symbol) |
拡張メソッド
| 名前 | 説明 |
|---|---|
| AcceptExistingOnly<T>(Option<T>) |
既存のファイルまたはディレクトリに対応する値のみを受け入れるようにオプションを構成します。 |