語言

Argument<T> 類別

定義

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

generic <typename T>
public ref class Argument : System::CommandLine::Argument
public class Argument<T> : System.CommandLine.Argument
type Argument<'T> = class
    inherit Argument
Public Class Argument(Of T)
Inherits Argument

類型參數

T
繼承
Argument<T>

建構函式

名稱 Description
Argument<T>()

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

Argument<T>(Func<T>)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

Argument<T>(String, T)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

Argument<T>(String)

初始化 Argument 類別的新實例。

Argument<T>(TryConvertArgument<T>)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

屬性

名稱 Description
Aliases

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
ArgumentType

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
Arity

取得或設定論證的強度。

(繼承來源 Argument)
CaptureRemainingTokens

取得或設定一個值,表示此參數是否捕捉了所有剩餘的標記。

(繼承來源 Argument)
Children

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
CompletionSources

取得該論證的補全來源清單。

(繼承來源 Argument)
CustomParser

取得或設定自訂參數解析器。

DefaultValueFactory

取得或設定代理來呼叫以建立預設值。

Description

取得或設定符號的描述。

(繼承來源 Symbol)
HasDefaultValue

指定參數是否定義了預設值。

HasDefaultValue

指定參數是否定義了預設值。

(繼承來源 Argument)
HelpName

取得或設定使用說明中顯示的佔位名稱,作為參數值的值。 該值會被< 括號(和 >)包裹。

(繼承來源 Argument)
Hidden

取得或設定一個值,表示該符號是否被隱藏。

(繼承來源 Symbol)
IsHidden

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
Name

會得到符號名稱。

(繼承來源 Symbol)
Parents

取得父代碼。

(繼承來源 Symbol)
RawAliases

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
Validators

提供參數驗證者清單。 驗證器可用來根據使用者輸入提供自訂錯誤。

(繼承來源 Argument)
ValueType

取得或設定 Type 參數解析後的標記將轉換成 。

方法

名稱 Description
AddAliasInner(String)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
AddSuggestions(IReadOnlyCollection<String>)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
AddSuggestionSource(ISuggestionSource)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
AddSuggestionSource(Suggest)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
AddValidator(ValidateSymbol<ArgumentResult>)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
ClearAliases()

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
GetCompletions(CompletionContext)

取得符號的補全。

(繼承來源 Argument)
GetDefaultValue()

取得參數的預設值。

(繼承來源 Argument)
HasAlias(String)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
HasRawAlias(String)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
SetDefaultValue(Func<Object>)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
SetDefaultValue(Object)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
Suggest(String)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
ToString()

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

(繼承來源 Argument)

明確介面實作

名稱 Description
IArgument.Arity

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
ISymbol.Children

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Symbol)
IValueDescriptor.Type

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)
IValueDescriptor.ValueName

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

(繼承來源 Argument)

擴充方法

名稱 Description
AcceptExistingOnly<T>(Argument<T>)

設定參數只接受與現有檔案或目錄對應的值。

AcceptLegalFileNamesOnly<T>(Argument<T>)

將參數設定為只接受代表合法檔案名稱的值。

AcceptLegalFilePathsOnly<T>(Argument<T>)

將參數設定為只接受代表合法檔案路徑的值。

AcceptOnlyFromAmong<T>(Argument<T>, String[])

設定參數只接受指定的值,並建議它們作為命令列補全。

AcceptOnlyFromAmong<T>(Argument<T>, StringComparer, String[])

將參數配置為只接受指定的值,使用指定的比較器,並建議它們作為命令列補全。

BuildAlias(IValueDescriptor)

一個定義可透過命令列傳遞給 指令 或 選項的值的符號。

適用於