CommandLine.Text.HeadingInfo Class Reference

Models the heading part of an help text. You can assign it where you assign any System.String instance. More...

Public Member Functions
	HeadingInfo (string programName, string version=null)
	Initializes a new instance of the CommandLine.Text.HeadingInfo class specifying program name and version.
override string	ToString ()
	Returns the heading as a System.String.
void	WriteMessage (string message, TextWriter writer)
	Writes out a string and a new line using the program name specified in the constructor and message parameter.
void	WriteMessage (string message)
	Writes out a string and a new line using the program name specified in the constructor and message parameter to standard output stream.
void	WriteError (string message)
	Writes out a string and a new line using the program name specified in the constructor and message parameter to standard error stream.

Static Public Member Functions
static implicit	operator string (HeadingInfo info)
	Converts the heading to a System.String.

Properties
static HeadingInfo	Empty [get]
	An empty object used for initialization.
static HeadingInfo	Default [get]
	Gets the default heading instance. The title is retrieved from AssemblyTitleAttribute, or the assembly short name if its not defined. The version is retrieved from AssemblyInformationalVersionAttribute, or the assembly version if its not defined.

Private Attributes
readonly string	programName
readonly string	version

Detailed Description

Models the heading part of an help text. You can assign it where you assign any System.String instance.

Definition at line 18 of file HeadingInfo.cs.

Constructor & Destructor Documentation

HeadingInfo()

CommandLine.Text.HeadingInfo.HeadingInfo	(	string	programName,
		string	version = null
	)

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

Parameters

programName	The name of the program.
version	The version of the program.

Exceptions

System.ArgumentException

Thrown when parameter programName is null or empty string.

Definition at line 33 of file HeadingInfo.cs.

        {
            if (string.IsNullOrWhiteSpace("programName"))
            {
                throw new ArgumentException("programName");
            }
 
            this.programName = programName;
            this.version = version;
        }

Member Function Documentation

operator string()

static implicit CommandLine.Text.HeadingInfo.operator string ( HeadingInfo  info )

static

Converts the heading to a System.String.

Parameters

info	This CommandLine.Text.HeadingInfo instance.

Returns

The System.String that contains the heading.

Definition at line 80 of file HeadingInfo.cs.

        {
            return info.ToString();
        }

ToString()

override string CommandLine.Text.HeadingInfo.ToString

(

)

Returns the heading as a System.String.

Returns

The System.String that contains the heading.

Definition at line 89 of file HeadingInfo.cs.

        {
            bool isVersionNull = string.IsNullOrEmpty(version);
 
            return new StringBuilder(programName.Length +
                                     (!isVersionNull ? version.Length + 1 : 0)
                                    )
                   .Append(programName)
                   .AppendWhen(!isVersionNull, " ", version)
                   .ToString();
        }

WriteError()

void CommandLine.Text.HeadingInfo.WriteError

(

string

message

)

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

Parameters

message

The System.String message to write.

Exceptions

System.ArgumentException

Thrown when parameter message is null or empty string.

Definition at line 146 of file HeadingInfo.cs.

        {
            WriteMessage(message, Console.Error);
        }

WriteMessage() [1/2]

void CommandLine.Text.HeadingInfo.WriteMessage

(

string

message

)

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

Parameters

message

The System.String message to write.

Exceptions

System.ArgumentException

Thrown when parameter message is null or empty string.

Definition at line 135 of file HeadingInfo.cs.

        {
            WriteMessage(message, Console.Out);
        }

WriteMessage() [2/2]

void CommandLine.Text.HeadingInfo.WriteMessage	(	string	message,
		TextWriter	writer
	)

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

Parameters

message	The System.String message to write.
writer	The target System.IO.TextWriter derived type.

Exceptions

System.ArgumentException	Thrown when parameter message is null or empty string.
System.ArgumentNullException	Thrown when parameter writer is null.

Definition at line 109 of file HeadingInfo.cs.

        {
            if (string.IsNullOrWhiteSpace("message"))
            {
                throw new ArgumentException("message");
            }
 
            if (writer == null)
            {
                throw new ArgumentNullException("writer");
            }
 
            writer.WriteLine(new StringBuilder(programName.Length + message.Length + 2)
                             .Append(programName)
                             .Append(": ")
                             .Append(message)
                             .ToString()
                            );
        }

Member Data Documentation

programName

readonly string CommandLine.Text.HeadingInfo.programName

private

Definition at line 20 of file HeadingInfo.cs.

version

readonly string CommandLine.Text.HeadingInfo.version

private

Definition at line 21 of file HeadingInfo.cs.

Property Documentation

Default

HeadingInfo CommandLine.Text.HeadingInfo.Default

staticget

Gets the default heading instance. The title is retrieved from AssemblyTitleAttribute, or the assembly short name if its not defined. The version is retrieved from AssemblyInformationalVersionAttribute, or the assembly version if its not defined.

Definition at line 56 of file HeadingInfo.cs.

        {
            get
            {
                string title = ReflectionHelper.GetAttribute<AssemblyTitleAttribute>()
                                               .MapValueOrDefault(titleAttribute => titleAttribute.Title,
                                                                  ReflectionHelper.GetAssemblyName()
                                                                 );
 
                string version = ReflectionHelper.GetAttribute<AssemblyInformationalVersionAttribute>()
                                                 .MapValueOrDefault(versionAttribute =>
                                                                        versionAttribute.InformationalVersion,
                                                                    ReflectionHelper.GetAssemblyVersion()
                                                                   );
 
                return new HeadingInfo(title, version);
            }
        }

Empty

HeadingInfo CommandLine.Text.HeadingInfo.Empty

staticget

An empty object used for initialization.

Definition at line 47 of file HeadingInfo.cs.

---

The documentation for this class was generated from the following file:

• deps/commandlineparser/src/CommandLine/Text/HeadingInfo.cs