HelpBuilder Klasse

Definition

Namespace:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Formatiert die Ausgabe, die Benutzern angezeigt werden soll, um die Verwendung eines Befehlszeilentools zu beschreiben.

public ref class HelpBuilder

public class HelpBuilder

type HelpBuilder = class

Public Class HelpBuilder

Vererbung

Object

HelpBuilder

Konstruktoren

HelpBuilder(LocalizationResources, Int32)

Formatiert die Ausgabe, die Benutzern angezeigt werden soll, um die Verwendung eines Befehlszeilentools zu beschreiben.

Eigenschaften

LocalizationResources	Stellt lokalisierbare Zeichenfolgen für Hilfe- und Fehlermeldungen bereit.
MaxWidth	Die maximale Breite, für die die Hilfeausgabe formatiert werden soll.

Methoden

CustomizeLayout(Func<HelpContext,IEnumerable<HelpSectionDelegate>>)	Passt die angezeigten Hilfeabschnitte an.
CustomizeSymbol(Symbol, Func<HelpContext,String>, Func<HelpContext,String>, Func<HelpContext,String>)	Gibt benutzerdefinierte Hilfedetails für ein bestimmtes Symbol an.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetTwoColumnRow(Symbol, HelpContext)	Ruft ein Hilfeelement für das angegebene Symbol ab.
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)
Write(HelpContext)	Schreibt die Hilfeausgabe für den angegebenen Befehl.
WriteColumns(IReadOnlyList<TwoColumnHelpRow>, HelpContext)	Schreibt die angegebenen Hilfezeilen und richtet die Ausgabe in Spalten aus.

Erweiterungsmethoden

CustomizeSymbol(HelpBuilder, Symbol, String, String, String)	Gibt benutzerdefinierte Hilfedetails für ein bestimmtes Symbol an.
Write(HelpBuilder, Command, TextWriter)	Schreibt die Hilfeausgabe für den angegebenen Befehl.