CommandLine.OptionAttribute Class Reference

Models an option specification. More...

Inheritance diagram for CommandLine.OptionAttribute:

Public Member Functions
	OptionAttribute ()
	Initializes a new instance of the CommandLine.OptionAttribute class. The default long name will be inferred from target property. More...
	OptionAttribute (string longName)
	Initializes a new instance of the CommandLine.OptionAttribute class. More...
	OptionAttribute (char shortName, string longName)
	Initializes a new instance of the CommandLine.OptionAttribute class. More...
	OptionAttribute (char shortName)
	Initializes a new instance of the CommandLine.OptionAttribute class. More...

Properties
string	LongName [get]
	Gets long name of this command line option. This name is usually a single english word. More...
string	ShortName [get]
	Gets a short name of this command line option, made of one character. More...
bool	Required [get, set]
	Gets or sets a value indicating whether a command line option is required. More...
string	SetName [get, set]
	Gets or sets the option's mutually exclusive set name. More...
int	Min [get, set]
	When applied to System.Collections.Generic.IEnumerable{T} properties defines the lower range of items. More...
int	Max [get, set]
	When applied to System.Collections.Generic.IEnumerable{T} properties defines the upper range of items. More...
object	DefaultValue [get, set]
	Gets or sets mapped property default value. More...
string	HelpText [get, set]
	Gets or sets a short description of this command line option. Usually a sentence summary. More...
string	MetaValue [get, set]
	Gets or sets mapped property meta value. Usually an uppercase hint of required value type. More...

Detailed Description

Models an option specification.

Constructor & Destructor Documentation

CommandLine.OptionAttribute.OptionAttribute ( )

inline

Initializes a new instance of the CommandLine.OptionAttribute class. The default long name will be inferred from target property.

CommandLine.OptionAttribute.OptionAttribute ( string  longName )

inline

Initializes a new instance of the CommandLine.OptionAttribute class.

Parameters

longName

The long name of the option.

CommandLine.OptionAttribute.OptionAttribute ( char  shortName, string  longName  )

inline

Initializes a new instance of the CommandLine.OptionAttribute class.

Parameters

shortName	The short name of the option.
longName	The long name of the option or null if not used.

CommandLine.OptionAttribute.OptionAttribute ( char  shortName )

inline

Initializes a new instance of the CommandLine.OptionAttribute class.

Parameters

shortName

The short name of the option..

Property Documentation

object CommandLine.OptionAttribute.DefaultValue

getset

Gets or sets mapped property default value.

string CommandLine.OptionAttribute.HelpText

getset

Gets or sets a short description of this command line option. Usually a sentence summary.

string CommandLine.OptionAttribute.LongName

get

Gets long name of this command line option. This name is usually a single english word.

int CommandLine.OptionAttribute.Max

getset

When applied to System.Collections.Generic.IEnumerable{T} properties defines the upper range of items.

If not set, no upper range is enforced.

string CommandLine.OptionAttribute.MetaValue

getset

Gets or sets mapped property meta value. Usually an uppercase hint of required value type.

int CommandLine.OptionAttribute.Min

getset

When applied to System.Collections.Generic.IEnumerable{T} properties defines the lower range of items.

If not set, no lower range is enforced.

bool CommandLine.OptionAttribute.Required

getset

Gets or sets a value indicating whether a command line option is required.

string CommandLine.OptionAttribute.SetName

getset

Gets or sets the option's mutually exclusive set name.

string CommandLine.OptionAttribute.ShortName

get

Gets a short name of this command line option, made of one character.

---

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

• src/CommandLine/OptionAttribute.cs