語言

Option 類別

定義

命名空間:
System.CommandLine
組件:
System.CommandLine.dll
套件:
System.CommandLine v3.0.0-rc.1.26425.128
套件:
System.CommandLine.Experimental v0.3.0-alpha.19577.1
來源:
Option.cs
來源:
Option.cs
來源:
Option.cs

一個定義命名參數及其參數值的符號。

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
繼承
Object
Symbol
Option
衍生
實作
IValueDescriptor IOption ISuggestionSource ISymbol

建構函式

名稱 Description
Option(String, String)

一個定義命名參數及其參數值的符號。
Option(String, String[])

初始化 Option 類別的新執行個體。
Option(String[], String)

一個定義命名參數及其參數值的符號。

屬性

名稱 Description
Action

取得或設定 CommandLineAction 選項。 處理器代表當 Option 被呼叫時將執行的動作。
Aliases

取得可用於命令列指定選項的獨特字串集合。
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 選項解析後的標記會轉換成的。

方法

名稱 Description
AddAlias(String)

一個定義命名參數及其參數值的符號。
AddAliasInner(String)

一個定義命名參數及其參數值的符號。

(繼承來源 Symbol)
AddValidator(ValidateSymbol<OptionResult>)

一個定義命名參數及其參數值的符號。
ClearAliases()

一個定義命名參數及其參數值的符號。

(繼承來源 Symbol)
GetCompletions(CompletionContext)

取得符號的補全。
GetDefaultValue()

會取得該選項的預設值。
HasAlias(String)

一個定義命名參數及其參數值的符號。

(繼承來源 Symbol)
HasRawAlias(String)

一個定義命名參數及其參數值的符號。

(繼承來源 Symbol)
Suggest(String)

一個定義命名參數及其參數值的符號。

(繼承來源 Symbol)
ToString()

傳回表示目前 物件的字串。

(繼承來源 Symbol)

明確介面實作

名稱 Description
IOption.Argument

一個定義命名參數及其參數值的符號。
ISymbol.Children

一個定義命名參數及其參數值的符號。

(繼承來源 Symbol)
IValueDescriptor.GetDefaultValue()

一個定義命名參數及其參數值的符號。
IValueDescriptor.HasDefaultValue

一個定義命名參數及其參數值的符號。
IValueDescriptor.Type

一個定義命名參數及其參數值的符號。
IValueDescriptor.ValueName

一個定義命名參數及其參數值的符號。

擴充方法

名稱 Description
BuildAlias(IValueDescriptor)

一個定義命名參數及其參數值的符號。
Parse(Option, String)

一個定義命名參數及其參數值的符號。

適用於