Click or drag to resize

aceConsolePluginBase Class

Home | imbSCI | imbACE | imbNLP | imbWEM | imbWBI
Console plug-in -- use it as public property of a aceCommandConsole class to enable command execution.
Inheritance Hierarchy

Namespace:  imbACE.Services.consolePlugins
Assembly:  imbACE.Services (in imbACE.Services.dll) Version: 0.2
Syntax
C#
public abstract class aceConsolePluginBase : aceOperationSetExecutorBase, 
	IAceConsolePlugin, IAceOperationSetExecutor, IAcePluginBase, IObjectWithName
Request Example View Source

The aceConsolePluginBase type exposes the following members.

Properties
  NameDescription
Public propertyconsoleHelp
First line of help to be shown for this plugin
Public propertyconsoleTitle
Title of this plugin - if standalone then alias to name, if connected to the parent then sufix title, added after parent console title
Public propertyhelpHeader
Additional help content to be displayed at beginning of the help file, after consoleHelp
Public propertyinstanceName
Instance name
Public propertyIsStandalone
Indicates if this console plugin is running without parent console
Public propertyname
Name of this plugin
Public propertyoutput
Public propertyparent
Reference to the parrent console
Public propertyresponse
Plugin's own response text renderer. By default (when response not set) it is just mirror to the output renderer
Top
Methods
  NameDescription
Public methodOnPropertyChanged (Inherited from aceBindable.)
Top
Events
  NameDescription
Public eventPropertyChanged (Inherited from aceBindable.)
Top
Extension Methods
  NameDescription
Public Extension MethodaceGenEx (Defined by aceExceptionTools.)
Public Extension MethodaceSciEx (Defined by aceExceptionTools.)
Top
Remarks
Methods from a plugin should be called with proper command prefix pointing to property (of aceConsolePluginBase type) name. Like: printPlugin.print where printPlugin is property within a aceCommandConsole object and print is method of the plugin.
See Also