Skip to content

T_CommandLine_OptionAttribute

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

OptionAttribute Class

Models an option specification.

Inheritance Hierarchy

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

Syntax

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.

Constructors

 

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

Properties

 

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

Methods

 

Name Description
Public method Equals Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method 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.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
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

Explicit Interface Implementations

 

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

See Also

Reference

CommandLine Namespace

CommandLineParser Class Library V2.6

Clone this wiki locally