RootCommand 類別

定義

命名空間:

System.CommandLine

組件:

System.CommandLine.dll

套件:

System.CommandLine v3.0.0-preview.1.26104.118

來源:

RootCommand.cs

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

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

Command

RootCommand

備註

對於執行單一動作的應用程式，使用不包含任何子指令的 RootCommand 物件。 對於需要特定字串識別動作的應用程式，在根目錄中加入子指令。 例如，「dir」不使用任何子指令。 請參考 Command 具有多重動作的應用。

建構函式

名稱	Description
RootCommand(String)	代表應用程式執行的主要動作。

屬性

名稱	Description
Action	接收或設定 CommandLineAction 指揮。 處理器代表指令被呼叫時將執行的動作。 (繼承來源 Command)
Aliases	取得可用於命令列指定指令的獨特字串集合。 (繼承來源 Command)
Arguments	能取得所有該指令的論點。 (繼承來源 Command)
Children	會獲得子符號。 (繼承來源 Command)
Description	取得或設定符號的描述。 (繼承來源 Symbol)
Directives	代表所有在根指令下有效的指令。
ExecutableName	目前執行檔的名稱。
ExecutablePath	就是目前執行檔的路徑。
Hidden	取得或設定一個值，表示該符號是否被隱藏。 (繼承來源 Symbol)
Name	會得到符號名稱。 (繼承來源 Symbol)
Options	它會獲得所有指令的選項。 (繼承來源 Command)
Parents	取得父代碼。 (繼承來源 Symbol)
Subcommands	會取得該指令的所有子指令。 (繼承來源 Command)
TreatUnmatchedTokensAsErrors	取得或設定一個值，指示未匹配的標記是否應視為錯誤。 (繼承來源 Command)
Validators	讓驗證者接收到指令。 驗證器可用來建立自訂的驗證邏輯。 (繼承來源 Command)

方法

名稱	Description
Add(Argument)	在指令中加入 a Argument 。 (繼承來源 Command)
Add(Command)	在指令中加入 a Command 。 (繼承來源 Command)
Add(Directive)	在指令中加入 a Directive 。
Add(Option)	在指令中加入了 。Option (繼承來源 Command)
GetCompletions(CompletionContext)	取得符號的補全。 (繼承來源 Command)
Parse(IReadOnlyList<String>, ParserConfiguration)	用指令解析陣列字串。 (繼承來源 Command)
Parse(String, ParserConfiguration)	使用 命令解析命令列字串值。 (繼承來源 Command)
SetAction(Action<ParseResult>)	設定一個同步動作，當指令被呼叫時執行。 (繼承來源 Command)
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)	當指令被呼叫時，會設定一個非同步動作。 (繼承來源 Command)
SetAction(Func<ParseResult,CancellationToken,Task>)	設定一個非同步動作，在呼叫指令時執行。 (繼承來源 Command)
SetAction(Func<ParseResult,Int32>)	設定一個同步動作，當指令被呼叫時執行。 (繼承來源 Command)
SetAction(Func<ParseResult,Task<Int32>>)	設定一個非同步動作，在呼叫指令時執行。 (繼承來源 Command)
SetAction(Func<ParseResult,Task>)	設定一個非同步動作，在呼叫指令時執行。 (繼承來源 Command)
ToString()	回傳一個代表當前物件的字串。 (繼承來源 Symbol)

明確介面實作

名稱	Description
IEnumerable.GetEnumerator()	回傳一個遍歷集合的列舉器。 (繼承來源 Command)