RootCommand Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird.
public ref class RootCommand : System::CommandLine::Commandpublic class RootCommand : System.CommandLine.Commandtype RootCommand = class
inherit CommandPublic Class RootCommand
Inherits Command- Vererbung
Hinweise
Verwenden Sie das RootCommand-Objekt ohne Unterbefehle für Anwendungen, die eine Aktion ausführen. Fügen Sie dem Stamm für Anwendungen Unterbefehle hinzu, die Aktionen erfordern, die durch bestimmte Zeichenfolgen identifiziert werden. "dir" verwendet z. B. keine Unterbefehle. Weitere Informationen zu Command Anwendungen mit mehreren Aktionen.
Konstruktoren
| Name | Beschreibung |
|---|---|
| RootCommand(String) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| Action |
Dient zum Abrufen oder Festlegen des CommandLineAction Befehls. Der Handler stellt die Aktion dar, die beim Aufrufen des Befehls ausgeführt wird. (Geerbt von Command) |
| Aliases |
Ruft den eindeutigen Satz von Zeichenfolgen ab, die in der Befehlszeile verwendet werden können, um den Befehl anzugeben. (Geerbt von Command) |
| Argument |
Veraltet.
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| Arguments |
Ruft alle Argumente für den Befehl ab. (Geerbt von Command) |
| Children |
Ruft die untergeordneten Symbole ab. (Geerbt von Command) |
| Description |
Ruft die Beschreibung des Symbols ab oder legt diese fest. (Geerbt von Symbol) |
| Directives |
Stellt alle Direktiven dar, die unter dem Stammbefehl gültig sind. |
| ExecutableName |
Der Name der derzeit ausgeführten ausführbaren Datei. |
| ExecutablePath |
Der Pfad zur derzeit ausgeführten ausführbaren Datei. |
| ExeName |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| ExePath |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| Handler |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| HelpName |
Ruft den Namen ab, der für den Stammbefehl in der Hilfeausgabe verwendet wird, oder legt den Namen fest. |
| Hidden |
Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Symbol ausgeblendet ist. (Geerbt von Symbol) |
| IsHidden |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| Name |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| Name |
Ruft den Namen des Symbols ab. (Geerbt von Symbol) |
| Options |
Ruft alle Optionen für den Befehl ab. (Geerbt von Command) |
| Parents |
Ruft die übergeordneten Symbole ab. (Geerbt von Symbol) |
| RawAliases |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| Subcommands |
Ruft alle Unterbefehle für den Befehl ab. (Geerbt von Command) |
| TreatUnmatchedTokensAsErrors |
Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob nicht übereinstimmende Token als Fehler behandelt werden sollen. (Geerbt von Command) |
| Validators |
Ruft die Validatoren für den Befehl ab. Validatoren können verwendet werden, um benutzerdefinierte Validierungslogik zu erstellen. (Geerbt von Command) |
Methoden
| Name | Beschreibung |
|---|---|
| Add(Argument) |
Fügt dem Befehl einen Argument hinzu. (Geerbt von Command) |
| Add(Command) |
Fügt dem Befehl einen Command hinzu. (Geerbt von Command) |
| Add(Directive) |
Fügt dem Befehl einen Directive hinzu. |
| Add(Option) |
Fügt dem Befehl einen Option hinzu. (Geerbt von Command) |
| Add(Symbol) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| AddAlias(String) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| AddAliasInner(String) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| AddArgument(Argument) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| AddCommand(Command) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| AddOption(Option) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| AddValidator(ValidateSymbol<CommandResult>) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| ClearAliases() |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| GetCompletions(CompletionContext) |
Ruft Fertigstellungen für das Symbol ab. (Geerbt von Command) |
| GetEnumerator() |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| HasAlias(String) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| HasRawAlias(String) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| Parse(IReadOnlyList<String>, ParserConfiguration) |
Analysiert eine Arrayzeichenfolge mithilfe des Befehls. (Geerbt von Command) |
| Parse(String, ParserConfiguration) |
Analysiert einen Befehlszeilenzeichenfolgenwert mithilfe des Befehls. (Geerbt von Command) |
| SetAction(Action<ParseResult>) |
Legt eine synchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird. (Geerbt von Command) |
| SetAction(Func<ParseResult,CancellationToken,Task<Int32>>) |
Legt eine asynchrone Aktion fest, wenn der Befehl aufgerufen wird. (Geerbt von Command) |
| SetAction(Func<ParseResult,CancellationToken,Task>) |
Legt eine asynchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird. (Geerbt von Command) |
| SetAction(Func<ParseResult,Int32>) |
Legt eine synchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird. (Geerbt von Command) |
| SetAction(Func<ParseResult,Task<Int32>>) |
Legt eine asynchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird. (Geerbt von Command) |
| SetAction(Func<ParseResult,Task>) |
Legt eine asynchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird. (Geerbt von Command) |
| Suggest(String) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Symbol) |
Explizite Schnittstellenimplementierungen
| Name | Beschreibung |
|---|---|
| ICommand.Argument |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| ICommand.Arguments |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| ICommand.Options |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Command) |
| IEnumerable.GetEnumerator() |
Gibt einen Enumerator zurück, der eine Auflistung durchläuft. (Geerbt von Command) |
| ISymbol.Children |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. (Geerbt von Symbol) |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| ConfigureFromMethod(Command, MethodInfo, Object) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| Invoke(Command, String, IConsole) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| Invoke(Command, String[], IConsole) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| InvokeAsync(Command, String, IConsole) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| InvokeAsync(Command, String[], IConsole) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| Parse(Command, String, IReadOnlyCollection<Char>) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| Parse(Command, String[]) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
| ToAsyncEnumerable<TSource>(IEnumerable<TSource>) |
Wandelt eine IEnumerable<T> in eine IAsyncEnumerable<T>um. |
| ToFrozenDictionary<TSource,TKey,TElement>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TElement>, IEqualityComparer<TKey>) |
Erstellt eine FrozenDictionary<TKey,TValue> aus einer IEnumerable<T> gemäß den angegebenen Schlüsselauswahl- und Elementauswahlfunktionen. |
| ToFrozenDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Erstellt eine FrozenDictionary<TKey,TValue> aus einer IEnumerable<T> bestimmten Schlüsselauswahlfunktion. |
| ToFrozenSet<T>(IEnumerable<T>, IEqualityComparer<T>) |
Erstellt eine FrozenSet<T> mit den angegebenen Werten. |
| ToImmutableArray<TSource>(IEnumerable<TSource>) |
Erstellt ein unveränderliches Array aus der angegebenen Auflistung. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>, IEqualityComparer<TValue>) |
Enumeiert und transformiert eine Sequenz und erzeugt ein unveränderliches Wörterbuch seiner Inhalte mithilfe des angegebenen Schlüssel- und Wertabgleichs. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IEqualityComparer<TKey>) |
Enumeiert und transformiert eine Sequenz und erzeugt ein unveränderliches Wörterbuch seiner Inhalte mithilfe des angegebenen Schlüsselabgleichs. |
| ToImmutableDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumeiert und transformiert eine Sequenz und erzeugt ein unveränderliches Wörterbuch seiner Inhalte. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IEqualityComparer<TKey>) |
Erstellt ein unveränderliches Wörterbuch basierend auf einer Transformation einer Sequenz. |
| ToImmutableDictionary<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) |
Erstellt ein unveränderliches Wörterbuch aus einer vorhandenen Auflistung von Elementen, wobei eine Transformationsfunktion auf die Quellschlüssel angewendet wird. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>, IEqualityComparer<TSource>) |
Listet eine Sequenz auf, erzeugt einen unveränderlichen Hashsatz seines Inhalts und verwendet den angegebenen Gleichheitsabgleich für den Settyp. |
| ToImmutableHashSet<TSource>(IEnumerable<TSource>) |
Listet eine Sequenz auf und erzeugt einen unveränderlichen Hashsatz seiner Inhalte. |
| ToImmutableList<TSource>(IEnumerable<TSource>) |
Listet eine Sequenz auf und erzeugt eine unveränderliche Liste seiner Inhalte. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>, IEqualityComparer<TValue>) |
Enumeiert und transformiert eine Sequenz und erzeugt ein unveränderliches sortiertes Wörterbuch seiner Inhalte mithilfe des angegebenen Schlüssel- und Wertabgleichs. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>, IComparer<TKey>) |
Enumeiert und transformiert eine Sequenz und erzeugt ein unveränderliches sortiertes Wörterbuch seiner Inhalte mithilfe des angegebenen Schlüsselabgleichs. |
| ToImmutableSortedDictionary<TSource,TKey,TValue>(IEnumerable<TSource>, Func<TSource,TKey>, Func<TSource,TValue>) |
Enumeiert und transformiert eine Sequenz und erzeugt ein unveränderliches sortiertes Wörterbuch seiner Inhalte. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>, IComparer<TSource>) |
Listet eine Sequenz auf, erzeugt einen unveränderlichen sortierten Satz seines Inhalts und verwendet den angegebenen Vergleich. |
| ToImmutableSortedSet<TSource>(IEnumerable<TSource>) |
Listet eine Sequenz auf und erzeugt einen unveränderlichen sortierten Satz seiner Inhalte. |
| UseCommandHandler<THandler>(Command) |
Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird. |
