Skip to content

T_CommandLine_ParserSettings

Moh.Hassan edited this page Oct 10, 2019 · 1 revision

ParserSettings Class

Provides settings for Parser. Once consumed cannot be reused.

Inheritance Hierarchy

System.Object
  CommandLine.ParserSettings
Namespace: CommandLine
Assembly: CommandLine (in CommandLine.dll) Version: 0.0.0

Syntax

C#

public class ParserSettings : IDisposable

VB

Public Class ParserSettings
	Implements IDisposable

C++

public ref class ParserSettings : IDisposable

F#

type ParserSettings =  
    class
        interface IDisposable
    end

The ParserSettings type exposes the following members.

Constructors

 

Name Description
Public method ParserSettings Initializes a new instance of the ParserSettings class.
  Back to Top

Properties

 

Name Description
Public property AutoHelp Gets or sets a value indicating whether implicit option or verb 'help' should be supported.
Public property AutoVersion Gets or sets a value indicating whether implicit option or verb 'version' should be supported.
Public property CaseInsensitiveEnumValues Gets or sets a value indicating whether perform case sensitive comparisons of values. Note that case insensitivity only applies to values, not the parameters.
Public property CaseSensitive 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).
Protected property Consumed
Public property EnableDashDash Gets or sets a value indicating whether enable double dash '--' syntax, that forces parsing of all subsequent tokens as values.
Public property HelpWriter Gets or sets the TextWriter used for help method output. Setting this property to null, will disable help screen.
Public property IgnoreUnknownArguments 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
Public property MaximumDisplayWidth Gets or sets the maximum width of the display. This determines word wrap when displaying the text.
Protected property NameComparer
Public property ParsingCulture Gets or sets the culture used when parsing arguments to typed properties.
  Back to Top

Methods

 

Name Description
Public method Dispose() Frees resources owned by the instance.
Private method Dispose(Boolean) Releases the unmanaged resources used by the ParserSettings and optionally releases the managed resources
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Finalizes an instance of the ParserSettings class. (Overrides Object.Finalize().)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Extension Methods

 

Name Description
Private Extension Method IsEmpty (Defined by UnParserExtensions.)
Private Extension Method NormalizeValue (Defined by UnParserExtensions.)
  Back to Top

See Also

Reference

CommandLine Namespace

Clone this wiki locally