CommandLineArgument Class

Provides information about command line arguments that are recognized by an instance of the CommandLineParser class.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
public abstract class CommandLineArgument
Inheritance
Object    CommandLineArgument
Derived

Properties

Aliases Gets the alternative names for this command line argument.
AllowNull Gets a value that indicates whether or not this argument accepts values.
ArgumentName Gets the name of this argument.
ArgumentNameWithPrefix Gets the name of this argument, with the appropriate argument name prefix.
ArgumentType Gets the type of the argument's value.
CancelParsing Gets a value that indicates whether argument parsing should be canceled if this argument is encountered.
CanSetProperty When implemented in a derived class, gets a value that indicates whether this argument is backed by a property with a public set method.
Converter Gets the converter used to convert string values to the argument's type.
DefaultValue Gets the default value for an argument.
Description Gets the description of the argument.
DictionaryInfo Gets information that only applies to dictionary arguments.
ElementType Gets the type of the elements of the argument value.
HasLongName Gets a value that indicates whether the argument has a long name.
HasShortName Gets a value that indicates whether the argument has a short name.
HasValue Gets a value indicating whether the value of this argument was supplied on the command line in the last call to CommandLineParserParse(String).
IncludeDefaultInUsageHelp Gets a value that indicates whether the default value should be included in the argument's description in the usage help.
IsHidden Gets or sets a value that indicates whether the argument is hidden from the usage help.
IsRequired Gets a value that indicates whether the argument is required.
IsRequiredProperty Gets a value that indicates whether the argument is backed by a required property.
IsSwitch Gets a value indicating whether this argument is a switch argument.
Kind Gets a value which indicates what kind of argument this instance represents.
LongNameWithPrefix Gets the long argument name with the long prefix.
MemberName Gets the name of the property or method that defined this command line argument.
MultiValueInfo Gets information that only applies to multi-value or dictionary arguments.
Parser Gets the CommandLineParser that this argument belongs to.
Position Gets the position of this argument.
ShortAliases Gets the alternative short names for this command line argument.
ShortName Gets the short name of this argument.
ShortNameWithPrefix Gets the short argument name with the primary short prefix.
UsedArgumentName Gets the name or alias that was used on the command line to specify this argument.
Validators Gets the argument validators applied to this argument.
Value Gets the value that the argument was set to in the last call to CommandLineParserParse(String).
ValueDescription Gets the short description of the argument's value to use when printing usage information.

Methods

CallMethod When implemented in a derived class, calls the method that defined the property.
ConvertToArgumentType Converts the specified string to the ElementType.
ConvertToArgumentTypeInvariant Converts any type to the argument's ElementType.
DetermineValueDescriptionForType Determines the value description if one wasn't explicitly given.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetProperty When implemented in a derived class, gets the value of the property for this argument.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetProperty When implemented in a derived class, sets the property for this argument.
ToString Returns a String that represents the current CommandLineArgument.
(Overrides ObjectToString)

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.

See Also