HelpBuilder Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Formats output to be shown to users to describe how to use a command line tool.
public ref class HelpBuilderpublic class HelpBuildertype HelpBuilder = classPublic Class HelpBuilder- Inheritance
-
HelpBuilder
Constructors
| HelpBuilder(LocalizationResources, Int32) |
Properties
| LocalizationResources |
Provides localizable strings for help and error messages. |
| MaxWidth |
The maximum width for which to format help output. |
Methods
| CustomizeLayout(Func<HelpContext,IEnumerable<HelpSectionDelegate>>) |
Customizes the help sections that will be displayed. |
| CustomizeSymbol(Symbol, Func<HelpContext,String>, Func<HelpContext,String>, Func<HelpContext,String>) |
Specifies custom help details for a specific symbol. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetTwoColumnRow(Symbol, HelpContext) |
Gets a help item for the specified symbol. |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| Write(HelpContext) |
Writes help output for the specified command. |
| WriteColumns(IReadOnlyList<TwoColumnHelpRow>, HelpContext) |
Writes the specified help rows, aligning output in columns. |
Extension Methods
| CustomizeSymbol(HelpBuilder, Symbol, String, String, String) |
Specifies custom help details for a specific symbol. |
| Write(HelpBuilder, Command, TextWriter) |
Writes help output for the specified command. |
