C# Class CommandLine.Text.HeadingInfo

Models the heading part of an help text. You can assign it where you assign any System.String instance.
Show file Open project: ErikEJ/SqlQueryStress Class Usage Examples

Public Methods

Method Description
HeadingInfo ( string programName ) : System.IO

Initializes a new instance of the CommandLine.Text.HeadingInfo class specifying program name.

HeadingInfo ( string programName, string version ) : System.IO

Initializes a new instance of the CommandLine.Text.HeadingInfo class specifying program name and version.

ToString ( ) : string

Returns the heading informations as a System.String.

WriteError ( string message ) : void

Writes out a string and a new line using the program name specified in the constructor and message parameter to standard error stream.

WriteMessage ( string message ) : void

Writes out a string and a new line using the program name specified in the constructor and message parameter to standard output stream.

WriteMessage ( string message, TextWriter writer ) : void

Writes out a string and a new line using the program name specified in the constructor and message parameter.

Method Details

HeadingInfo() public method

Initializes a new instance of the CommandLine.Text.HeadingInfo class specifying program name.
Thrown when parameter is null or empty string.
public HeadingInfo ( string programName ) : System.IO
programName string The name of the program.
return System.IO

HeadingInfo() public method

Initializes a new instance of the CommandLine.Text.HeadingInfo class specifying program name and version.
Thrown when parameter is null or empty string.
public HeadingInfo ( string programName, string version ) : System.IO
programName string The name of the program.
version string The version of the program.
return System.IO

ToString() public method

Returns the heading informations as a System.String.
public ToString ( ) : string
return string

WriteError() public method

Writes out a string and a new line using the program name specified in the constructor and message parameter to standard error stream.
Thrown when parameter is null or empty string.
public WriteError ( string message ) : void
message string The message to write.
return void

WriteMessage() public method

Writes out a string and a new line using the program name specified in the constructor and message parameter to standard output stream.
Thrown when parameter is null or empty string.
public WriteMessage ( string message ) : void
message string The message to write.
return void

WriteMessage() public method

Writes out a string and a new line using the program name specified in the constructor and message parameter.
Thrown when parameter is null or empty string. Thrown when parameter is null.
public WriteMessage ( string message, TextWriter writer ) : void
message string The message to write.
writer System.IO.TextWriter The target derived type.
return void