DotArgs.Argument Class Reference

Base class for an argument that can be registered with a CommandLineArgs . More...

Inheritance diagram for DotArgs.Argument:

Public Member Functions
	Argument (object defaultValue, bool required=false)
	Initializes a new instance of the Argument class. More...
virtual object	GetValue ()
	Gets the value of this argument. More...
virtual void	Reset ()
	Resets this argument. More...
virtual void	SetValue (object value)
	Sets the value for this argument. More...
	Argument (object defaultValue, bool required=false)
	Initializes a new instance of the Argument class. More...
virtual object	GetValue ()
	Gets the value of this argument. More...
virtual void	Reset ()
	Resets this argument. More...
virtual void	SetValue (object value)
	Sets the value for this argument. More...
	Argument (object defaultValue, bool required=false)
	Initializes a new instance of the Argument class. More...
virtual object	GetValue ()
	Gets the value of this argument. More...
virtual void	Reset ()
	Resets this argument. More...
virtual void	SetValue (object value)
	Sets the value for this argument. More...

Properties
object	DefaultValue [get, set]
	The default value that will be used if no value was passed on the command line. More...
string	HelpMessage [get, set]
	The message that will be displayed in the help page for your program. More...
string	HelpPlaceholder [get, set]
	Value that will be shown (in upper case) in the usage page for this argument. Setting this to null will display the default value (i.e. OPTION, COLLECTION, etc.). More...
bool	IsRequired [get, protected set]
	Flag indicating whether this argument is required, i.e. must be provided via the command line. More...
bool	NeedsValue [get, protected set]
	Indicates whether this argument requires an explicit option. More...
Action< object >	Processor [get, set]
	A method that can be executed when the command line arguments are processed. More...
bool	SupportsMultipleValues [get, protected set]
	Flag indicating whether multplie calls to SetValue will add a value or overwrite the existing one. More...
Func< object, bool >	Validator [get, set]
	A method that can be used to validate a value for this argument. More...

Detailed Description

Base class for an argument that can be registered with a CommandLineArgs .

Constructor & Destructor Documentation

Argument() [1/3]

DotArgs.Argument.Argument	(	object	defaultValue,
		bool	required = false
	)

Initializes a new instance of the Argument class.

Parameters

defaultValue	The default value.
required	Flag indicating whether this argument is required.

        {
            DefaultValue = defaultValue;
            IsRequired = required;
            SupportsMultipleValues = false;

            if( IsRequired )
            {
                DefaultValue = null;
            }
        }

Argument() [2/3]

DotArgs.Argument.Argument	(	object	defaultValue,
		bool	required = false
	)

Initializes a new instance of the Argument class.

Parameters

defaultValue	The default value.
required	Flag indicating whether this argument is required.

        {
            DefaultValue = defaultValue;
            IsRequired = required;
            SupportsMultipleValues = false;

            if( IsRequired )
            {
                DefaultValue = null;
            }
        }

Argument() [3/3]

DotArgs.Argument.Argument	(	object	defaultValue,
		bool	required = false
	)

Initializes a new instance of the Argument class.

Parameters

defaultValue	The default value.
required	Flag indicating whether this argument is required.

        {
            DefaultValue = defaultValue;
            IsRequired = required;
            SupportsMultipleValues = false;

            if( IsRequired )
            {
                DefaultValue = null;
            }
        }

Member Function Documentation

GetValue() [1/3]

virtual object DotArgs.Argument.GetValue ( )

virtual

Gets the value of this argument.

Returns

The argument's value.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.AliasArgument, DotArgs.AliasArgument, and DotArgs.AliasArgument.

        {
            return Value;
        }

GetValue() [2/3]

virtual object DotArgs.Argument.GetValue ( )

virtual

Gets the value of this argument.

Returns

The argument's value.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.AliasArgument, DotArgs.AliasArgument, and DotArgs.AliasArgument.

        {
            return Value;
        }

GetValue() [3/3]

virtual object DotArgs.Argument.GetValue ( )

virtual

Gets the value of this argument.

Returns

The argument's value.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.AliasArgument, DotArgs.AliasArgument, and DotArgs.AliasArgument.

        {
            return Value;
        }

Reset() [1/3]

virtual void DotArgs.Argument.Reset ( )

virtual

Resets this argument.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, and DotArgs.CollectionArgument.

        {
            Value = DefaultValue;
        }

Reset() [2/3]

virtual void DotArgs.Argument.Reset ( )

virtual

Resets this argument.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, and DotArgs.CollectionArgument.

        {
            Value = DefaultValue;
        }

Reset() [3/3]

virtual void DotArgs.Argument.Reset ( )

virtual

Resets this argument.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, and DotArgs.CollectionArgument.

        {
            Value = DefaultValue;
        }

SetValue() [1/3]

virtual void DotArgs.Argument.SetValue ( object  value )

virtual

Sets the value for this argument.

Parameters

value

The value to set.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.AliasArgument, DotArgs.AliasArgument, and DotArgs.AliasArgument.

        {
            Value = value;
        }

SetValue() [2/3]

virtual void DotArgs.Argument.SetValue ( object  value )

virtual

Sets the value for this argument.

Parameters

value

The value to set.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.AliasArgument, DotArgs.AliasArgument, and DotArgs.AliasArgument.

        {
            Value = value;
        }

SetValue() [3/3]

virtual void DotArgs.Argument.SetValue ( object  value )

virtual

Sets the value for this argument.

Parameters

value

The value to set.

Reimplemented in DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.CollectionArgument, DotArgs.AliasArgument, DotArgs.AliasArgument, and DotArgs.AliasArgument.

        {
            Value = value;
        }

Property Documentation

DefaultValue

object DotArgs.Argument.DefaultValue

getset

The default value that will be used if no value was passed on the command line.

Using this when IsRequired is set will have no effect.

HelpMessage

string DotArgs.Argument.HelpMessage

getset

The message that will be displayed in the help page for your program.

HelpPlaceholder

string DotArgs.Argument.HelpPlaceholder

getset

Value that will be shown (in upper case) in the usage page for this argument. Setting this to null will display the default value (i.e. OPTION, COLLECTION, etc.).

IsRequired

bool DotArgs.Argument.IsRequired

getprotected set

Flag indicating whether this argument is required, i.e. must be provided via the command line.

NeedsValue

bool DotArgs.Argument.NeedsValue

getprotected set

Indicates whether this argument requires an explicit option.

Processor

Action< object > DotArgs.Argument.Processor

getset

A method that can be executed when the command line arguments are processed.

SupportsMultipleValues

bool DotArgs.Argument.SupportsMultipleValues

getprotected set

Flag indicating whether multplie calls to SetValue will add a value or overwrite the existing one.

Validator

Func< object, bool > DotArgs.Argument.Validator

getset

A method that can be used to validate a value for this argument.

---

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

• src/packages/DotArgs.1.0.0/content/CommandLineArgs.cs