Option<T> 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
一個定義命名參數及其參數值的符號。
generic <typename T>
public ref class Option : System::CommandLine::Optionpublic class Option<T> : System.CommandLine.Optiontype Option<'T> = class
inherit OptionPublic Class Option(Of T)
Inherits Option類型參數
- T
也就是 Type 說，選擇權的論點預期會被解析為。
- 繼承
建構函式
| 名稱 | Description |
|---|---|
| Option<T>(String, String) |
一個定義命名參數及其參數值的符號。 |
| Option<T>(String, String[]) |
初始化 Option 類別的新執行個體。 |
| Option<T>(String[], String) |
一個定義命名參數及其參數值的符號。 |
屬性
| 名稱 | Description |
|---|---|
| Action |
取得或設定 CommandLineAction 選項。 處理器代表當 Option 被呼叫時將執行的動作。 (繼承來源 Option) |
| Aliases |
取得可用於命令列指定選項的獨特字串集合。 (繼承來源 Option) |
| AllowMultipleArgumentsPerToken |
會獲得一個值，指示每個期權識別碼標記是否允許多個參數標記。 (繼承來源 Option) |
| Argument |
一個定義命名參數及其參數值的符號。 |
| Arity |
取得或設定選擇權的金額。 (繼承來源 Option) |
| Children |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| CompletionSources |
取得該選項的完成來源清單。 (繼承來源 Option) |
| CustomParser |
取得或設定自訂參數解析器。 |
| DefaultValueFactory |
取得或設定代理來呼叫以建立預設值。 |
| Description |
取得或設定符號的描述。 (繼承來源 Symbol) |
| HasDefaultValue |
指定是否定義了該選擇權的預設值。 (繼承來源 Option) |
| HelpName |
取得或設定使用說明中顯示的佔位名稱，作為期權價值的代號。
該值會被 |
| Hidden |
取得或設定一個值，表示該符號是否被隱藏。 (繼承來源 Symbol) |
| IsHidden |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| Name |
會得到符號名稱。 (繼承來源 Symbol) |
| Parents |
取得父代碼。 (繼承來源 Symbol) |
| RawAliases |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| Recursive |
當設定為 true，此選項會套用到其直接的父指令，並遞迴地套用到其子指令。 (繼承來源 Option) |
| Required |
當呼叫父指令時，表示是否需要該選項。 (繼承來源 Option) |
| Validators |
驗證者會在解析器匹配該選項時被呼叫。 (繼承來源 Option) |
| ValueType |
取得 Type 選項解析後的標記會轉換成的。 |
方法
| 名稱 | Description |
|---|---|
| AcceptLegalFileNamesOnly() |
設定只接受代表合法檔案名稱的值的選項。 |
| AcceptLegalFilePathsOnly() |
設定只接受代表合法檔案路徑的值的選項。 |
| AcceptOnlyFromAmong(String[]) |
設定只接受指定值，並建議它們作為命令列補全。 |
| AcceptOnlyFromAmong(StringComparer, String[]) |
設定選項僅接受指定的值，並以命令列補全方式建議。 |
| AddAlias(String) |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
| AddAliasInner(String) |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| AddValidator(ValidateSymbol<OptionResult>) |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
| ClearAliases() |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| GetCompletions(CompletionContext) |
取得符號的補全。 (繼承來源 Option) |
| GetDefaultValue() |
會取得該選項的預設值。 (繼承來源 Option) |
| HasAlias(String) |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| HasRawAlias(String) |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| Suggest(String) |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| ToString() |
傳回表示目前 物件的字串。 (繼承來源 Symbol) |
明確介面實作
| 名稱 | Description |
|---|---|
| IOption.Argument |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
| ISymbol.Children |
一個定義命名參數及其參數值的符號。 (繼承來源 Symbol) |
| IValueDescriptor.GetDefaultValue() |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
| IValueDescriptor.HasDefaultValue |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
| IValueDescriptor.Type |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
| IValueDescriptor.ValueName |
一個定義命名參數及其參數值的符號。 (繼承來源 Option) |
擴充方法
| 名稱 | Description |
|---|---|
| AcceptExistingOnly<T>(Option<T>) |
設定一個選項，只接受對應於現有檔案或目錄的值。 |
| BuildAlias(IValueDescriptor) |
一個定義命名參數及其參數值的符號。 |
| Parse(Option, String) |
一個定義命名參數及其參數值的符號。 |
