CreateShellCommandOptionsCommandDescriptionFormat Property |
Gets or sets the format string used to format a command's name and description.
Namespace:
Ookii.CommandLine
Assembly:
Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0
Syntaxpublic string CommandDescriptionFormat { get; set; }
Public Property CommandDescriptionFormat As String
Get
Set
Dim instance As CreateShellCommandOptions
Dim value As String
value = instance.CommandDescriptionFormat
instance.CommandDescriptionFormat = value
public:
property String^ CommandDescriptionFormat {
String^ get ();
void set (String^ value);
}
Property Value
Type:
String
The format string used to format a command's name and description. The default value is " {0}\n{1}\n".
Remarks
This format string should have two placeholders, which are used for command's name and description respectively. If the
format ends in a line break, the commands will be separated by a blank line (this is the default).
If you change the description format, you should also change the value of the CommandDescriptionIndent
to an appropriate value. The default format uses an indentation of 8 characters.
See Also