WriteUsageOptionsArgumentDescriptionFormat Property

public string ArgumentDescriptionFormat { get; set; }

Public Property ArgumentDescriptionFormat As String
	Get
	Set

Dim instance As WriteUsageOptions
Dim value As String

value = instance.ArgumentDescriptionFormat

instance.ArgumentDescriptionFormat = value

public:
property String^ ArgumentDescriptionFormat {
	String^ get ();
	void set (String^ value);
}

Property Value

This format string is used for the detailed descriptions of the arguments, which is written after the command line syntax.

The ArgumentDescriptionIndent property should be set to something appropriate for this format. For example, in the default format, the description is indented by 8 characters.

This format string can have four placeholders, which are used for the argument name, the description, the value description (formatted according to the ValueDescriptionFormat), the primary argument name prefix, the default value, and the aliases. If the format string ends in a line break, the command descriptions will be separated by a blank line (this is the default).

Placeholder {4} will be replaced with the default value of an argument, formatted according to the DefaultValueFormat property. If the IncludeDefaultValueInDescription property is set to or the property's default value is , this placeholder will be set to an empty string ("").

Placeholder {5} will be replaced with the aliases of an argument, formatted according to the AliasFormat or AliasesFormat property. If the IncludeAliasInDescription property is set to or the property has no aliases, this placeholder will be set to an empty string ("").

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

Reference