Defining a PML Add-in

PML Customisation User Guide

PML Add-ins : Application Switching : Defining a PML Add-in

Each add-in is specified by an add-in definition file, with pathname %PMLUI%\<module>\ADDINS\<addin>, where <module> is the module name e.g. DES, and <addin> is the addin name e.g. MYADDIN. Each line contains a key and description, separated by a colon.


Key	Description
Name	The unique identifier of the add-in, e.g. GEN, DES. This key is compulsory.
Title	Text description of the add-in (if the add-in defines an application, the title appears in the title bar of the main window when the application is loaded)
ShowOnMenu	Determines whether the add-in has an entry on the Applications menu, i.e. whether the add-in defines an application (false by default).
Control	Add-in control object. User-defined object type used to configure and control the add-in, e.g. MYADDINCONTROLLER. A global variable of the same name is created automatically by the system at module startup e.g. !!myAddinController. Methods on this object can be executed at ModuleStartup and at the other application events.
ModuleStartup	Callback run when the module first starts, e.g. !!myAddinController.initialise()
StartupModify	Name of application to modify and the callback run when an application is first started, separated by a colon. e.g. EQUI:!!equiAppStartupCall().
SwitchModify	Name of application to modify and the callback to run when the application is switched to, separated by a colon. e.g. PIPE:!!pipeAppSwitchCall()
SwitchCall	Callback to be run every time the application is switched to.
StartupCall	Callback run when the application first starts.

where APPNAME is the name of the application to modify and callback is the callback to be assigned to it.

If an application with name APPNAME is not defined, the callback is not run.