ValueDescriptionAttribute Class |
Provides a custom value description for use in the usage help for an argument created from a constructor parameter.
Inheritance HierarchyNamespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0
SyntaxThe ValueDescriptionAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ValueDescriptionAttribute |
Initializes a new instance of the ValueDescriptionAttribute class.
|
Properties| Name | Description | |
|---|---|---|
 | TypeId | (Inherited from Attribute.) |
| ValueDescription |
Gets the custom value description.
|
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.) |
RemarksThe value description is a short (typically one word) description that indicates the type of value that the user should supply. By default the type of the parameter is used. If the type is an array type, the array's element type is used. If the type is a nullable type, the nullable type's underlying type is used.
The value description is used when printing usage. For example, the usage for an argument named Sample with a value description of String would look like "-Sample <String>".
 Note |
|---|
| This is not the long description used to describe the purpose of the argument. That should be specified using the DescriptionAttribute attribute. |
See Also