Click or drag to resize

CommandType Class

Every command you need in your CLI should have its own CommandType object.
Inheritance Hierarchy
SystemObject
  us.FreeWill.CommandLineCommandType

Namespace:  us.FreeWill.CommandLine
Assembly:  CommandLine (in CommandLine.dll) Version: 2.0.2341.22284
Syntax
C#
public class CommandType

The CommandType type exposes the following members.

Constructors
  NameDescription
Public methodCommandType
Initializes a new instance of the CommandType class
Public methodCommandType(String)
Initializes a new instance of the CommandType class
Public methodCommandType(String, ListString)
Initializes a new instance of the CommandType class
Public methodCommandType(String, String)
Initializes a new instance of the CommandType class
Public methodCommandType(NotifyEventDelegate, String)
Initializes a new instance of the CommandType class
Public methodCommandType(String, ListString, ListString)
Initializes a new instance of the CommandType class
Public methodCommandType(NotifyEventDelegate, String, String)
Initializes a new instance of the CommandType class
Public methodCommandType(NotifyEventDelegate, String, ListString, ListString)
Initializes a new instance of the CommandType class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute
Executes the developer provided event handler method for this CommandType 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 methodGetOwnerCommandLine
Retrieve a reference to the CommandLineType object that this command belongs to.
Public methodGetParameterByName
Retrieve a full ParameterType object by it's ParamText property value, if it exists.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetFunction
Manually add your own event handler that will be called when a user types this command.
Public methodSetOwnerCommandLine
Assign your command object to a specific CommandLinType object.
Public methodSetUserParams
After user command is parsed, all words found are passed here as a string list.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventCommandEventHandler
Top
Fields
  NameDescription
Public fieldConsoleEntry
The text that the user typed.
Public fieldLongHelp
A long list of text strings for this command that will be displayed when the user asks for help.
Protected fieldOwnerCommandLine
The CommandLineType object that this command belongs to.
Public fieldParameterList
List of parameters this command accepts.
Public fieldShortHelp
A short list of text strings for this command that will be displayed when the user asks for help.
Protected fieldUserParams
List of paramters that the user entered.
Top
See Also