RootCommand Klasse

Definition

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Paket:

System.CommandLine v3.0.0-preview.1.26104.118

Quelle:

RootCommand.cs

Stellt die Hauptaktion dar, die von der Anwendung ausgeführt wird.

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

public class RootCommand : System.CommandLine.Command

type RootCommand = class
    inherit Command

Public Class RootCommand
Inherits Command

Vererbung

Object

Symbol

Command

RootCommand

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)
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.
Hidden	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Symbol ausgeblendet ist. (Geerbt von Symbol)
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)
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)
GetCompletions(CompletionContext)	Ruft Fertigstellungen für das Symbol ab. (Geerbt von Command)
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)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Symbol)

Explizite Schnittstellenimplementierungen

Name	Beschreibung
IEnumerable.GetEnumerator()	Gibt einen Enumerator zurück, der eine Auflistung durchläuft. (Geerbt von Command)