Click or drag to resize

CommandLineArgumentValueDescription Property

Gets the description of the property's value to use when printing usage information.

Namespace:  Ookii.CommandLine
Assembly:  Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0
Syntax
public string ValueDescription { get; }

Property Value

Type: String
The description of the value.
Remarks

The 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 property is used. If the type is an array type, the array's element type is used. If the type is a nullable type, its 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 Note
This is not the long description used to describe the purpose of the argument. That can be retrieved using the Description property.
See Also