CommandLineBuilder Klasse

Definition

Namespace:

System.CommandLine.Builder

Assembly:

System.CommandLine.dll

Ermöglicht die Komposition von Befehlszeilenkonfigurationen.

public ref class CommandLineBuilder

public class CommandLineBuilder

type CommandLineBuilder = class

Public Class CommandLineBuilder

Vererbung

Object

CommandLineBuilder

Konstruktoren

CommandLineBuilder(Command)

Ermöglicht die Komposition von Befehlszeilenkonfigurationen.

Eigenschaften

Command	Der Befehl, der vom Generator den Stamm des Parsers verwendet.
EnableDirectives	Bestimmt, ob der Parser Befehlszeilendirektiven erkennt.
EnableLegacyDoubleDashBehavior	Bestimmt das Verhalten beim Analysieren eines doppelten Bindestrichs (--) in einer Befehlszeile.
EnablePosixBundling	Bestimmt, ob der Parser gebündelte Optionen im POSIX-Stil erkennt und erweitert.
ResponseFileHandling	Konfiguriert die Behandlung von Antwortdateien durch den Parser. Wenn diese Option aktiviert ist, wird ein Befehlszeilentoken, das mit @ beginnt, erweitert, das ein gültiger Dateipfad ist, als würde er in die Befehlszeile eingefügt.

Methoden

Build()	Erstellt einen Parser basierend auf der Konfiguration des Befehlszeilen-Generators.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Erweiterungsmethoden

AddMiddleware(CommandLineBuilder, Action<InvocationContext>, MiddlewareOrder)	Fügt der Aufrufpipeline einen Middlewaredelegat hinzu, der aufgerufen wird, bevor ein Befehlshandler aufgerufen wird.
AddMiddleware(CommandLineBuilder, InvocationMiddleware, MiddlewareOrder)	Fügt der Aufrufpipeline einen Middlewaredelegat hinzu, der aufgerufen wird, bevor ein Befehlshandler aufgerufen wird.
CancelOnProcessTermination(CommandLineBuilder)	Ermöglicht die Signalisierung und Verarbeitung der Prozessbeendigung über eine CancellationToken , die während des Aufrufs an eine ICommandHandler übergeben werden kann.
EnableDirectives(CommandLineBuilder, Boolean)	Ermöglicht dem Parser, Befehlszeilendirektiven zu erkennen.
EnableLegacyDoubleDashBehavior(CommandLineBuilder, Boolean)	Bestimmt das Verhalten beim Analysieren eines doppelten Bindestrichs (--) in einer Befehlszeile.
EnablePosixBundling(CommandLineBuilder, Boolean)	Ermöglicht dem Parser, gebündelte Optionen im POSIX-Stil zu erkennen und zu erweitern.
ParseResponseFileAs(CommandLineBuilder, ResponseFileHandling)	Konfiguriert die Behandlung von Antwortdateien durch den Parser. Wenn diese Option aktiviert ist, wird ein Befehlszeilentoken, das mit @ beginnt, erweitert, das ein gültiger Dateipfad ist, als würde er in die Befehlszeile eingefügt.
RegisterWithDotnetSuggest(CommandLineBuilder)	Stellt sicher, dass die Anwendung beim dotnet-suggest Tool registriert ist, um Befehlszeilenabschlüsse zu ermöglichen.
UseDefaults(CommandLineBuilder)	Verwendet die Standardkonfiguration.
UseEnvironmentVariableDirective(CommandLineBuilder)	Ermöglicht die Verwendung der [env:key=value] -Direktive, sodass Umgebungsvariablen während des Aufrufs über die Befehlszeile festgelegt werden können.
UseExceptionHandler(CommandLineBuilder, Action<Exception,InvocationContext>, Nullable<Int32>)	Ermöglicht einem Ausnahmehandler, alle nicht behandelten Ausnahmen abzufangen, die von einem Befehlshandler während des Aufrufs ausgelöst werden.
UseHelp(CommandLineBuilder, Action<HelpContext>, Nullable<Int32>)	Konfiguriert die Anwendung so, dass Hilfe angezeigt wird, wenn einer der angegebenen Optionsalias in der Befehlszeile verwendet wird.
UseHelp(CommandLineBuilder, Nullable<Int32>)	Konfiguriert die Anwendung so, dass hilfe angezeigt wird, wenn eine der folgenden Optionen in der Befehlszeile angegeben ist: -h /h --help -? /?
UseHelp(CommandLineBuilder, String[])	Konfiguriert die Anwendung so, dass Hilfe angezeigt wird, wenn einer der angegebenen Optionsalias in der Befehlszeile verwendet wird.
UseLocalizationResources(CommandLineBuilder, LocalizationResources)	Gibt Lokalisierungsressourcen an, die beim Anzeigen von Hilfe, Fehlermeldungen und anderen benutzerseitigen Zeichenfolgen verwendet werden sollen.
UseParseDirective(CommandLineBuilder, Nullable<Int32>)	Ermöglicht die Verwendung der [parse] -Direktive, die bei Angabe in der Befehlszeile die normale Befehlsverarbeitung kurzschließen und ein Diagramm anzeigt, in dem das Analyseergebnis für die Befehlszeileneingabe erläutert wird.
UseParseErrorReporting(CommandLineBuilder, Nullable<Int32>)	Konfiguriert die Befehlszeile so, dass Fehlerinformationen in den Standardfehler geschrieben werden, wenn Fehler beim Analysieren der Befehlszeileneingabe auftreten.
UseSuggestDirective(CommandLineBuilder)	Ermöglicht die Verwendung der [suggest] -Direktive, die, wenn sie in der Befehlszeileneingabe angegeben wird, die normale Befehlsverarbeitung vorgibt, und schreibt eine durch Zeilentrennzeichen getrennte Liste von Vorschlägen, die für die Verwendung durch die meisten Shells geeignet sind, um Befehlszeilenvervollständigungen bereitzustellen.
UseTypoCorrections(CommandLineBuilder, Int32)	Konfiguriert die Anwendung so, dass alternative Vorschläge bereitgestellt werden, wenn ein Analysefehler erkannt wird.
UseVersionOption(CommandLineBuilder)	Aktiviert die Verwendung einer Option (standardmäßig mit dem Alias --version), die bei Angabe in der Befehlszeileneingabe die normale Befehlsverarbeitung kurzschließen und stattdessen Versionsinformationen vor dem Beenden schreibt.
UseVersionOption(CommandLineBuilder, String[])	Aktiviert die Verwendung einer Option (standardmäßig mit dem Alias --version), die bei Angabe in der Befehlszeileneingabe die normale Befehlsverarbeitung kurzschließen und stattdessen Versionsinformationen vor dem Beenden schreibt.