CommandLine.ParserSettings Class Reference

Provides settings for CommandLine.Parser. Once consumed cannot be reused. More...

Inheritance diagram for CommandLine.ParserSettings:

Public Member Functions
	ParserSettings ()
	Initializes a new instance of the ParserSettings class. More...
void	Dispose ()
	Frees resources owned by the instance. More...

Properties
bool	CaseSensitive [get, set]
	Gets or sets a value indicating whether perform case sensitive comparisons. Note that case insensitivity only applies to parameters, not the values assigned to them (for example, enum parsing). More...
CultureInfo	ParsingCulture [get, set]
	Gets or sets the culture used when parsing arguments to typed properties. More...
TextWriter	HelpWriter [get, set]
	Gets or sets the System.IO.TextWriter used for help method output. Setting this property to null, will disable help screen. More...
bool	IgnoreUnknownArguments [get, set]
	Gets or sets a value indicating whether the parser shall move on to the next argument and ignore the given argument if it encounter an unknown arguments More...
bool	EnableDashDash [get, set]
	Gets or sets a value indicating whether enable double dash '–' syntax, that forces parsing of all subsequent tokens as values. More...

Detailed Description

Provides settings for CommandLine.Parser. Once consumed cannot be reused.

Constructor & Destructor Documentation

CommandLine.ParserSettings.ParserSettings ( )

inline

Initializes a new instance of the ParserSettings class.

Member Function Documentation

void CommandLine.ParserSettings.Dispose ( )

inline

Frees resources owned by the instance.

Property Documentation

bool CommandLine.ParserSettings.CaseSensitive

getset

Gets or sets a value indicating whether perform case sensitive comparisons. Note that case insensitivity only applies to parameters, not the values assigned to them (for example, enum parsing).

bool CommandLine.ParserSettings.EnableDashDash

getset

Gets or sets a value indicating whether enable double dash '–' syntax, that forces parsing of all subsequent tokens as values.

TextWriter CommandLine.ParserSettings.HelpWriter

getset

Gets or sets the System.IO.TextWriter used for help method output. Setting this property to null, will disable help screen.

bool CommandLine.ParserSettings.IgnoreUnknownArguments

getset

Gets or sets a value indicating whether the parser shall move on to the next argument and ignore the given argument if it encounter an unknown arguments

true to allow parsing the arguments with different class options that do not have all the arguments.

This allows fragmented version class parsing, useful for project with add-on where add-ons also requires command line arguments but when these are unknown by the main program at build time.

CultureInfo CommandLine.ParserSettings.ParsingCulture

getset

Gets or sets the culture used when parsing arguments to typed properties.

Default is invariant culture, System.Globalization.CultureInfo.InvariantCulture.

---

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

• src/CommandLine/ParserSettings.cs