HelpBuilder Classe

Définition

Espace de noms:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Met en forme la sortie à afficher aux utilisateurs pour décrire comment utiliser un outil en ligne de commande.

public ref class HelpBuilder

public class HelpBuilder

type HelpBuilder = class

Public Class HelpBuilder

Héritage

Object

HelpBuilder

Constructeurs

HelpBuilder(LocalizationResources, Int32)

Met en forme la sortie à afficher aux utilisateurs pour décrire comment utiliser un outil en ligne de commande.

Propriétés

LocalizationResources	Fournit des chaînes localisables pour les messages d’aide et d’erreur.
MaxWidth	Largeur maximale pour laquelle mettre en forme la sortie de l’aide.

Méthodes

CustomizeLayout(Func<HelpContext,IEnumerable<HelpSectionDelegate>>)	Personnalise les sections d’aide qui seront affichées.
CustomizeSymbol(Symbol, Func<HelpContext,String>, Func<HelpContext,String>, Func<HelpContext,String>)	Spécifie les détails de l’aide personnalisée pour un symbole spécifique.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetTwoColumnRow(Symbol, HelpContext)	Obtient un élément d’aide pour le symbole spécifié.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
Write(HelpContext)	Écrit la sortie d’aide pour la commande spécifiée.
WriteColumns(IReadOnlyList<TwoColumnHelpRow>, HelpContext)	Écrit les lignes d’aide spécifiées, en alignant la sortie en colonnes.

Méthodes d’extension

CustomizeSymbol(HelpBuilder, Symbol, String, String, String)	Spécifie les détails de l’aide personnalisée pour un symbole spécifique.
Write(HelpBuilder, Command, TextWriter)	Écrit la sortie d’aide pour la commande spécifiée.