T_CommandLine_OptionAttribute

OptionAttribute Class

Models an option specification.

System.Object
  System.Attribute
    CommandLine.BaseAttribute
      CommandLine.OptionAttribute
Namespace: CommandLine
Assembly: CommandLine (in CommandLine.dll) Version: 0.0.0

C#

public sealed class OptionAttribute : BaseAttribute

VB

Public NotInheritable Class OptionAttribute
	Inherits BaseAttribute

C++

public ref class OptionAttribute sealed : public BaseAttribute

F#

[<SealedAttribute>]
type OptionAttribute =  
    class
        inherit BaseAttribute
    end

The OptionAttribute type exposes the following members.

	Name	Description
	OptionAttribute()	Initializes a new instance of the OptionAttribute class. The default long name will be inferred from target property.
	OptionAttribute(Char)	Initializes a new instance of the OptionAttribute class.
	OptionAttribute(String)	Initializes a new instance of the OptionAttribute class.
	OptionAttribute(Char, String)	Initializes a new instance of the OptionAttribute class.
	OptionAttribute(String, String)	Initializes a new instance of the OptionAttribute class

	Name	Description
	Default	Gets or sets mapped property default value. (Inherited from BaseAttribute.)
	HelpText	Gets or sets a short description of this command line option. Usually a sentence summary. (Inherited from BaseAttribute.)
	Hidden	Gets or sets a value indicating whether a command line option is visible in the help text. (Inherited from BaseAttribute.)
	LongName	Gets long name of this command line option. This name is usually a single english word.
	Max	When applied to IEnumerable(T) properties defines the upper range of items. (Inherited from BaseAttribute.)
	MetaValue	Gets or sets mapped property meta value. Usually an uppercase hint of required value type. (Inherited from BaseAttribute.)
	Min	When applied to IEnumerable(T) properties defines the lower range of items. (Inherited from BaseAttribute.)
	Required	Gets or sets a value indicating whether a command line option is required. (Inherited from BaseAttribute.)
	ResourceType	Gets or sets the Type that contains the resources for HelpText. (Inherited from BaseAttribute.)
	Separator	When applying attribute to IEnumerable(T) target properties, it allows you to split an argument and consume its content as a sequence.
	SetName	Gets or sets the option's mutually exclusive set name.
	ShortName	Gets a short name of this command line option, made of one character.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

	Name	Description
	IsEmpty	(Defined by UnParserExtensions.)
	NormalizeValue	(Defined by UnParserExtensions.)

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)