Language

Option クラス

定義

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

public ref class Option abstract : System::CommandLine::Symbol
public ref class Option : System::CommandLine::Symbol, System::CommandLine::IOption
public abstract class Option : System.CommandLine.Symbol
public class Option : System.CommandLine.Symbol, System.CommandLine.IOption
type Option = class
    inherit Symbol
type Option = class
    inherit Symbol
    interface IOption
    interface ISymbol
    interface ISuggestionSource
    interface IValueDescriptor
Public MustInherit Class Option
Inherits Symbol
Public Class Option
Inherits Symbol
Implements IOption
継承
Option
派生
実装

コンストラクター

Name 説明
Option(String, String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

Option(String, String[])

Option クラスの新しいインスタンスを初期化します。

Option(String[], String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

プロパティ

Name 説明
Action

Option の CommandLineAction を取得または設定します。 ハンドラーは、Option が呼び出されたときに実行されるアクションを表します。

Aliases

コマンド ラインで Option を指定するために使用できる文字列の一意のセットを取得します。

Aliases

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
AllowMultipleArgumentsPerToken

各オプション識別子トークンに対して複数の引数トークンが許可されるかどうかを示す値を取得します。

Argument

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

Arity

オプションのアリティを取得または設定します。

Children

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
CompletionSources

オプションの入力候補ソースの一覧を取得します。

Description

シンボルの説明を取得または設定します。

(継承元 Symbol)
HasDefaultValue

オプションに既定値を定義するかどうかを指定します。

HelpName

オプションの値の使用法ヘルプに表示されるプレースホルダー名を取得または設定します。 値は山かっこで囲まれます (< と >)。

Hidden

シンボルが非表示かどうかを示す値を取得または設定します。

(継承元 Symbol)
IsHidden

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
Name

シンボルの名前を取得します。

(継承元 Symbol)
Parents

親シンボルを取得します。

(継承元 Symbol)
RawAliases

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
Recursive

true に設定すると、このオプションは直接の親コマンドに適用され、サブコマンドに再帰的に適用されます。

Required

オプションが親コマンドの呼び出し時に必要かどうかを示します。

Validators

オプションがパーサーによって一致したときに呼び出される検証コントロール。

ValueType

オプションの解析されたトークンが変換される Type を取得します。

メソッド

Name 説明
AddAlias(String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

AddAliasInner(String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
AddValidator(ValidateSymbol<OptionResult>)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

ClearAliases()

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
GetCompletions(CompletionContext)

シンボルの入力候補を取得します。

GetDefaultValue()

オプションの既定値を取得します。

HasAlias(String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
HasRawAlias(String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
Suggest(String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Symbol)

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

Name 説明
IOption.Argument

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

ISymbol.Children

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

(継承元 Symbol)
IValueDescriptor.GetDefaultValue()

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

IValueDescriptor.HasDefaultValue

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

IValueDescriptor.Type

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

IValueDescriptor.ValueName

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

拡張メソッド

Name 説明
BuildAlias(IValueDescriptor)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

Parse(Option, String)

名前付きパラメーターとそのパラメーターの値を定義するシンボル。

適用対象