CommandType Class |
Every command you need in your CLI should have its own CommandType object.
Inheritance HierarchyNamespace: us.FreeWill.CommandLine
Assembly: CommandLine (in CommandLine.dll) Version: 2.0.2341.22284
SyntaxC#
public class CommandType
The CommandType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CommandType | Initializes a new instance of the CommandType class |
| CommandType(String) | Initializes a new instance of the CommandType class |
| CommandType(String, ListString) | Initializes a new instance of the CommandType class |
| CommandType(String, String) | Initializes a new instance of the CommandType class |
| CommandType(NotifyEventDelegate, String) | Initializes a new instance of the CommandType class |
| CommandType(String, ListString, ListString) | Initializes a new instance of the CommandType class |
| CommandType(NotifyEventDelegate, String, String) | Initializes a new instance of the CommandType class |
| CommandType(NotifyEventDelegate, String, ListString, ListString) | Initializes a new instance of the CommandType class |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Execute |
Executes the developer provided event handler method for this CommandType 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.) |
| GetOwnerCommandLine |
Retrieve a reference to the CommandLineType object that this command belongs to.
|
| GetParameterByName |
Retrieve a full ParameterType object by it's ParamText property value, if it exists.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetFunction |
Manually add your own event handler that will be called when a user types this command.
|
| SetOwnerCommandLine |
Assign your command object to a specific CommandLinType object.
|
| SetUserParams |
After user command is parsed, all words found are passed here as a string list.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | CommandEventHandler |
Fields| Name | Description | |
|---|---|---|
 | ConsoleEntry |
The text that the user typed.
|
| LongHelp |
A long list of text strings for this command that will be displayed when the user asks for help.
|
 | OwnerCommandLine |
The CommandLineType object that this command belongs to.
|
| ParameterList |
List of parameters this command accepts.
|
| ShortHelp |
A short list of text strings for this command that will be displayed when the user asks for help.
|
| UserParams |
List of paramters that the user entered.
|
See Also