Click or drag to resize

aceCommandConsole Class

Home | imbSCI | imbACE | imbNLP | imbWEM | imbWBI
Basic command console environment
Inheritance Hierarchy

Namespace:  imbACE.Services.console
Assembly:  imbACE.Services (in imbACE.Services.dll) Version: 0.2
Syntax
C#
public abstract class aceCommandConsole : aceOperationSetExecutorBase, 
	IAceOperationSetExecutor, IAceCommandConsole
Request Example View Source

The aceCommandConsole type exposes the following members.

Properties
  NameDescription
Public propertyapplication
Reference to [!:aceApplicationBase]
Public propertycommands
Commands of the console
Public propertycommandSetTree
command tree, used for help generation
Public propertyconsoleHelp
Short help message about this console
Public propertyconsoleIsRunning
It is true if console is turned on, waiting for an input or performing already given command(s)
Public propertyconsoleTitle
Console title
Public propertyDefaultCommand
Default command that will be executed on empty imput
Public propertydoAskForExitConfigmation
Public propertydoAskForQuitConfirmation
Public propertyencode
Public propertyhelpContent
Help text short header, used when console api is rendered or shown
Public propertyhelpHeader
Additional points for console help header text. helpContent
Public propertyhistory
Commands executed earlier
Public propertylastInput
Last input from the command line
Public propertylinePrefix
Prefix to show in the command line
Public propertyoutput
The primary console output. By default pointed to the platform via consoleControl
Public propertyplatform
Reference to the application's platform to display/use the console outputs
Public propertyresponse
Secondary output of the console. By default it is pointed to the platform output, but it can be directed to a file or other outputs.
Public propertysaveClipboard
Public propertyscriptRunning
Reference to the console script that is running or was running last time
Top
Methods
  NameDescription
Public methodaceOperation_consoleCls
Public methodaceOperation_consoleExit
Public methodaceOperation_consoleHelp
Public methodaceOperation_consoleQuit
Public methodaceOperation_runAbort
Public methodaceOperation_runNone
Public methodaceOperation_runPause
Public methodcls
Clear Screen
Public methodexecuteCommand
Executes the command.
Public methodexecuteScript
Executes the command console script. aceConsoleScript
Public methodOnPropertyChanged (Inherited from aceBindable.)
Public methodonStartUp
Will be executed upon start-up of the console.
Public methodstart
Starts the console
Top
Events
  NameDescription
Public eventPropertyChanged (Inherited from aceBindable.)
Top
Fields
Extension Methods
  NameDescription
Public Extension MethodaceGenEx (Defined by aceExceptionTools.)
Public Extension MethodaceSciEx (Defined by aceExceptionTools.)
Top
See Also