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.4.0
SyntaxThe ValueDescriptionAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ValueDescriptionAttribute |
Initializes a new instance of the ValueDescriptionAttribute class.
|
Properties| Name | Description | |
|---|---|---|
 | TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| ValueDescription |
Gets the custom value description.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
| Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
| ToString | Returns a string that represents the current object. (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