CommandOptions Class

Provides options for the CommandManager class.

Definition

Namespace: Ookii.CommandLine.Commands
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public class CommandOptions : ParseOptions
Inheritance
Object    ParseOptions    CommandOptions

Constructors

CommandOptionsInitializes a new instance of the CommandOptions class

Properties

AllowWhiteSpaceValueSeparator Gets or sets a value indicating whether the value of arguments may be separated from the name by white space.
(Inherited from ParseOptions)
AllowWhiteSpaceValueSeparatorOrDefault Gets a value indicating whether the value of arguments may be separated from the name by white space.
(Inherited from ParseOptions)
ArgumentNameComparison Gets or set the type of string comparison to use for argument names.
(Inherited from ParseOptions)
ArgumentNameComparisonOrDefault Gets the type of string comparison to use for argument names.
(Inherited from ParseOptions)
ArgumentNamePrefixes Gets or sets the argument name prefixes to use when parsing the arguments.
(Inherited from ParseOptions)
ArgumentNamePrefixesOrDefault Gets the argument name prefixes to use when parsing the arguments.
(Inherited from ParseOptions)
ArgumentNameTransform Gets or sets a value that indicates how names are created for arguments that don't have an explicit name.
(Inherited from ParseOptions)
ArgumentNameTransformOrDefault Gets a value that indicates how names are created for arguments that don't have an explicit name.
(Inherited from ParseOptions)
AutoCommandPrefixAliases Gets or sets a value that indicates whether unique prefixes of a command name or alias are automatically used as aliases.
AutoHelpArgument Gets or sets a value that indicates a help argument will be automatically added.
(Inherited from ParseOptions)
AutoHelpArgumentOrDefault Gets a value that indicates a help argument will be automatically added.
(Inherited from ParseOptions)
AutoPrefixAliases Gets or sets a value that indicates whether unique prefixes of an argument are automatically used as aliases.
(Inherited from ParseOptions)
AutoPrefixAliasesOrDefault Gets a value that indicates whether unique prefixes of an argument are automatically used as aliases.
(Inherited from ParseOptions)
AutoVersionArgument Gets or sets a value that indicates a version argument will be automatically added.
(Inherited from ParseOptions)
AutoVersionArgumentOrDefault Gets a value that indicates a version argument will be automatically added.
(Inherited from ParseOptions)
AutoVersionCommand Gets or sets a value that indicates whether a version command should automatically be created.
CommandFilter Gets or sets a function that filters which commands to include.
CommandNameComparison Gets or sets the type of string comparison to use for argument names.
CommandNameTransform Gets or sets a value that indicates how names are created for commands that don't have an explicit name.
Culture Gets or sets the culture used to convert command line argument values from their string representation to the argument type.
(Inherited from ParseOptions)
DefaultValueDescriptions Gets or sets a dictionary containing default value descriptions for types.
(Inherited from ParseOptions)
DuplicateArguments Gets or sets a value indicating whether duplicate arguments are allowed.
(Inherited from ParseOptions)
DuplicateArgumentsOrDefault Gets a value indicating whether duplicate arguments are allowed.
(Inherited from ParseOptions)
Error Gets or sets the TextWriter used to print error information if argument parsing fails.
(Inherited from ParseOptions)
ErrorColor Gets or sets the color applied to error messages.
(Inherited from ParseOptions)
ForceReflection Gets or sets a value that indicates whether the CommandLineParser class will use reflection even if the command line arguments type has the GeneratedParserAttribute.
(Inherited from ParseOptions)
IsPosix Gets or sets a value that indicates whether the options follow POSIX conventions.
(Overrides ParseOptionsIsPosix)
LongArgumentNamePrefix Gets or sets the argument name prefix to use for long argument names.
(Inherited from ParseOptions)
LongArgumentNamePrefixOrDefault Gets the argument name prefix to use for long argument names.
(Inherited from ParseOptions)
Mode Gets or sets a value that indicates the command line argument parsing rules to use.
(Inherited from ParseOptions)
ModeOrDefault Gets a value that indicates the command line argument parsing rules to use.
(Inherited from ParseOptions)
NameValueSeparators Gets or sets the characters used to separate the name and the value of an argument.
(Inherited from ParseOptions)
NameValueSeparatorsOrDefault Gets the characters used to separate the name and the value of an argument.
(Inherited from ParseOptions)
ParentCommand Gets or sets the parent command to filter commands by.
PrefixTermination Gets or sets the behavior when an argument is encountered that consists of only the long argument prefix ("--" by default) by itself, not followed by a name.
(Inherited from ParseOptions)
PrefixTerminationOrDefault Gets the behavior when an argument is encountered that consists of only the long argument prefix ("--" by default) by itself, not followed by a name.
(Inherited from ParseOptions)
ShowUsageOnError Gets or sets a value that indicates how usage is shown after a parsing error occurred.
(Inherited from ParseOptions)
StringProvider Gets or sets the LocalizedStringProvider implementation to use to get strings for error messages and usage help.
(Inherited from ParseOptions)
StripCommandNameSuffix Gets or sets a value that will be removed from the end of a command name during name transformation.
UsageWriter Gets or sets the UsageWriter to use to create usage help.
(Inherited from ParseOptions)
UseErrorColor Gets or sets a value that indicates whether error messages should use color.
(Inherited from ParseOptions)
ValueDescriptionTransform Gets or sets a value that indicates how value descriptions derived from type names are transformed.
(Inherited from ParseOptions)
ValueDescriptionTransformOrDefault Gets a value that indicates how value descriptions derived from type names are transformed.
(Inherited from ParseOptions)
WarningColor Gets or sets the color applied to warning messages.
(Inherited from ParseOptions)

Methods

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)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Merge Merges the options in this instance with the options from the ParseOptionsAttribute attribute.
(Inherited from ParseOptions)
ToStringReturns a string that represents the current object.
(Inherited from Object)

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