Command Klasse

Referenz

Definition

Namespace:: System.CommandLine

Assembly:: System.CommandLine.dll

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

public ref class Command : System::CommandLine::IdentifierSymbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>

public class Command : System.CommandLine.IdentifierSymbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>

type Command = class
    inherit IdentifierSymbol
    interface seq<Symbol>
    interface IEnumerable

Public Class Command
Inherits IdentifierSymbol
Implements IEnumerable(Of Symbol)

Vererbung: Object

Symbol

IdentifierSymbol
Command

Abgeleitet: System.CommandLine.RootCommand

Implementiert: IEnumerable<Symbol> IEnumerable

Hinweise

Verwenden Sie das Command-Objekt für Aktionen, die einer bestimmten Zeichenfolge (dem Befehlsnamen) entsprechen. Weitere Informationen finden Sie RootCommand unter Einfache Anwendungen, die nur über eine Aktion verfügen. Verwendet run beispielsweise dotnet run als Befehl.

Konstruktoren

Command(String, String)

Initialisiert eine neue Instanz der Befehlsklasse.

Eigenschaften

Aliases	Ruft den Satz von Zeichenfolgen ab, der in der Befehlszeile verwendet werden kann, um das Symbol anzugeben. (Geerbt von IdentifierSymbol)
Arguments	Stellt alle Argumente für den Befehl dar.
Children	Ruft die untergeordneten Symbole ab.
Description	Ruft die Beschreibung des Symbols ab oder legt sie fest. (Geerbt von Symbol)
Handler	Ruft den ICommandHandler für den Befehl ab oder legt dieses fest. Der Handler stellt die Aktion dar, die ausgeführt wird, wenn der Befehl aufgerufen wird.
IsHidden	Ruft einen Wert ab, der angibt, ob das Symbol ausgeblendet ist, oder legt den Wert fest. (Geerbt von Symbol)
Name	Ruft den Symbolnamen ab oder legt diese fest. (Geerbt von IdentifierSymbol)
Options	Stellt alle Optionen für den Befehl dar, einschließlich globaler Optionen, die auf eine der Vorgänger des Befehls angewendet wurden.
Parents	Ruft die übergeordneten Symbole ab. (Geerbt von Symbol)
Subcommands	Stellt alle Unterbefehle für den Befehl dar.
TreatUnmatchedTokensAsErrors	Ruft einen Wert ab, der angibt, ob nicht übereinstimmende Token als Fehler behandelt werden sollen, oder legt diesen fest. Wenn beispielsweise auf `true` festgelegt ist und ein zusätzlicher Befehl oder ein zusätzliches Argument bereitgestellt wird, schlägt die Überprüfung fehl.

Methoden

Add(Argument)	Fügt dem Befehl eine hinzu Argument .
Add(Command)	Fügt dem Befehl einen Unterbefehl hinzu.
Add(Option)	Fügt dem Befehl eine hinzu Option .
AddAlias(String)	Fügt einen Alias hinzu. (Geerbt von IdentifierSymbol)
AddArgument(Argument)	Fügt dem Befehl eine hinzu Argument .
AddCommand(Command)	Fügt dem Befehl einen Unterbefehl hinzu.
AddGlobalOption(Option)	Fügt dem Befehl eine globale Option hinzu.
AddOption(Option)	Fügt dem Befehl eine hinzu Option .
AddValidator(ValidateSymbolResult<CommandResult>)	Fügt dem Befehl einen benutzerdefinierten Validierungsator hinzu. Validatoren können verwendet werden, um benutzerdefinierte Validierungslogik zu erstellen.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetCompletions()	Ruft Vervollständigungen für das Symbol ab. (Geerbt von Symbol)
GetCompletions(CompletionContext)	Ruft die vorgeschlagenen Werte für die Befehlszeilen-Vervollständigung ab.
GetEnumerator()	Ruft einen Enumerator ab, der alle Symbole für den Befehl darstellt.
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
HasAlias(String)	Bestimmt, ob der Alias bereits definiert wurde. (Geerbt von IdentifierSymbol)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Symbol)

Explizite Schnittstellenimplementierungen

IEnumerable.GetEnumerator()

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

Erweiterungsmethoden

Invoke(Command, String, IConsole)	Analysiert und ruft einen Befehl auf.
Invoke(Command, String[], IConsole)	Analysiert und ruft einen Befehl auf.
InvokeAsync(Command, String, IConsole)	Analysiert und ruft einen Befehl auf.
InvokeAsync(Command, String[], IConsole)	Analysiert und ruft einen Befehl auf.
Parse(Command, String)	Analysiert einen Befehlszeilenzeichenfolgenwert mithilfe des angegebenen Befehls.
Parse(Command, String[])	Analysiert arrayzeichenfolgen mithilfe des angegebenen Befehls.
SetHandler(Command, Action)	Legt den Handler eines Befehls basierend auf einem fest Action.
SetHandler(Command, Func<Task>)	Legt den Handler eines Befehls basierend auf einem fest Func<TResult>.
SetHandler<T>(Command, Action<T>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T>.
SetHandler<T>(Command, Func<T,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15, T16>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13, T14,T15,T16,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,TResult>.
SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2>.
SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,TResult>.
SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3>.
SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,TResult>.
SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4>.
SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,TResult>.
SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5>.
SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5,T6>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4,T5,T6,T7>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5,T6,T7,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Action<T1,T2,T3,T4,T5,T6,T7,T8,T9>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8,T9>(Command, Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,Task>, IValueDescriptor[])	Legt den Handler eines Befehls basierend auf einem fest Func<T1,T2,T3,T4,T5,T6,T7,T8,T9,TResult>.

Gilt für: