UsageWriterWriteUsageSyntaxPrefix Method

Write the prefix for the usage syntax, including the executable name and, for subcommands, the command name.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
protected virtual void WriteUsageSyntaxPrefix()

Remarks

The base implementation returns a string like "Usage: executable" or "Usage: executable command". If color is enabled, part of the string will be colored using the UsagePrefixColor property.

An implementation of this method should typically include the value of the ExecutableName property, and the value of the CommandName property if it is not .

This method is called by the base implementation of the WriteParserUsageSyntax method and the WriteCommandListUsageSyntax method.

See Also