CommandLine
This exception is thrown when a generic parsing error occurs.
Models a list of command line arguments that are not options.
Must be applied to a field compatible with an interface
of instances.
Initializes a new instance of the class.
A type that implements .
Thrown if is null.
Gets or sets the maximum element allow for the list managed by type.
If lesser than 0, no upper bound is fixed.
If equal to 0, no elements are allowed.
Indicates the instance method that must be invoked when it becomes necessary show your help screen.
The method signature is an instance method with no parameters and
return value.
Provides base properties for creating an attribute, used to define rules for command line parsing.
Short name of this command line option. You can use only one character.
Long name of this command line option. This name is usually a single english word.
True if this command line option is required.
A short description of this command line option. Usually a sentence summary.
Initializes a new instance of the class.
Initializes a new instance of the class.
Allows you to define short and long option names.
The short name of the option or null if not used.
The long name of the option or null if not used.
Returns always false for this kind of option.
This behaviour can't be changed by design; if you try set
an will be thrown.
Models an option specification.
Initializes a new instance of the class.
The short name of the option or null if not used.
The long name of the option or null if not used.
Gets or sets the option's mutually exclusive set.
Models an option that can accept multiple values.
Must be applied to a field compatible with an interface
of instances.
Initializes a new instance of the class.
The short name of the option or null if not used.
The long name of the option or null if not used.
Initializes a new instance of the class.
The short name of the option or null if not used.
The long name of the option or null if not used.
Values separator character.
Gets or sets the values separator character.
Models the copyright informations part of an help text.
You can assign it where you assign any instance.
Initializes a new instance of the class.
Initializes a new instance of the class
specifying author and year.
The company or person holding the copyright.
The year of coverage of copyright.
Thrown when parameter is null or empty string.
Initializes a new instance of the class
specifying author and years.
The company or person holding the copyright.
The years of coverage of copyright.
Thrown when parameter is null or empty string.
Thrown when parameter is not supplied.
Initializes a new instance of the class
specifying symbol case, author and years.
The case of the copyright symbol.
The company or person holding the copyright.
The years of coverage of copyright.
Thrown when parameter is null or empty string.
Thrown when parameter is not supplied.
Returns the copyright informations as a .
The that contains the copyright informations.
Converts the copyright informations to a .
This instance.
The that contains the copyright informations.
When overridden in a derived class, allows to specify a new algorithm to render copyright years
as a instance.
A array of years.
A instance with copyright years.
When overridden in a derived class, allows to specify a different copyright word.
Defines a basic interface to parse command line arguments.
Parses a array of command line arguments, setting values in
parameter instance's public fields decorated with appropriate attributes.
A array of command line arguments.
An object's instance used to receive values.
Parsing rules are defined using derived types.
True if parsing process succeed.
Thrown if is null.
Thrown if is null.
Parses a array of command line arguments, setting values in
parameter instance's public fields decorated with appropriate attributes.
This overload allows you to specify a derived instance for write text messages.
A array of command line arguments.
An object's instance used to receive values.
Parsing rules are defined using derived types.
Any instance derived from ,
usually . Setting this argument to null, will disable help screen.
True if parsing process succeed.
Thrown if is null.
Thrown if is null.
Provides methods to parse command line arguments.
Default implementation for .
Initializes a new instance of the class.
Initializes a new instance of the class,
configurable with a object.
The object is used to configure
aspects and behaviors of the parser.
Parses a array of command line arguments, setting values in
parameter instance's public fields decorated with appropriate attributes.
A array of command line arguments.
An object's instance used to receive values.
Parsing rules are defined using derived types.
True if parsing process succeed.
Thrown if is null.
Thrown if is null.
Parses a array of command line arguments, setting values in
parameter instance's public fields decorated with appropriate attributes.
This overload allows you to specify a derived instance for write text messages.
A array of command line arguments.
An object's instance used to receive values.
Parsing rules are defined using derived types.
Any instance derived from ,
usually . Setting this argument to null, will disable help screen.
True if parsing process succeed.
Thrown if is null.
Thrown if is null.
Models an help text and collects related informations.
You can assign it in place of a instance.
Initializes a new instance of the class
specifying heading informations.
A string with heading information or
an instance of .
Thrown when parameter is null or empty string.
Adds a text line after copyright and before options usage informations.
A instance.
Thrown when parameter is null or empty string.
Adds a text line at the bottom, after options usage informations.
A instance.
Thrown when parameter is null or empty string.
Adds a text block with options usage informations.
The instance that collected command line arguments parsed with class.
Thrown when parameter is null.
Adds a text block with options usage informations.
The instance that collected command line arguments parsed with the class.
The word to use when the option is required.
Thrown when parameter is null.
Thrown when parameter is null or empty string.
Adds a text block with options usage informations.
The instance that collected command line arguments parsed with the class.
The word to use when the option is required.
The maximum length of the help documentation.
Thrown when parameter is null.
Thrown when parameter is null or empty string.
Returns the help informations as a .
The that contains the help informations.
Converts the help informations to a .
This instance.
The that contains the help informations.
Sets the copyright information string.
You can directly assign a instance.
Gets or sets the maximum width of the display. This determines word wrap when displaying the text.
The maximum width of the display.
Gets or sets whether to add an additional line after the description of the option.
Models the heading informations part of an help text.
You can assign it where you assign any instance.
Initializes a new instance of the class
specifying program name.
The name of the program.
Thrown when parameter is null or empty string.
Initializes a new instance of the class
specifying program name and version.
The name of the program.
The version of the program.
Thrown when parameter is null or empty string.
Returns the heading informations as a .
The that contains the heading informations.
Converts the heading informations to a .
This instance.
The that contains the heading informations.
Writes out a string and a new line using the program name specified in the constructor
and parameter.
The message to write.
The target derived type.
Thrown when parameter is null or empty string.
Thrown when parameter is null.
Writes out a string and a new line using the program name specified in the constructor
and parameter to standard output stream.
The message to write.
Thrown when parameter is null or empty string.
Writes out a string and a new line using the program name specified in the constructor
and parameter to standard error stream.
The message to write.
Thrown when parameter is null or empty string.
Models an option that can accept multiple values as separated arguments.
Initializes a new instance of the class.
The short name of the option or null if not used.
The long name of the option or null if not used.
Specifies a set of features to configure a behavior.
Initializes a new instance of the class.
Initializes a new instance of the class,
setting the case comparison behavior.
If set to true, parsing will be case sensitive.
Initializes a new instance of the class,
setting the used for help method output.
Any instance derived from ,
default . Setting this argument to null, will disable help screen.
Initializes a new instance of the class,
setting case comparison and help output options.
If set to true, parsing will be case sensitive.
Any instance derived from ,
default . Setting this argument to null, will disable help screen.
Initializes a new instance of the class,
setting case comparison and mutually exclusive behaviors.
If set to true, parsing will be case sensitive.
If set to true, enable mutually exclusive behavior.
Initializes a new instance of the class,
setting case comparison, mutually exclusive behavior and help output option.
If set to true, parsing will be case sensitive.
If set to true, enable mutually exclusive behavior.
Any instance derived from ,
default . Setting this argument to null, will disable help screen.
Gets or sets the case comparison behavior.
Default is set to true.
Gets or sets the mutually exclusive behavior.
Default is set to false.
Gets or sets the used for help method output.
Setting this property to null, will disable help screen.