| HelpOptionAttribute Class |
Indicates the instance method that must be invoked when it becomes necessary show your help screen.
The method signature is an instance method with no parameters and String
return value.
Inheritance HierarchySystemObject
SystemAttribute
X3Platform.CommandLineBaseOptionAttribute
X3Platform.CommandLineHelpOptionAttribute
SystemAttribute
X3Platform.CommandLineBaseOptionAttribute
X3Platform.CommandLineHelpOptionAttribute
Namespace: X3Platform.CommandLine
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)
SyntaxThe HelpOptionAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HelpOptionAttribute |
Initializes a new instance of the HelpOptionAttribute class.
Although it is possible, it is strongly discouraged redefine the long name for this option
not to disorient your users. It is also recommended not to define a short one.
|
| HelpOptionAttribute(Char) |
Initializes a new instance of the HelpOptionAttribute class
with the specified short name. Use parameter less constructor instead.
|
| HelpOptionAttribute(String) |
Initializes a new instance of the HelpOptionAttribute class
with the specified long name. Use parameter less constructor instead.
|
| HelpOptionAttribute(Char, String) |
Initializes a new instance of the HelpOptionAttribute class.
Allows you to define short and long option names.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Attribute.) |
| GetHashCode | (Inherited from Attribute.) |
| GetType | (Inherited from Object.) |
| IsDefaultAttribute | (Inherited from Attribute.) |
| Match | (Inherited from Attribute.) |
| ToString | (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | DefaultValue |
Gets or sets mapped property default value.
(Inherited from BaseOptionAttribute.) |
| HelpText |
Gets or sets a short description of this command line option. Usually a sentence summary.
(Inherited from BaseOptionAttribute.) |
| LongName |
Gets long name of this command line option. This name is usually a single english word.
(Inherited from BaseOptionAttribute.) |
| MetaValue |
Gets or sets mapped property meta value.
(Inherited from BaseOptionAttribute.) |
| MutuallyExclusiveSet |
Gets or sets the option's mutually exclusive set.
(Inherited from BaseOptionAttribute.) |
| Required |
Returns always false for this kind of option.
This behaviour can't be changed by design; if you try set Required
an InvalidOperationException will be thrown.
(Overrides BaseOptionAttributeRequired.) |
| ShortName |
Gets a short name of this command line option. You can use only one character.
(Inherited from BaseOptionAttribute.) |
| TypeId | (Inherited from Attribute.) |
See Also