StauffConsulting.Essentials.

EnumSwitch

C#:  
public class EnumSwitch :
    StauffConsulting.Essentials.EnumSwitchBase

VB:  
Public Class EnumSwitch
    Inherits StauffConsulting.Essentials.EnumSwitchBase

Type Ancestry:  Object
+---Switch
+---+---EnumSwitchBase
+---+---+---EnumSwitch

A switch that takes a single string value. The valid values are defined by an enum.

Summary Info

Constructor Summary

EnumSwitch Constructor.

Field Summary

object Value The enum value that was passed to the switch on the command line.

Inherited from StauffConsulting.Essentials.EnumSwitchBase:
EnumType

Inherited from StauffConsulting.Essentials.Switch:
_help, AllSwitches, Found, Name, NameLC, Required, ValueHelp

Property Summary

Inherited from StauffConsulting.Essentials.Switch:
Help

Method Summary

Parse Tries to parse the next thing from the argument list. This is for internal use only by CmdLineParser.

Inherited from StauffConsulting.Essentials.EnumSwitchBase:
GetEnumValue

Inherited from StauffConsulting.Essentials.Switch:
Parse, WriteHelp

Miscellany Summary

Constructor Details

EnumSwitch

C#:  
EnumSwitch (string name,
    System.Type enumType,
    object defaultValue,
    bool required,
    string help)

VB:  
Sub New(ByVal name As String, ByVal enumType As System.Type, ByVal defaultValue As Object, ByVal required As Boolean, ByVal help As String)

Constructor.

Parameters

name   the name of the switch; if it doesn't start with a hyphen, one is prepended.
enumType   the enum that defines the valid values for the switch
defaultValue   the default value
required   is this parameter required?
help   a description of the switch.

Field Details

Value

C#:  
object Value;

VB:  
Value As Object

The enum value that was passed to the switch on the command line.

Method Details

Parse

C#:  
Void Parse(StauffConsulting.Essentials.CmdLineParser p,
    System.Collections.ArrayList argList)

VB:  
Function Parse(ByVal p As StauffConsulting.Essentials.CmdLineParser, ByVal argList As System.Collections.ArrayList) As Void

(Inherited documentation)
Tries to parse the next thing from the argument list. This is for internal use only by CmdLineParser.

Parameters

p  
argList  

generated by DocGenDotNet on 18 Nov 2008 6:35:01 PM