SnCore!

ArgumentAttribute Class Reference

Allows control of command line parsing. Attach this attribute to instance fields of types used as the destination of command line argument parsing. More...

Inheritance diagram for ArgumentAttribute:

Attribute DefaultArgumentAttribute

List of all members.


Public Member Functions

 ArgumentAttribute (ArgumentType type)
 Allows control of command line parsing.

Properties

ArgumentType Type [get]
 The error checking to be done on the argument.
bool DefaultShortName [get]
 Returns true if the argument did not have an explicit short name specified.
string ShortName [get, set]
 The short name of the argument. Set to null means use the default short name if it does not conflict with any other parameter name. Set to String.Empty for no short name. This property should not be set for DefaultArgumentAttributes.
bool DefaultLongName [get]
 Returns true if the argument did not have an explicit long name specified.
string LongName [get, set]
 The long name of the argument. Set to null means use the default long name. The long name for every argument must be unique. It is an error to specify a long name of String.Empty.
object DefaultValue [get, set]
 The default value of the argument.
bool HasDefaultValue [get]
 Returns true if the argument has a default value.
bool HasHelpText [get]
 Returns true if the argument has help text specified.
string HelpText [get, set]
 The help text for the argument.

Detailed Description

Allows control of command line parsing. Attach this attribute to instance fields of types used as the destination of command line argument parsing.


Constructor & Destructor Documentation

ArgumentAttribute ( ArgumentType  type  ) 

Allows control of command line parsing.

Parameters:
type Specifies the error checking to be done on the argument.


Property Documentation

ArgumentType Type [get]

The error checking to be done on the argument.

bool DefaultShortName [get]

Returns true if the argument did not have an explicit short name specified.

string ShortName [get, set]

The short name of the argument. Set to null means use the default short name if it does not conflict with any other parameter name. Set to String.Empty for no short name. This property should not be set for DefaultArgumentAttributes.

bool DefaultLongName [get]

Returns true if the argument did not have an explicit long name specified.

string LongName [get, set]

The long name of the argument. Set to null means use the default long name. The long name for every argument must be unique. It is an error to specify a long name of String.Empty.

object DefaultValue [get, set]

The default value of the argument.

Reimplemented from Attribute.

bool HasDefaultValue [get]

Returns true if the argument has a default value.

bool HasHelpText [get]

Returns true if the argument has help text specified.

string HelpText [get, set]

The help text for the argument.


The documentation for this class was generated from the following file:
  • CommandLineArguments.cs
© Vestris Inc., 2006-2007, All Rights Reserved | SnCore | Wed Mar 5 09:56:25 2008 | Doxygen 1.5.4