CommandLineArgumentValueDescription Property

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

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
public string ValueDescription { get; }

Property Value

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, applying the NameTransform specified by the ParseOptionsValueDescriptionTransform property or the ParseOptionsAttributeValueDescriptionTransform property. If this is a multi-value argument or the argument's type is NullableT, the ElementType is used.

The value description is used when generating usage help. 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 can be retrieved using the Description property.

See Also