C# Class CommandLine.Text.HelpText

Models an help text and collects related informations. You can assign it in place of a System.String instance.

Public Methods

Method	Description
AddOptions ( object options ) : void	Adds a text block with options usage informations.
AddOptions ( object options, string requiredWord ) : void	Adds a text block with options usage informations.
AddPreOptionsLine ( string value ) : void	Adds a text line after copyright and before options usage informations.
HelpText ( string heading ) : System	Initializes a new instance of the CommandLine.Text.HelpText class specifying heading informations.
ToString ( ) : string	Returns the help informations as a System.String.

Method	Description
AddLine ( StringBuilder builder, string value ) : void
GetLength ( StringBuilder value ) : int
GetLength ( string value ) : int
GetMaxLength ( IList optionList ) : int
HelpText ( ) : System

Adds a text block with options usage informations.

Thrown when parameter is null.

public AddOptions ( object options ) : void
options	object	The instance that collected command line arguments parsed with class.
return	void

Adds a text block with options usage informations.

Thrown when parameter is null. Thrown when parameter is null or empty string.

public AddOptions ( object options, string requiredWord ) : void
options	object	The instance that collected command line arguments parsed with the class.
requiredWord	string	The word to use when the option is required.
return	void

Adds a text line after copyright and before options usage informations.

Thrown when parameter is null or empty string.

public AddPreOptionsLine ( string value ) : void
value	string	A instance.
return	void

Initializes a new instance of the CommandLine.Text.HelpText class specifying heading informations.

Thrown when parameter is null or empty string.

public HelpText ( string heading ) : System
heading	string	A string with heading information or /// an instance of .
return	System

Returns the help informations as a System.String.

public ToString ( ) : string
return	string