CommandLineArgument Class

Provides information about command line arguments that are recognized by a CommandLineParser.

Inheritance Hierarchy

SystemObject
Ookii.CommandLineCommandLineArgument

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.4.0

Syntax

C++

Copy

public sealed class CommandLineArgument

Public NotInheritable Class CommandLineArgument

Dim instance As CommandLineArgument

public ref class CommandLineArgument sealed

The CommandLineArgument type exposes the following members.

Properties

	Name	Description
	Aliases	Gets the alternative names for this command line argument.
	AllowNull	Gets a value that indicates whether or not this argument accepts values.
	AllowsDuplicateDictionaryKeys	Gets a value indicating whether this argument, if it is a dictionary argument, allows duplicate keys.
	ArgumentName	Gets the name of this argument.
	ArgumentType	Gets the type of the argument.
	CancelParsing	Gets a value that indicates whether argument parsing should be cancelled if this argument is encountered.
	DefaultValue	Gets the default value for an argument.
	Description	Gets the description of the argument.
	ElementType	Gets the element type of the argument.
	HasValue	Gets a value indicating whether the value of this argument was supplied on the command line in the last call to Parse(String, Int32).
	IsDictionary	Gets a value indicating whether this argument is a dictionary argument.
	IsMultiValue	Gets a value indicating whether this argument is a multi-value argument.
	IsRequired	Gets a value that indicates whether the argument is required.
	IsSwitch	Gets a value indicating whether this argument is a switch argument.
	KeyValueSeparator	Gets the separator for key/value pairs if this argument is a dictionary argument.
	MemberName	Gets the name of the property or constructor parameter that defined this command line argument.
	MultiValueSeparator	Gets the separator for the values if this argument is a multi-value argument
	Position	Gets the position of this argument.
	UsedArgumentName	Gets the name or alias that was used on the command line to specify this argument.
	Value	Gets the value that the argument was set to in the last call to Parse(String, Int32).
	ValueDescription	Gets the description of the property's value to use when printing usage information.

Top

Methods

	Name	Description
	ConvertToArgumentType	Converts the specified string to the argument type, as specified in the ArgumentType property.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current CommandLineArgument. (Overrides ObjectToString.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

Ookii.CommandLine Namespace