| HelpText Class |
Provides means to format an help screen.
You can assign it in place of a String instance.
Inheritance HierarchyNamespace: X3Platform.CommandLine.Text
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)
SyntaxThe HelpText type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HelpText |
Initializes a new instance of the HelpText class.
|
| HelpText(String) |
Initializes a new instance of the HelpText class
specifying heading string.
|
| HelpText(BaseSentenceBuilder) |
Initializes a new instance of the HelpText class
specifying the sentence builder.
|
| HelpText(String, String) |
Initializes a new instance of the HelpText class
specifying heading and copyright strings.
|
| HelpText(BaseSentenceBuilder, String) |
Initializes a new instance of the HelpText class
specifying the sentence builder and heading string.
|
| HelpText(String, String, Object) |
Initializes a new instance of the HelpText class
specifying heading and copyright strings.
|
| HelpText(BaseSentenceBuilder, String, String) |
Initializes a new instance of the HelpText class
specifying heading and copyright strings.
|
| HelpText(BaseSentenceBuilder, String, String, Object) |
Initializes a new instance of the HelpText class
specifying heading and copyright strings.
|
Methods| Name | Description | |
|---|---|---|
| AddOptions(Object) |
Adds a text block with options usage string.
|
| AddOptions(Object, String) |
Adds a text block with options usage string.
|
| AddOptions(Object, String, Int32) |
Adds a text block with options usage string.
|
| AddPostOptionsLine |
Adds a text line at the bottom, after options usage string.
|
| AddPreOptionsLine |
Adds a text line after copyright and before options usage strings.
|
 | AutoBuild(Object) |
Creates a new instance of the HelpText class using common defaults.
|
| AutoBuild(Object, String) |
Creates a new instance of the HelpText class using common defaults,
for verb commands scenario.
|
| AutoBuild(Object, ActionHelpText, Boolean) |
Creates a new instance of the HelpText class using common defaults.
|
| DefaultParsingErrorsHandler |
Supplies a default parsing error handler implementation.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| OnFormatOptionHelpText |
The OnFormatOptionHelpText method also allows derived classes to handle the event without attaching a delegate.
This is the preferred technique for handling the event in a derived class.
|
| RenderParsingErrorsText |
Builds a string that contains a parsing error message.
|
| ToString |
Returns the help screen as a String.
(Overrides ObjectToString.) |
Operators| Name | Description | |
|---|---|---|
 | (HelpText to String) |
Converts the help instance to a String.
|
Properties| Name | Description | |
|---|---|---|
 | AddDashesToOption |
Gets or sets a value indicating whether the format of options should contain dashes.
It modifies behavior of AddOptions(Object) method.
|
| AdditionalNewLineAfterOption |
Gets or sets a value indicating whether to add an additional line after the description of the option.
|
| Copyright |
Gets or sets the copyright string.
You can directly assign a CopyrightInfo instance.
|
| Heading |
Gets or sets the heading string.
You can directly assign a HeadingInfo instance.
|
| MaximumDisplayWidth |
Gets or sets the maximum width of the display. This determines word wrap when displaying the text.
|
| SentenceBuilder |
Gets the BaseSentenceBuilder instance specified in constructor.
|
Events| Name | Description | |
|---|---|---|
 | FormatOptionHelpText |
Occurs when an option help text is formatted.
|
See Also