CommandLine.Text.CopyrightInfo Class Reference

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

Public Member Functions
	CopyrightInfo (string author, int year)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and year. More...
	CopyrightInfo (string author, params int[] years)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and copyrightYears. More...
	CopyrightInfo (bool isSymbolUpper, string author, params int[] copyrightYears)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying symbol case, author and copyrightYears. More...
override string	ToString ()
	Returns the copyright as a System.String. More...

Static Public Member Functions
static implicit	operator string (CopyrightInfo info)
	Converts the copyright instance to a System.String. More...

Protected Member Functions
	CopyrightInfo ()
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class. More...
virtual string	FormatYears (int[] years)
	When overridden in a derived class, allows to specify a new algorithm to render copyright copyrightYears as a System.String instance. More...

Properties
static CopyrightInfo	Default [get]
	Gets the default copyright information. Retrieved from AssemblyCopyrightAttribute, if it exists, otherwise it uses AssemblyCompanyAttribute as copyright holder with the current year. If neither exists it throws an InvalidOperationException. More...
virtual string	CopyrightWord [get]
	Gets a different copyright word when overridden in a derived class. More...

Detailed Description

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

Constructor & Destructor Documentation

CommandLine.Text.CopyrightInfo.CopyrightInfo ( string  author, int  year  )

inline

Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and year.

Parameters

author	The company or person holding the copyright.
year	The year of coverage of copyright.

Exceptions

System.ArgumentException

Thrown when parameter author is null or empty string.

CommandLine.Text.CopyrightInfo.CopyrightInfo ( string  author, params int[]  years  )

inline

Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and copyrightYears.

Parameters

author	The company or person holding the copyright.
years	The copyrightYears of coverage of copyright.

Exceptions

System.ArgumentException	Thrown when parameter author is null or empty string.
System.ArgumentOutOfRangeException	Thrown when parameter years is not supplied.

CommandLine.Text.CopyrightInfo.CopyrightInfo ( bool  isSymbolUpper, string  author, params int[]  copyrightYears  )

inline

Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying symbol case, author and copyrightYears.

Parameters

isSymbolUpper	The case of the copyright symbol.
author	The company or person holding the copyright.
copyrightYears	The copyrightYears of coverage of copyright.

Exceptions

System.ArgumentException	Thrown when parameter author is null or empty string.
System.ArgumentOutOfRangeException	Thrown when parameter copyrightYears is not supplied.

CommandLine.Text.CopyrightInfo.CopyrightInfo ( )

inlineprotected

Initializes a new instance of the CommandLine.Text.CopyrightInfo class.

Member Function Documentation

virtual string CommandLine.Text.CopyrightInfo.FormatYears ( int[]  years )

inlineprotectedvirtual

When overridden in a derived class, allows to specify a new algorithm to render copyright copyrightYears as a System.String instance.

Parameters

years

A System.Int32 array of copyrightYears.

Returns

A System.String instance with copyright copyrightYears.

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

inlinestatic

Converts the copyright instance to a System.String.

Parameters

info	This CommandLine.Text.CopyrightInfo instance.

Returns

The System.String that contains the copyright.

override string CommandLine.Text.CopyrightInfo.ToString ( )

inline

Returns the copyright as a System.String.

Returns

The System.String that contains the copyright.

Property Documentation

virtual string CommandLine.Text.CopyrightInfo.CopyrightWord

getprotected

Gets a different copyright word when overridden in a derived class.

CopyrightInfo CommandLine.Text.CopyrightInfo.Default

staticget

Gets the default copyright information. Retrieved from AssemblyCopyrightAttribute, if it exists, otherwise it uses AssemblyCompanyAttribute as copyright holder with the current year. If neither exists it throws an InvalidOperationException.

---

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

• src/CommandLine/Text/CopyrightInfo.cs