RootCommand 類別

定義

命名空間:: System.CommandLine

組件:: System.CommandLine.dll

套件:: System.CommandLine v3.0.0-rc.1.26425.128

套件:: System.CommandLine.Experimental v0.3.0-alpha.19577.1

來源:: RootCommand.cs

來源:: RootCommand.cs

來源:: RootCommand.cs

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 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

Command
RootCommand

備註

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

建構函式

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

屬性

名稱	Description
Action	接收或設定 CommandLineAction 指揮。處理器代表指令被呼叫時將執行的動作。 (繼承來源 Command)
Aliases	取得可用於命令列指定指令的獨特字串集合。 (繼承來源 Command)
Argument	已淘汰. 代表應用程式執行的主要動作。 (繼承來源 Command)
Arguments	能取得所有該指令的論點。 (繼承來源 Command)
Children	會獲得子符號。 (繼承來源 Command)
Description	取得或設定符號的描述。 (繼承來源 Symbol)
Directives	代表所有在根指令下有效的指令。
ExecutableName	目前執行檔的名稱。
ExecutablePath	就是目前執行檔的路徑。
ExeName	代表應用程式執行的主要動作。
ExePath	代表應用程式執行的主要動作。
Handler	代表應用程式執行的主要動作。 (繼承來源 Command)
HelpName	在幫助輸出中取得或設定根指令的名稱。
Hidden	取得或設定一個值，表示該符號是否被隱藏。 (繼承來源 Symbol)
IsHidden	代表應用程式執行的主要動作。 (繼承來源 Symbol)
Name	代表應用程式執行的主要動作。
Name	會得到符號名稱。 (繼承來源 Symbol)
Options	它會獲得所有指令的選項。 (繼承來源 Command)
Parents	取得父代碼。 (繼承來源 Symbol)
RawAliases	代表應用程式執行的主要動作。 (繼承來源 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)
Add(Symbol)	代表應用程式執行的主要動作。 (繼承來源 Command)
AddAlias(String)	代表應用程式執行的主要動作。 (繼承來源 Command)
AddAliasInner(String)	代表應用程式執行的主要動作。 (繼承來源 Symbol)
AddArgument(Argument)	代表應用程式執行的主要動作。 (繼承來源 Command)
AddCommand(Command)	代表應用程式執行的主要動作。 (繼承來源 Command)
AddOption(Option)	代表應用程式執行的主要動作。 (繼承來源 Command)
AddValidator(ValidateSymbol<CommandResult>)	代表應用程式執行的主要動作。 (繼承來源 Command)
ClearAliases()	代表應用程式執行的主要動作。 (繼承來源 Symbol)
GetCompletions(CompletionContext)	取得符號的補全。 (繼承來源 Command)
GetEnumerator()	代表應用程式執行的主要動作。 (繼承來源 Command)
HasAlias(String)	代表應用程式執行的主要動作。 (繼承來源 Symbol)
HasRawAlias(String)	代表應用程式執行的主要動作。 (繼承來源 Symbol)
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)
Suggest(String)	代表應用程式執行的主要動作。 (繼承來源 Symbol)
ToString()	傳回表示目前物件的字串。 (繼承來源 Symbol)

明確介面實作

名稱	Description
ICommand.Argument	代表應用程式執行的主要動作。 (繼承來源 Command)
ICommand.Arguments	代表應用程式執行的主要動作。 (繼承來源 Command)
ICommand.Options	代表應用程式執行的主要動作。 (繼承來源 Command)
IEnumerable.GetEnumerator()	傳回逐一查看集合的列舉值。 (繼承來源 Command)
ISymbol.Children	代表應用程式執行的主要動作。 (繼承來源 Symbol)

擴充方法

名稱	Description
ConfigureFromMethod(Command, MethodInfo, Object)	代表應用程式執行的主要動作。
Invoke(Command, String, IConsole)	代表應用程式執行的主要動作。
Invoke(Command, String[], IConsole)	代表應用程式執行的主要動作。
InvokeAsync(Command, String, IConsole)	代表應用程式執行的主要動作。
InvokeAsync(Command, String[], IConsole)	代表應用程式執行的主要動作。
Parse(Command, String, IReadOnlyCollection<Char>)	代表應用程式執行的主要動作。
Parse(Command, String[])	代表應用程式執行的主要動作。
ToAsyncEnumerable<TSource>(IEnumerable<TSource>)	將 IEnumerable<T> 轉換成 IAsyncEnumerable<T>。
ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>)	根據指定的索引鍵選取器和項目選取器函式，從 FrozenDictionary<TKey,TValue> 建立 IEnumerable<T>。
ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	根據指定的鍵選擇函式從 FrozenDictionary<TKey,TValue> a 建立。IEnumerable<T>
ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>)	建立 FrozenSet<T> 一個符合指定值的。
ToImmutableArray<TSource>(IEnumerable<TSource>)	從指定的集合建立不可變的陣列。
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>)	列舉和轉換序列，並使用指定的索引鍵和值比較子產生其內容的不可變字典。
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>)	列舉和轉換序列，並使用指定的索引鍵比較子產生其內容的不可變字典。
ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	列舉和轉換序列，併產生其內容的不可變字典。
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>)	根據序列的一些轉換，建構不可變的字典。
ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	從現有的專案集合建構不可變的字典，將轉換函式套用至來源索引鍵。
ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>)	列舉序列、產生其內容的不可變哈希集，並使用集合類型的指定相等比較子。
ToImmutableHashSet<TSource>(IEnumerable<TSource>)	列舉序列，併產生其內容的不可變哈希集。
ToImmutableList<TSource>(IEnumerable<TSource>)	列舉序列，併產生其內容的不可變清單。
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>)	列舉和轉換序列，並使用指定的索引鍵和值比較子產生其內容的不可變排序字典。
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>)	列舉和轉換序列，並使用指定的索引鍵比較子產生其內容的不可變排序字典。
ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>)	列舉和轉換序列，併產生其內容的不可變排序字典。
ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>)	列舉序列、產生其內容的不可變排序集，並使用指定的比較子。
ToImmutableSortedSet<TSource>(IEnumerable<TSource>)	列舉序列，併產生其內容的不可變排序集。
UseCommandHandler<THandler>(Command)	代表應用程式執行的主要動作。

適用於

意見反應

此頁面對您有幫助嗎？