Click or drag to resize

WriteUsageOptionsValueDescriptionFormat Property

Gets or sets the format string to use for the value description of an argument.

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

Property Value

Type: String
The format string to use for the value description of an argument; the default value is "<{0}>".
Remarks

The value description of an argument is used in the command line syntax in the usage help. For example, the usage for an argument might look like "-sample <String>". In this example, "String" is the value description, and that it is surrounded by angle brackets is the default value of the ValueDescriptionFormat property.

This format string should have one placeholder, which is used for the value description of the argument.

Setting this property to will revert it to its default value.

See Also