HelpBuilder.Default Class

Definition

Namespace:

System.CommandLine.Help

Assembly:

System.CommandLine.dll

Provides default formatting for help output.

public: ref class HelpBuilder::Default abstract sealed

public static class HelpBuilder.Default

type HelpBuilder.Default = class

Public Class HelpBuilder.Default

Inheritance

Object

HelpBuilder.Default

Methods

AdditionalArgumentsSection()	Writes a help section describing a command's additional arguments, typically shown only when TreatUnmatchedTokensAsErrors is set to true.
CommandArgumentsSection()	Writes a help section describing a command's arguments.
CommandUsageSection()	Writes a help section describing a command's usage.
GetArgumentDefaultValue(Argument)	Gets an argument's default value to be displayed in help.
GetArgumentDescription(Argument)	Gets the description for an argument (typically used in the second column text in the arguments section).
GetArgumentUsageLabel(Argument)	Gets the usage title for an argument (for example: <value>, typically used in the first column text in the arguments usage section, or within the synopsis.
GetIdentifierSymbolDescription(IdentifierSymbol)	Gets the description for the specified symbol (typically the used as the second column in help text).
GetIdentifierSymbolUsageLabel(IdentifierSymbol, HelpContext)	Gets the usage label for the specified symbol (typically used as the first column text in help output).
GetLayout()	Gets the default sections to be written for command line help.
OptionsSection()	Writes a help section describing a command's options.
SubcommandsSection()	Writes a help section describing a command's subcommands.
SynopsisSection()	Writes a help section describing a command's synopsis.