Sprache

Command Klasse

Definition

Namespace:
System.CommandLine
Assembly:
System.CommandLine.dll
Paket:
System.CommandLine v3.0.0-rc.1.26425.128
Paket:
System.CommandLine.Experimental v0.3.0-alpha.19577.1
Quelle:
Command.cs
Quelle:
Command.cs
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 ref class Command : System::CommandLine::Symbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>, System::CommandLine::ICommand
public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable
public class Command : System.CommandLine.Symbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>, System.CommandLine.ICommand
type Command = class
    inherit Symbol
    interface IEnumerable
type Command = class
    inherit Symbol
    interface ICommand
    interface ISymbol
    interface ISuggestionSource
    interface seq<Symbol>
    interface IEnumerable
Public Class Command
Inherits Symbol
Implements IEnumerable
Public Class Command
Inherits Symbol
Implements ICommand, IEnumerable(Of Symbol)
Vererbung
Object
Symbol
Command
Abgeleitet
Implementiert
IEnumerable IEnumerable<Symbol> ICommand ISuggestionSource ISymbol

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 einen neuen instance 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.
Aliases

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

(Geerbt von Symbol)
Argument
Veraltet.

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

Ruft alle Argumente für den Befehl ab.
Children

Ruft die untergeordneten Symbole ab.
Children

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

(Geerbt von Symbol)
Description

Ruft die Beschreibung des Symbols ab oder legt diese fest.

(Geerbt von Symbol)
Handler

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

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Symbol ausgeblendet ist.

(Geerbt von Symbol)
IsHidden

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

(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)
RawAliases

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

(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.
Add(Symbol)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
AddAlias(String)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
AddAliasInner(String)

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

(Geerbt von Symbol)
AddArgument(Argument)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
AddCommand(Command)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
AddOption(Option)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
AddValidator(ValidateSymbol<CommandResult>)

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

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

(Geerbt von Symbol)
GetCompletions(CompletionContext)

Ruft Fertigstellungen für das Symbol ab.
GetEnumerator()

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
HasAlias(String)

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

(Geerbt von Symbol)
HasRawAlias(String)

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

(Geerbt von Symbol)
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.
Suggest(String)

Stellt eine bestimmte Aktion 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 eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
ICommand.Arguments

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

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
IEnumerable.GetEnumerator()

Gibt einen Enumerator zurück, der eine Auflistung durchläuft.
ISymbol.Children

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

(Geerbt von Symbol)

Erweiterungsmethoden

Name Beschreibung
ConfigureFromMethod(Command, MethodInfo, Object)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
Invoke(Command, String, IConsole)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
Invoke(Command, String[], IConsole)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
InvokeAsync(Command, String, IConsole)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
InvokeAsync(Command, String[], IConsole)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
Parse(Command, String, IReadOnlyCollection<Char>)

Stellt eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.
Parse(Command, String[])

Stellt eine bestimmte Aktion 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 eine bestimmte Aktion dar, die von der Anwendung ausgeführt wird.

Gilt für: