WriteUsageOptionsAliasFormat Property |
Gets or sets the format string to use to display the alias of an argument that only has one alias.
Namespace:
Ookii.CommandLine
Assembly:
Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0
Syntaxpublic string AliasFormat { get; set; }
Public Property AliasFormat As String
Get
Set
Dim instance As WriteUsageOptions
Dim value As String
value = instance.AliasFormat
instance.AliasFormat = value
public:
property String^ AliasFormat {
String^ get ();
void set (String^ value);
}
Property Value
Type:
String
The format string for the alias of an argument; the default value is " Alias: {0}." (note the leading space).
Remarks
The format specified by this property is used for an argument that has exactly one alias. Aliases
are only added to the description if the IncludeAliasInDescription property is
.
This format string can have one placeholder, which will be set to the alias preceded by the primary argument name prefix.
To modify the placement of the alias in the description of an argument, use the ArgumentDescriptionFormat property.
Setting this property to will revert it to its default value.
See Also