Command Klasse

Definition

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Paket:

System.CommandLine v3.0.0-preview.1.26104.118

Quelle:

Command.cs

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.

public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable

public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable

type Command = class
    inherit Symbol
    interface IEnumerable

Public Class Command
Inherits Symbol
Implements IEnumerable

Vererbung

Object

Symbol

Command

Abgeleitet

System.CommandLine.RootCommand

Implementiert

IEnumerable

Hinweise

Verwenden Sie das Command-Objekt für Aktionen, die einer bestimmten Zeichenfolge (dem Befehlsnamen) entsprechen. Einfache Anwendungen, die nur eine Aktion haben, finden Sie unter RootCommand. Wird z. B dotnet run . als Befehl verwendet run .

Konstruktoren

Name	Beschreibung
Command(String, String)	Initialisiert eine neue Instanz der Command-Klasse.

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.
Aliases	Ruft den eindeutigen Satz von Zeichenfolgen ab, die in der Befehlszeile verwendet werden können, um den Befehl anzugeben.
Arguments	Ruft alle Argumente für den Befehl ab.
Children	Ruft die untergeordneten Symbole ab.
Description	Ruft die Beschreibung des Symbols ab oder legt diese fest. (Geerbt von Symbol)
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.
Parents	Ruft die übergeordneten Symbole ab. (Geerbt von Symbol)
Subcommands	Ruft alle Unterbefehle für den Befehl ab.
TreatUnmatchedTokensAsErrors	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob nicht übereinstimmende Token als Fehler behandelt werden sollen.
Validators	Ruft die Validatoren für den Befehl ab. Validatoren können verwendet werden, um benutzerdefinierte Validierungslogik zu erstellen.

Methoden

Name	Beschreibung
Add(Argument)	Fügt dem Befehl einen Argument hinzu.
Add(Command)	Fügt dem Befehl einen Command hinzu.
Add(Option)	Fügt dem Befehl einen Option hinzu.
GetCompletions(CompletionContext)	Ruft Fertigstellungen für das Symbol ab.
Parse(IReadOnlyList<String>, ParserConfiguration)	Analysiert eine Arrayzeichenfolge mithilfe des Befehls.
Parse(String, ParserConfiguration)	Analysiert einen Befehlszeilenzeichenfolgenwert mithilfe des Befehls.
SetAction(Action<ParseResult>)	Legt eine synchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird.
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)	Legt eine asynchrone Aktion fest, wenn der Befehl aufgerufen wird.
SetAction(Func<ParseResult,CancellationToken,Task>)	Legt eine asynchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird.
SetAction(Func<ParseResult,Int32>)	Legt eine synchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird.
SetAction(Func<ParseResult,Task<Int32>>)	Legt eine asynchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird.
SetAction(Func<ParseResult,Task>)	Legt eine asynchrone Aktion fest, die ausgeführt werden soll, wenn der Befehl aufgerufen wird.
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.