WriteUsageOptions Class

Options for the WriteUsage(TextWriter, Int32, WriteUsageOptions) method.

Inheritance Hierarchy

SystemObject
Ookii.CommandLineWriteUsageOptions

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0

Syntax

C++

Copy

public sealed class WriteUsageOptions

Public NotInheritable Class WriteUsageOptions

Dim instance As WriteUsageOptions

public ref class WriteUsageOptions sealed

The WriteUsageOptions type exposes the following members.

Constructors

	Name	Description
	WriteUsageOptions	Initializes a new instance of the WriteUsageOptions class.

Top

Properties

	Name	Description
	AliasesFormat	Gets or sets the format string to use to display the alias of an argument that only has one alias.
	AliasFormat	Gets or sets the format string to use to display the alias of an argument that only has one alias.
	ArgumentDescriptionFormat	Gets or sets the format string to use for the description of an argument.
	ArgumentDescriptionIndent	Gets or sets the number of characters by which to indent the all but the first line of argument descriptions.
	ArraySuffix	Gets or sets the suffix to append to the name of an array argument.
	DefaultValueFormat	Gets or sets the format string to use to display the alias of an argument that only has one alias.
	IncludeAliasInDescription	Gets or sets a value indicating whether the alias or aliases of an argument should be included in the argument description..
	IncludeApplicationDescription	Gets or sets a value indicating whether the value of the Description property is written before the syntax.
	IncludeDefaultValueInDescription	Gets or sets a value indicating whether the default value of an argument should be included in the argument description.
	Indent	Gets or sets the number of characters by which to indent all except the first line of the command line syntax of the usage help.
	OptionalArgumentFormat	Gets or sets the format string to use for optional arguments and optional argument names.
	UsagePrefix	Gets or sets the prefix to use for the argument syntax; typically this contains the executable name.
	UseWhiteSpaceValueSeparator	Gets or sets a value indicating whether white space, rather than a colon, is used to separate named arguments and their values in the command line syntax.
	ValueDescriptionFormat	Gets or sets the format string to use for the value description of an argument.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Reference

Ookii.CommandLine Namespace