Click or drag to resize

ParameterType Class

Every parameter for a command will need a ParamterType object.
Inheritance Hierarchy

Namespace:  us.FreeWill.CommandLine
Assembly:  CommandLine (in CommandLine.dll) Version: 2.0.2341.22284
public class ParameterType

The ParameterType type exposes the following members.

Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInit
Initialize the paramter object.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetValidateFunction
Manually assign your own paramter validation event handler. It will automatically be called when users enter this parameter so you can hook into validating what the user enters.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Perform a vlidation on the user entered paramter value.
Public eventValidateFunction
The validation function event.
Public fieldLongHelp
Long text to display in the automated help command for this parameter.
Public fieldParamText
The paramter name expected from the user.
Public fieldRequired
Boolean enforcing whether a command can be accepted without this paramter.
Public fieldShortHelp
Short text to display in the automated help command for this parameter.
Public fieldUserEquate
The equals string the user provided.
Public fieldUserValue
The value for the parameter the user provided. This is what follows the equals character.
Public fieldValidEquates
List of strings that will be accepted as equals text. For example, a command like TEST MYPARM = HELLO, the "=" is the ValidEquate. You can accept more than one character or string as a valid equals string such as this: TEST MYPARM := HELLO, the ":=" string is the ValidEquate. You can have it accept more than just one at any time.
See Also