Argparse.IOption< C > Interface Template Reference

Inheritance diagram for Argparse.IOption< C >:

Properties
HashSet< string >	Names [get]
	Names the options as they will be parsed by the parser. Names of long options are prefixed with two dashes '–' Names of short options are prefixed with one dash '-' One option can represent both long and short options.
string	Description [get]
	Description of the option as it should appear in help write-up.
bool	IsRequired [get]
	If true, the parser will produce an error state upon finishing parsing without encountering the option.
string	ValuePlaceHolder [get]
	Value used in help message as placeholder for value. e.g. when set to FILE for option –output, the help message will be: –output=FILE.

Property Documentation

Description

string Argparse.IOption< C >.Description

get

Description of the option as it should appear in help write-up.

Implemented in Argparse.Option< C, V >.

IsRequired

bool Argparse.IOption< C >.IsRequired

get

If true, the parser will produce an error state upon finishing parsing without encountering the option.

Implemented in Argparse.Option< C, V >.

Names

HashSet<string> Argparse.IOption< C >.Names

get

Names the options as they will be parsed by the parser. Names of long options are prefixed with two dashes '–' Names of short options are prefixed with one dash '-' One option can represent both long and short options.

Exceptions

ArgumentException

Thrown when set to an empty array or any of the provided names is in an invalid format.

Implemented in Argparse.Option< C, V >.

ValuePlaceHolder

string Argparse.IOption< C >.ValuePlaceHolder

get

Value used in help message as placeholder for value. e.g. when set to FILE for option –output, the help message will be: –output=FILE.

Implemented in Argparse.Option< C, V >.

---

The documentation for this interface was generated from the following file:

• argsparse/Option.cs