ParameterType Class |
Every parameter for a command will need a ParamterType object.
Inheritance HierarchyNamespace: us.FreeWill.CommandLine
Assembly: CommandLine (in CommandLine.dll) Version: 2.0.2341.22284
SyntaxC#
public class ParameterType
The ParameterType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ParameterType | Initializes a new instance of the ParameterType class |
| ParameterType(NotifyEventDelegate, String, ListString, ListString) | Initializes a new instance of the ParameterType class |
| ParameterType(NotifyEventDelegate, String, String, String, String) | Initializes a new instance of the ParameterType class |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Init |
Initialize the paramter object.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetValidateFunction |
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.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Validate |
Perform a vlidation on the user entered paramter value.
|
Events| Name | Description | |
|---|---|---|
 | ValidateFunction |
The validation function event.
|
Fields| Name | Description | |
|---|---|---|
 | LongHelp |
Long text to display in the automated help command for this parameter.
|
| ParamText |
The paramter name expected from the user.
|
| Required |
Boolean enforcing whether a command can be accepted without this paramter.
|
| ShortHelp |
Short text to display in the automated help command for this parameter.
|
| UserEquate |
The equals string the user provided.
|
| UserValue |
The value for the parameter the user provided. This is what follows the equals character.
|
| ValidEquates |
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