DotArgs.CollectionArgument Class Reference

An option that can take multiple values. More...

Inheritance diagram for DotArgs.CollectionArgument:

Public Member Functions
	CollectionArgument (bool required=false)
	Initializes a new instance of the CollectionArgument class. More...
override object	GetValue ()
	Gets the value of this argument. More...
override void	Reset ()
	Resets this argument. More...
override void	SetValue (object value)
	Sets the value for this argument. More...
	CollectionArgument (bool required=false)
	Initializes a new instance of the CollectionArgument class. More...
override object	GetValue ()
	Gets the value of this argument. More...
override void	Reset ()
	Resets this argument. More...
override void	SetValue (object value)
	Sets the value for this argument. More...
	CollectionArgument (bool required=false)
	Initializes a new instance of the CollectionArgument class. More...
override object	GetValue ()
	Gets the value of this argument. More...
override void	Reset ()
	Resets this argument. More...
override 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

An option that can take multiple values.

Constructor & Destructor Documentation

CollectionArgument() [1/3]

DotArgs.CollectionArgument.CollectionArgument

(

bool

required = false

)

Initializes a new instance of the CollectionArgument class.

Parameters

required

Flag indicating whether this argument is required.

            : base( null, required )
        {
            SupportsMultipleValues = true;
            HelpPlaceholder = "COLLECTION";
            base.SetValue( new string[0] );
        }

CollectionArgument() [2/3]

DotArgs.CollectionArgument.CollectionArgument

(

bool

required = false

)

Initializes a new instance of the CollectionArgument class.

Parameters

required

Flag indicating whether this argument is required.

            : base( null, required )
        {
            SupportsMultipleValues = true;
            HelpPlaceholder = "COLLECTION";
            base.SetValue( new string[0] );
        }

CollectionArgument() [3/3]

DotArgs.CollectionArgument.CollectionArgument

(

bool

required = false

)

Initializes a new instance of the CollectionArgument class.

Parameters

required

Flag indicating whether this argument is required.

            : base( null, required )
        {
            SupportsMultipleValues = true;
            HelpPlaceholder = "COLLECTION";
            base.SetValue( new string[0] );
        }

Member Function Documentation

GetValue() [1/3]

override object DotArgs.CollectionArgument.GetValue ( )

virtual

Gets the value of this argument.

Returns

The argument's value.

Reimplemented from DotArgs.Argument.

        {
            return Values.ToArray();
        }

GetValue() [2/3]

override object DotArgs.CollectionArgument.GetValue ( )

virtual

Gets the value of this argument.

Returns

The argument's value.

Reimplemented from DotArgs.Argument.

        {
            return Values.ToArray();
        }

GetValue() [3/3]

override object DotArgs.CollectionArgument.GetValue ( )

virtual

Gets the value of this argument.

Returns

The argument's value.

Reimplemented from DotArgs.Argument.

        {
            return Values.ToArray();
        }

Reset() [1/3]

override void DotArgs.CollectionArgument.Reset ( )

virtual

Resets this argument.

Reimplemented from DotArgs.Argument.

        {
            Values.Clear();
        }

Reset() [2/3]

override void DotArgs.CollectionArgument.Reset ( )

virtual

Resets this argument.

Reimplemented from DotArgs.Argument.

        {
            Values.Clear();
        }

Reset() [3/3]

override void DotArgs.CollectionArgument.Reset ( )

virtual

Resets this argument.

Reimplemented from DotArgs.Argument.

        {
            Values.Clear();
        }

SetValue() [1/3]

override void DotArgs.CollectionArgument.SetValue ( object  value )

virtual

Sets the value for this argument.

Parameters

value

The value to set.

Reimplemented from DotArgs.Argument.

        {
            Values.Add( value as string );
        }

SetValue() [2/3]

override void DotArgs.CollectionArgument.SetValue ( object  value )

virtual

Sets the value for this argument.

Parameters

value

The value to set.

Reimplemented from DotArgs.Argument.

        {
            Values.Add( value as string );
        }

SetValue() [3/3]

override void DotArgs.CollectionArgument.SetValue ( object  value )

virtual

Sets the value for this argument.

Parameters

value

The value to set.

Reimplemented from DotArgs.Argument.

        {
            Values.Add( value as string );
        }

Property Documentation

DefaultValue

object DotArgs.Argument.DefaultValue

getsetinherited

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

getsetinherited

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

HelpPlaceholder

string DotArgs.Argument.HelpPlaceholder

getsetinherited

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 setinherited

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

NeedsValue

bool DotArgs.Argument.NeedsValue

getprotected setinherited

Indicates whether this argument requires an explicit option.

Processor

Action< object > DotArgs.Argument.Processor

getsetinherited

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

SupportsMultipleValues

bool DotArgs.Argument.SupportsMultipleValues

getprotected setinherited

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

Validator

Func< object, bool > DotArgs.Argument.Validator

getsetinherited

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