RootCommand 類別

參考

定義

命名空間:: System.CommandLine

組件:: System.CommandLine.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

表示應用程式執行的主要動作。

public ref class RootCommand : System::CommandLine::Command

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

繼承: Object

Symbol

IdentifierSymbol

Command
RootCommand

備註

針對執行一個動作的應用程式，請使用 RootCommand 物件，而不需要任何子命令。針對需要特定字串所識別動作的應用程式，將子命令新增至根目錄。例如，'dir' 不會使用任何子命令。如需具有多個動作的應用程式，請參閱 Command 。

建構函式

RootCommand(String)

表示應用程式執行的主要動作。

屬性

Aliases	取得可在命令行上用來指定符號的字串集。 (繼承來源 IdentifierSymbol)
Arguments	表示命令的所有自變數。 (繼承來源 Command)
Children	取得子符號。 (繼承來源 Command)
Description	取得或設定符號的描述。 (繼承來源 Symbol)
ExecutableName	目前執行中可執行檔的名稱。
ExecutablePath	目前執行中可執行文件的路徑。
Handler	取得或設定 ICommandHandler 命令的。處理程式代表叫用命令時將執行的動作。 (繼承來源 Command)
IsHidden	取得或設定值，指出符號是否隱藏。 (繼承來源 Symbol)
Name	取得或設定符號名稱。 (繼承來源 IdentifierSymbol)
Options	表示命令的所有選項，包括已套用至任何命令上階的全域選項。 (繼承來源 Command)
Parents	取得父符號。 (繼承來源 Symbol)
Subcommands	表示命令的所有子命令。 (繼承來源 Command)
TreatUnmatchedTokensAsErrors	取得或設定值，這個值表示是否應該將不相符的令牌視為錯誤。例如，如果設定為 `true` ，並提供額外的命令或自變數，驗證將會失敗。 (繼承來源 Command)

方法

Add(Argument)	Argument將加入命令。 (繼承來源 Command)
Add(Command)	將子命令新增至命令。 (繼承來源 Command)
Add(Option)	Option將加入命令。 (繼承來源 Command)
AddAlias(String)	新增別名。 (繼承來源 IdentifierSymbol)
AddArgument(Argument)	Argument將加入命令。 (繼承來源 Command)
AddCommand(Command)	將子命令新增至命令。 (繼承來源 Command)
AddGlobalOption(Option)	將全域 Option 新增至命令。 (繼承來源 Command)
AddOption(Option)	Option將加入命令。 (繼承來源 Command)
AddValidator(ValidateSymbolResult<CommandResult>)	將自訂驗證程式新增至命令。驗證程式可用來建立自定義驗證邏輯。 (繼承來源 Command)
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetCompletions()	取得符號的完成。 (繼承來源 Symbol)
GetCompletions(CompletionContext)	取得命令行完成的建議值。 (繼承來源 Command)
GetEnumerator()	取得列舉值，表示命令的所有符號。 (繼承來源 Command)
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
HasAlias(String)	判斷是否已定義別名。 (繼承來源 IdentifierSymbol)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Symbol)

明確介面實作

IEnumerable.GetEnumerator()

傳回逐一查看集合的列舉值。

(繼承來源 Command)

擴充方法

Invoke(Command, String, IConsole)	剖析並叫用命令。
Invoke(Command, String[], IConsole)	剖析並叫用命令。
InvokeAsync(Command, String, IConsole)	剖析並叫用命令。
InvokeAsync(Command, String[], IConsole)	剖析並叫用命令。
Parse(Command, String)	使用指定的命令剖析命令列字串值。
Parse(Command, String[])	使用指定的命令剖析陣列字串。
SetHandler(Command, Action)	根據 Action設定命令的處理程式。
SetHandler(Command, Func<Task>)	根據 Func<TResult>設定命令的處理程式。
SetHandler<T>(Command, Action<T>, IValueDescriptor[])	根據 Action<T>設定命令的處理程式。
SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])	根據 Func<T,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>設定命令的處理程式。
SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])	根據 Action<T1,T2>設定命令的處理程式。
SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])	根據 Func<T1,T2,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])	根據 Action<T1,T2,T3>設定命令的處理程式。
SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4>設定命令的處理程式。
SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])	根據 Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>設定命令的處理程式。
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])	根據 Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>設定命令的處理程式。

適用於

共用方式為

RootCommand 類別

定義

備註

建構函式

屬性

方法

明確介面實作

擴充方法

適用於

其他資源