| HelpVerbOptionAttribute 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 that accepts and returns a String.
Inheritance HierarchySystemObject
SystemAttribute
X3Platform.CommandLineBaseOptionAttribute
X3Platform.CommandLineHelpVerbOptionAttribute
SystemAttribute
X3Platform.CommandLineBaseOptionAttribute
X3Platform.CommandLineHelpVerbOptionAttribute
Namespace: X3Platform.CommandLine
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)
SyntaxThe HelpVerbOptionAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HelpVerbOptionAttribute |
Initializes a new instance of the HelpVerbOptionAttribute class.
Although it is possible, it is strongly discouraged redefine the long name for this option
not to disorient your users.
|
| HelpVerbOptionAttribute(String) |
Initializes a new instance of the HelpVerbOptionAttribute class
with the specified long name. Use parameter less constructor instead.
|
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 |
Help verb command like ordinary help option cannot be mandatory by design.
(Overrides BaseOptionAttributeRequired.) |
| ShortName |
Help verb command do not support short name by design.
(Overrides BaseOptionAttributeShortName.) |
| TypeId | (Inherited from Attribute.) |
See Also