GeneratedArgument Class

Represents information about an argument determined by the source generator.

Definition

Namespace: Ookii.CommandLine.Support
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public class GeneratedArgument : CommandLineArgument
Inheritance
Object    CommandLineArgument    GeneratedArgument

Remarks

This class is used by the source generator when using the GeneratedParserAttribute attribute. It should not normally be used by other code.

Properties

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

Methods

CallMethod When implemented in a derived class, calls the method that defined the property.
(Overrides CommandLineArgumentCallMethod(Object))
ConvertToArgumentType Converts the specified string to the ElementType.
(Inherited from CommandLineArgument)
ConvertToArgumentTypeInvariant Converts any type to the argument's ElementType.
(Inherited from CommandLineArgument)
Create Creates a GeneratedArgument instance.
DetermineValueDescriptionForType Determines the value description if one wasn't explicitly given.
(Overrides CommandLineArgumentDetermineValueDescriptionForType(Type))
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.
(Overrides CommandLineArgumentGetProperty(Object))
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.
(Overrides CommandLineArgumentSetProperty(Object, Object))
ToString Returns a String that represents the current CommandLineArgument.
(Inherited from CommandLineArgument)

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