OptionAttribute Class

Definition

Indicates a command line option. Options are passed as named parameters from the command line.

public ref class OptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public class OptionAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type OptionAttribute = class
    inherit Attribute
Public Class OptionAttribute
Inherits Attribute
Inheritance
OptionAttribute
Attributes

Constructors

OptionAttribute()

Properties

DefaultValue

An optional default value to set if user did not pass a value for this option.

Description

Help string shown for the option.

Name

Name of the option. Usually passed with the prefix --. If the Name is not set, name of the property on which the attribute is declared is assumed.

ShortName

ShortName for convenience. Usually passed with the prefix -.

Applies to