Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
HelpOption Class
Definition
- Namespace:
- System.CommandLine.Help
- Assembly:
- System.CommandLine.dll
- Package:
- System.CommandLine v3.0.0-preview.5.26302.115
- Source:
- HelpOption.cs
- Source:
- HelpOption.cs
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.
A standard option that indicates that command line help should be displayed.
public ref class HelpOption sealed : System::CommandLine::Optionpublic sealed class HelpOption : System.CommandLine.Optiontype HelpOption = class
inherit OptionPublic NotInheritable Class HelpOption
Inherits Option- Inheritance
Constructors
| Name | Description |
|---|---|
| HelpOption() |
When added to a Command, it configures the application to show help when one of the following options are specified on the command line: |
| HelpOption(String, String[]) |
When added to a Command, it configures the application to show help when given name or one of the aliases are specified on the command line. |
Properties
| Name | Description |
|---|---|
| Action |
Gets or sets the CommandLineAction for the Option. The handler represents the action that will be performed when the Option is invoked. |
| Aliases |
Gets the unique set of strings that can be used on the command line to specify the Option. (Inherited from Option) |
| AllowMultipleArgumentsPerToken |
Gets a value that indicates whether multiple argument tokens are allowed for each option identifier token. (Inherited from Option) |
| Arity |
Gets or sets the arity of the option. (Inherited from Option) |
| CompletionSources |
Gets the list of completion sources for the option. (Inherited from Option) |
| Description |
Gets or sets the description of the symbol. (Inherited from Symbol) |
| HasDefaultValue |
Specifies if a default value is defined for the option. (Inherited from Option) |
| HelpName |
Gets or sets the placeholder name shown in usage help for the option's value.
The value will be wrapped in angle brackets ( |
| Hidden |
Gets or sets a value indicating whether the symbol is hidden. (Inherited from Symbol) |
| Name |
Gets the name of the symbol. (Inherited from Symbol) |
| Parents |
Gets the parent symbols. (Inherited from Symbol) |
| Recursive |
When set to true, this option will be applied to its immediate parent command or commands and recursively to their subcommands. (Inherited from Option) |
| Required |
Indicates whether the option is required when its parent command is invoked. (Inherited from Option) |
| Validators |
Validators that will be called when the option is matched by the parser. (Inherited from Option) |
| ValueType | |
Methods
| Name | Description |
|---|---|
| GetCompletions(CompletionContext) |
Gets completions for the symbol. (Inherited from Option) |
| GetDefaultValue() |
Gets the default value for the option. (Inherited from Option) |
| ToString() |
Returns a string that represents the current object. (Inherited from Symbol) |
Applies to
Feedback
Was this page helpful?