StauffConsulting.Essentials.

EnumListSwitch

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

VB:  
Public Class EnumListSwitch
    Inherits StauffConsulting.Essentials.EnumSwitchBase

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

A switch that takes a list of string values. The valid values are defined by an enum.

Summary Info

Constructor Summary

EnumListSwitch Constructor.

Field Summary

readonlyArrayList Values The values that were 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

EnumListSwitch

C#:  
EnumListSwitch (string name,
    System.Type enumType,
    bool required,
    string help)

VB:  
Sub New(ByVal name As String, ByVal enumType As System.Type, 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
required   is this parameter required?
help   a description of the switch.

Field Details

Values

C#:  
readonly System.Collections.ArrayList Values;

VB:  
ReadOnly Values As System.Collections.ArrayList

The values that were 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