AInserts the string Text$ into the application or document that has the focus, character by character. This is slower that EsPasteText but can be used in dialogs where you want to paste single characters or have to input a time field that woul not accept a complete string.
ESIsCurrentAPP
ESLoadSetting
EsMacroApptoBack
EsMacroApptoFront
back,prior
EsMenuKey
AThis is a single command that copies the selected text to the clipboard and returns it as a string.
This is useful when you want to do string manipuation in a macro without copying first.
Example:-
PROC macUpper:
EsSwitchtoCurrent:
EsPasteText$:(UPPER$(BLCopy$:))
OAInserts the string Text$ into the application/document that has focus by copying it first to the clipboard. This makes it appear much faster than the EsTypeText command which inserts each character at a time. However, you can't use this command to insert dates/times into dialogs. EsTypetext is best used for that type of application.
BSends a key command to the current application. The key$ is broken into a modifer and a command key.
Modifiers allowed are FN, SHIFT,CTRL or any combination of the three, seperated with "+" signs.
Key commands can be any alphanumeric character, or UP,DOWN,LEFT,RIGHT for cursor keys, ENTER, TAB,SPACE,ESC,DEL,MENU for other special keys. eg:-
EsSendCommand:("CTRL+C")
EsSendCommand:("CTRL+SHIFT+C")
EsSendCommand:("CTRL+ENTER")
EsSendCommand:("MENU")
EsSendCommand:("FN+RIGHT")
Any commands that are not recognised will be reported when you run the Macro for the first time.
Note: EsEnterKey,EsMenuKey and EsESCKey are all shortcut commands to the ENTER,MENU and ESC commands available with SendCommand
Courier
Courier
Courier
Courier
ESSwitchtoAgenda
ESSwitchtoSheet
ESTypeText
EbAddExtrabar
ESDebugON:
EsESCKey
EsMenuKey
ESSaveSetting
EbAddExtrabar
EbShowExtraBar
(Event) EbEvRunShortcut
(Event) EbEvAddShortcut
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
ESSelectCurrentWord
Select,Wor
ESSelectNextWord
APauses execution of the macro until the user presses the ENTER
key.
This is a useful command when you need to display a dialog (like the battery dialog in macBattCheck.opo) with a hotkey, and then find out when or if the user pressed ENTER to close the dialog.
Note: Execution will not continue until the user presses the OK key. The calling application appears to hang if the user attempts to switch back to it. Pressing RETURN at any time continues execution of the macro.
EsSetBackground
background
EsSetForeground
EsShowTasklist
EsSwitchto / EsBgSwitchto
ESSwitchtoAgenda
ESSelectCurrentWord
Select,Wor
ESSelectLastWord
Select,Wor
ESSelectLine
ESSelectNextWord
EsSendCommand
xAReturns a string (up to 255 characters in length) containing the current clipboard text. This can be used in combination with the CTRL+C Keycommand, to access the clipboard. It is useful to add an element of authentication to make sure for example that the user has hilighted some text, or is on an Agenda entry (Agenda entries are contained as text in the Cliptext$ string).
EsEnterKey
EsESCKey
ESForeground
ESCursorUp
EsDebugOFF
ESDebugON:
EsESCKey
ESForeground
AReturns a true or false (-1 or 0) to indicate if the application specified as appname$ is currently in the foreground. Use this when you have application specific Macros that should not be run from any other app/document.
Example:-
If EsIsCurrentApp%:("Agenda")
Do stuff here
ENDIF
Arial
Arial
Courier
Arial
Arial
Arial
Arial
Arial
Arial
f here
ENDIF
xBSends the Macro application to the background of the currently running tasks eg:-
PROC macHelloWorld:
EsMacroApptoFront:
GIPRINT "Hello World"
EsMacroApptoBack:
Note There may be occassions where additional commands are required before bringing the application to the foreground. For example, the macro application might have a user interface that you do not want to show when running your macro. ExtraBars hides it's interface automatically when launching macros but Backlite+Plus does not. Additional Escript commands are provided by applications like Backlite+Plus in this situation (ie BLHideBacklite/BLUnHideBacklite)
cHSwitches the focus of macro commands to Sheet, loading it if necessary.
EsSwitchtoSheet:
EsSwitchtoSheetd
c.Switches the focus of macro commands to Calc.
EsSwitchtoCalc:
EsSwitchtoCalcd
Switches the focus of macro commands to Sketch, loading it if necessary.
Note: The "real" name for the Psion Sketch application is "Paint". If you use the Switchto:(name$, use must specify the application name as "Paint"
EsSwitchtoSketch:
EsSwitchtoSketchd
Switches the focus of macro commands to Email.
Note: The "real" name for the Psion Email application is "Message". If you use the Switchto:(name$, use must specify the application name as "Message"
EsSwitchtoEmail:
EsSwitchtoEmaild
Switches the focus of macro commands to Browser.
Note: The "real" name for the Psion web application is "Browser". If you use the Switchto:(name$, use must specify the application name as "Browser"
EsSwitchtoWeb:
EsSwitchtoWebd
c>Displays the current tasklist of open documents/applications.
EsShowTasklist:
EsShowTasklistd
EsPasteText
EsTypeText:(Text$)
EsTypeTextd
ESClickOK
EsWaitforEnter:
EsWaitforEnterd
cRWaits for a the number of seconds specified in secs% before continuing execution.
EsWaitforSecs:(secs%)
EsWaitforSecsd
Courier
Courier
EsCopy$:
EsCopy$d
Courier
Courier
Courier
Courier
Arial
Arial
Arial
Arial
yBBrings the Macro application to the foreground of the currently running tasks eg:-
PROC macHelloWorld:
EsMacroApptoFront:
GIPRINT "Hello World"
EsMacroApptoBack:
Note There may be occassions where additional commands are required before bringing the application to the foreground. For example, the macro application might have a user interface that you do not want to show when running your macro. ExtraBars hides it's interface automatically when launching macros but Backlite+Plus does not. Additional Escript commands are provided by applications like Backlite+Plus in this situation (ie BLHideBacklite/BLUnHideBacklite)
Courier
Courier
Courier
Courier
Courier
Courier
Courier
Courier
Arial
Arial
Arial
Arial
_BThis command allows you to save a setting to the EScript settings file. INI file settings are stored as strings, so the value should be converted using the OPL Num$ command first.
The location of the EScript settings file is fixed as c:\system\data\ESSettings.ini. This allows other EScript applications to access the settings stored in this file.
Settings example:-
To save a string use EsSaveSetting:("UserName","John Smith")
To save a number use EsSaveSetting:("HideWin",num$(Hidewin%,1))
The num$ command has two parameters, a number variable to convert, and a length of characters to convert it to.
ASwitches the macro debug mode on. With this mode switched on, you can step through your macro while it is playing to test the macro. Whilst playing, you are shown the next command and you can ESC out of the macro, Skip the next command or continue normally.
This mode is ideal for testing complex macros before runnng them fully. Sometimes macros can have unpredicted results so it's always best to test the macro first.
Adding macros to your own applications
Macro tips
EsAutoCloseON
EsAutoCloseON
EsAutoCloseON
Welcome
Using EScript
Tutorial: Writing Macros
Tutorial: Macro settings
Tutorial: Macro settings
CSwitches the focus of macro commands to the application or document specified as name$.
name$ can be a caption name, ie "Agenda", a file path to an app file, or a document in which case Escript will locate and launch the appropriate application.
If EsSwitchtoApp is used, the app/doc is brought to the foreground. If EsBgSwitchtoApp is used, the app/doc is kept or sent to the background.
If the application is running, then focus is switched to the first running instance of the application. If the target application is not running, it is opened with the last file used.
Examples:-
EsSwitchto:("Word")
EsBgSwitchto:("c:\Jotter")
EsSwitchto:("c:\system\apps\Psizip\Psizip.APP")
In addition to this command, you can use the in-built shortcuts to access the main Series 5 applications:-
_AHalts execution of any futher Macro commands until the current application or document that has the focus has been exited.
Example:-
EsSwitchto:("Help.dbf")
EsWaitforClose:("Waiting for exit..")
This is used in the Shortcut macro within the macShortcutSettings procedure to wait for the user to edit and exit the shortcut database, before continuing.
>c:\Help-017Temp
Table1C
.Description
2Program name
"Keywords
"See Also
Usage
Title
Order
EsWaitforClose
Wait,pause
EsWaitforEnter
EsWaitforSecs
ExtraBars Commands
EbAddExtrabar
AThis command is used to determine whether Switchto commands open files in multiple mode. Normally if you open a database file in EPOC or with Switchto any existing instance of the data application is closed and your new document opens it is place. Calling EsAutoCloseOFF means that any subsequent EsSwitchto commands will launch the targe documents without closing existing instances of the same application.
Example:-
EsAutoCloseOFF:
EsSwitchto:("c:\mydatabase")
EsAutoCloseON:
Arial
Times New Roman
Arial
Arial
Arial
CEScript macros can be created in two ways:-
Using the OPL Program editor - Through OPL code, you can create powerful macro applets and launch them within a compatible EScript macro application.
Using OPL allows you to create complex macros with more interaction and application intergration.
Macro "Scriptlets" (future feature) - Scriptlets are macro documents, created from an EScript compatible application such as the EScript Macro recorder. Scriptlets require no programming experience and can be created with simple "plain english"
commands selected from an available vocabulary of commands eg:
Switch to 'Agenda'
Type 'This is a test'
Press the Menu key
With Scriptlets, You don't need to know code or understand how to program at all..
Scriptlet files are registered documents to an EScript player and can be launched by simply double clicking them. In addition, EScript compatible applications can also launch and manage Scriptlet files. (Scriptlets will be supported in a future release of EScript.)
Courier
Arial
Courier
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
Arial
)AThis command has the opposite effect to the EsAutoCloseOFF command. Calling this command will mean that subsequent Switchto commands will automatically close an existing instance of a document running in the same application.
Example:-
EsAutoCloseON:
EsSwitchto:("c:\mydatabase")
EsAutoCloseOFF:
rst procedure in the macro file is the start of the macro.
Courier
Courier
~DUsing the setting feature of EScript you can create powerful macros that allow users to configure options and parameters within a specific settings dialog. Settings are loaded and saved using the EsLoadSettings and EsSaveSettings commands and a common EScript ini file is used so that your settings will be consistant between EScript applications.
It is easy to add a settings dialog to your macro. Simple create a new procedure with the same name as the first Macro procedure with "Settings" joined onto the end of the procedure name.
For example, if the macro macDateStamp.opo has a first procedure called macDateStamp then to add a settings procedure, create a new proedure called macDateStampSettings.
Adding this procdedure means that if the user edits the macro from an EScript application, and presses the settings button associated with the marco, your settings dialog is executed and displayed. This allows you to create macros and plug ins that are tightly integrated wth the host macro language.
(EScript application developers - Use the EsRunMacroSettings: command within your macro launcher to call the settings dialog if it exists)
@You need to use EsLink if you intend to create an application that can run EScript macros or you wish to use EScript commands within your own applications. Before
you use this command you must have used mload to load the EScript module into your application.
The best way to use this command is to setup a procedure at the beginning of your app that declares your global variables. Make sure the procedure only contains global variable declaration. Put the rest of your code in another procedure.
Now, put the command Loadm "x:\system\opl\EScript.opo" (where x: is the drive where the module is installed) into the first procedure under the global declarations and the EsLink command in the next line. Specify Procname$ as the procedure you want to continue execution with. This will ensure that EScript macro variables are added correctly to your app.
To run EScript macros from your application, use the EsRunMacro command and to all a macros settings routine (if the author has written one), use EsRunMacroSettings command.
PROC Init:
GLOBAL Myvars%,formy%,app%
Loadm "c:\system\opl\EScript.opo"
EsLink:("Main")
PROC Main:
EsRunMacro:("c:\mymac.opo")
iBEScript based applications can support additonal macro commands specific to the application itself.
For convenience, these extra commands are prefixed with a code based on the application. For example ExtraBars uses commands prefixed ith Eb and Backlite+ uses commands prefixed with BL.
These additional commands provide extra functionaity to your macro applets, enabling you to do much more with EScript than simply controlling other applications.
ExtraBars comes with a number of commands that allow your macros to control aspects of ExtraBars itself.
The following pages detail the command listing for ExtraBars.
oBEScript based applications can support additonal macro commands specific to the application itself.
For convenience, these extra commands are prefixed with a code based on the application. For example ExtraBars uses commands prefixed ith Eb and Backlite+ uses commands prefixed with BL.
These additional commands provide extra functionaity to your macro applets, enabling you to do much more with EScript than simply controlling other applications.
Backlite+ comes with a number of commands that allow your macros to control aspects of the application itself.
The following pages detail the command listing for Backlite+.
EbAddShortcut
EbCurrentExtrabar
EbGetType
EbHideExtraBar
EbShowExtraBar
AEsLoadSetting is broken down into 3 different procedures, each one returning either a string, integer or long.
EsLoadSetting$ returns a string variable containing a setting stored under the name SettingName$
EsLoadSetting% returns an integer of the value stored in SettingName$ and
EsLoadSetting& returns a long of the value stored in SettingName$
All settings are stored within the EPOC Script settings file store in c:\system\data\ESSettings.ini.
elease of EScript.)
NWhat is a macro?
A macro is a program that can automate tasks you would normally undertake manually. You might create a signature macro that always puts your custom signature on the end of an email when you launch it.
How do I write macros?
Whether you are familiar with OPL32 or not then developing macros is very easy as the EScript commands are very simple to use.
In this example we are going to write a simply macro in OPL that pastes the date into the application you are using eg Word.
Before we start let me explain how a macro works.
To control an application you need to make it the focus of your macro commands.
If the current document or application that is in the foreground is the one you want to recieve focus then EScript automatically uses this application with subsequent macro commands.
Otherwise, EScript has a command called EsSwitchto: which allows you to switch the focus of your commands to a particular application or document that may or may not be running. EsSwitchto can accept application names ie "Agenda" or paths to application files ie "c:\system\apps\Backlite\backlite.app" or document names ie "c:\my documents\agenda".
So, after you switch focus you can then control the application, sending keypresses and pen clicks to simulate a user manually controlling the application or document.
To write our first macro, we need to think through what we want our program to-
1. Switch to the current application
2. Paste the date
Quite simple really in plain English but we need to translate this into EScript code.
1. First, create a new program file in a folder on the system screen. Use Ctrl+N to specify a new file choose PROGRAM and call it something like Datestamp.opl
When the document opens,you should have the following:-
PROC :
This is the default procedure. Type Datestamp (or any other procedure name) before the colon and hit enter so you so you get:-
PROC Datestamp:
Note You can call your procedure by any name. Both EScript and Macro5 use the first procedure in your macro file.
Now we need to add our EPOC Script commands. The first thing to do is tell the macro which application or document to use. Type EsSwitchtoCurrentApp: in the line under the PROC statement. You should now have:-
PROC Datestamp:
EsSwitchtoCurrentApp:
(Remember, you don't HAVE to put this first line in if the app you want to use is already in the foreground when the macro is run.)
Next, the OPL command for getting the date is DATIM$. This will return a string with the current date and time.
OK, Our macro now has some focus and is ready to control the current application. The quickest way to get text into an application is to paste it so we should use EsPasteText.
Type EsPasteText:(DATIM$) in the line under the EsSwitchto command. You should no have:-
PROC Datestamp:
EsSwitchtoCurrentApp:
EsPasteText:(DATIM$)
OK, Our macro is now written. We now need to translate it. Use CTRL+L or press the translate button in the toolbar to translate your macro.
You should now have a file called Datestamp.opo in the same folder as your macro code file (Datestamp).
To add the macro to ExtraBars, make sure EB is running and a bar is displayed. Then use the CTRL+A hotkey or select add shortcut from the shortcut menu.
Select Macro as the type and using the next file dialog, locate the Datestamp.opo file you created. Give your macro a name and EB
then adds it to your current bar.
To Launch the macro, go to the application or document you want to use, open the extrabar containing the macro shortcut and run it. The Date and Time should be pasted into the currently running application or document.
That's it! Your first macro.You can adapt your macro to include settings, user input or other features to make it even more powerful.
AThis is a callback event within ExtraBars. This means that when the user edits the properties of a shortcut, this event is called and if a macro module exists within the <appdrive>\system\apps\extrabars\pluginevents folder contains this procedure, then the procedure is called AFTER the shortcut is edited. This allows you to write macros that append dialogs or extra instruction after a shortcut is edited.
Switches focus to the application that is currently in the foreground. The application launching the macro is always ignored if that is in the foreground.
EsSwitchto
EsSwitchtoCurrentApp:
EsSwitchtoCurrentAppd
c;Switches the focus of macro commands to the System screen.
EsSwitchtoSystem:
EsSwitchtoSystemd
cISwitches the focus of macro commands to Agenda, loading it if necessary.
EsSwitchtoAgenda:
EsSwitchtoAgendad
cGSwitches the focus of macro commands to Data, loading it if necessary.
EsSwitchtoData:
EsSwitchtoDatad
cGSwitches the focus of macro commands to Word, loading it if necessary.
EsSwitchtoWord:
EsSwitchtoWordd
cADisplays the menu of the application or document that has focus.
EsSwitchto
EsMenuKey: EsMenuKeyd
Displays a dialog asking for a time. Returns a string in the format: "HHMMSS". This string can then be "typed" into a dialog with EsTypeText:
EsTypeText#EsAskforTimeInput$:(Title$,Prompt$)
EsAskforTimeInputd
c^Sends the document/application that currently has focus to the background of all other tasks.
%background,foreground,order,priority
EsSetForeground
EsSetBackground:
EsSetBackgroundd
back,priority,order,backlite
EsMacroApptoBack
EsMacroApptoFront:
EsMacroApptoFrontd
ESBacklitetoFront
EsMacroApptoBack:
EsMacroApptoBackd
This command sends an ESC keypress to the application/document that has the focus. Use it to press a Cancel button on a dialog, or to send an ESCAPE character (27)
EsEnterKey
EsESCKey
EsESCKeyd
This command sends an ENTER keypress to the application/document that has the focus. Use it to press on OK button on a dialog, or to send an carriage return code (13).
EsESCKey
ESEnterKey:
EsEnterKeyd
EsCopytoClip,EsCopy$
EsClipText$
EsClipTextd
c5Copies the text specified in text$ to the clipboard.
EsClipText, EsCopy$
EsCopytoClip:(text$)
EsCopytoClipd
Sends a cursor down command to the application/document that has focus n% number of times. EsCursorDown:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
$EsCursorUp,ECursorLeft,EsCursorRight
EsCursorDown:(n%)
EsCursorDownd
Sends a cursor left command to the application/document that has focus n% number of times. EsCursorLeft:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
%EsCursorRight,EsCursorUp,EsCursorDown
EsCursorLeft:(n%)
EsCursorLeftd
Sends a cursor right command to the application/document that has focus n% number of times. EsCursorRight:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
$EsCursorLeft,EsCursorUp,EsCursorDown
EsCursorRight:(n%)
EsCursorRightd
Sends a cursor Up command to the application/document that has focus n% number of times. EsCursorUp:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
'EsCursorLeft,EsCursorRight,EsCursorDown
EsCursorUp:(n%)
EsCursorUpd
c_Brings the document/application that currently has focus to the foreground of all other tasks.
ESetBackground
EsSetForeground:
EsSetForegroundd
IDThis command adds a new shortcut to the extrabar called bar$ and returns a true (-1) if successful. name$ is the shortcut display name, file$ is the filename of the item to shortcut. app$ is optional and depends on the typ% parameter:-
typ% can be one of 5 values:-
1. Application
2. Document
3. Web site
4. Folder
5. Macro
6. Template
7. ClipText
In all cases, file$ should be the target app file, document, website, folder, macro, template or ClipText (ASCII) file unless you want to load an application with a specific file in which case app$ is the name of the APP file and file$ is the name of the document.
The first example creates a shortcut to an application, only file$ is used. app$ is left empty.
The second example loads data with a specifc file so app$ is the app filename and file$ is the document.
Look at the Import Hotkeys plugin that comes with ExtraBars to see how these commands can be used.
Courier
Courier
AThis command displays a dialog where the user can select an extrabar. The name of the bar is returned as a string or "" (nothing) is returned if the user presses CANCEL. Title$ is the title of the dialog, Line1$ and Line2$ specify text for the first two lines of the dialog and Prompt$ is the text to display next to the list of bars, eg "Select bar".
This command is useful for even based macros or plugin macros where you want the user to specify an extrabar.
Backlite+ commands
BLAddStickyNote
BLCurrentStickyText
BLHideBacklite
BLUnhideBacklite
Avoid using gUSE 1 commands. This is the default wi
ndow and is probably used by the macro application.
Do not use the OPL STOP command in your macros. This has the effect of closing both the macro and the appilcation running it!
Try to design your dialogs so they conform to the EPOC
standards. This will ensure that your macros look seamless and part of the application running them.
Make sure the first procedure in the macro file is the start of the macro.
AThis is a callback event within ExtraBars. This means that when the user edits the name of a shortcut, this event is called and if a macro module exists within the <appdrive>\system\apps\extrabars\pluginevents folder contains this procedure, then the procedure is called AFTER the shortcut is edited. This allows you to write macros that append dialogs or extra instruction after a shortcut is edited.
Courier
Courier
Courier
Courier
EsAutoCloseOFF:
EsAutoCloseON:
EsAutoCloseON
EsAutoCloseON
EsAutoCloseOFF:
EsAutoCloseOFF
Runs an EScript (or Macro5 macro if the Macro5 library is installed) macro applet from the main macro running application. Use in conjunction with EsLink within your own applications to provide support for EScript macro modules.
EsLink , EsRunMacroSettings
EsRunMacro:(file$)
EsRunMacro
Clears the clipboard
EsClipText$, EsCopytoClip$
EsClearClip:
EsClearClipd
ExtraBars Commands
SThis command adds an extrabar called Name$. A true (-1) is returned if successful.
EbAddExtrabar%:(Name$)0
EbAddExtrabar
c,This command displays the current ExtraBar.
EbHideExtraBar
EbShowExtraBar:0
EbShowExtraBar0
c)This command hides the current ExtraBar.
EbShowExtraBar
EbHideExtraBar:
EbHideExtraBar
+EbAddShortcut%:(bar$,name$,typ%,app$,file$)
EbAddShortcut
T,Some things to remember when writing macros.
Macro tips
Runs the macro's settings routine if the macro author has written one. A True (-1) is returned if the settings were run and False (0) if they were not found.
EsLink, EsRunMacro
EsRunMacroSettings%:(file$)
EsRunMacroSettings
kAdds a new sticky called Title$ containing the test in Text$. The note has the default size/zoom settings.
BLAddStickyNote:(Title$,Text$)
BLAddStickyNote,
Backlite+ commands+
c2Returns the selected sticky note text as a string
BLCurrentStickyText$:
BLCurrentStickyText-
Hides the Backlite+ windows (ie toolbar, meters and sticky notes) if you want your macro to come to the foreground to display information without showing Backlite+ itself.
BLUnHideBacklite
BLHideBacklite:
BLHideBacklite.
AThis is a callback event within ExtraBars. This means that when the user adds a new shortcut, this event is called and if a macro module exists within the <appdrive>\system\apps\extrabars\pluginevents folder contains this procedure, then the procedure is called AFTER the shortcut is added. This allows you to write macros that append dialogs or extra instruction after a shortcut is edited.
(Event) EbEvEditShortcut
(Event) EbEvEditShortcutName
(Event) EbEvAddShortcut
EbRunShortcut
EbSelectBar
(Event) EbEvRunShortcut
(Event) EbEvEditShortcutName
(Event) EbEvAddShortcut
BThis routine is usually called from an Event script when you have been passed the information relating to the shortcut. Call this routine to launch the shortcut based on the parameters name$, for the caption name, type%, for the shortcut type, app$/file$, for the application or filename to open.
You can of course use this command to launch any file as long as you specify the correct type%. For example, to launch a Word document called Mydoc1, the command would be:-
DEScript is a new macro language for EPOC computers. Originally started as a macro system for Backlite+Plus, EScript has developed into a more powerful and application independent macro system that allows you to control any application via keystrokes or pen clicks.
EScript compatible applications can provide two levels of Escript support:-
EScript macro commands only - This level of support means you can use all Es prefixed commands to create and run EScript macro applets.
EScript application interface - This level of support provides additional commands specific to the macro application. These are usually prefixed with a code for the application name. For example ExtraBars has additional commands such as EbAddshortcut etc that allow your macro applets to add new shortcuts to bars. Similarly, Version 2.20 of Backlite+ have additional commands like BLAddSticky that allow you to add a new sticky note.
ExtraBars and Backlite+ support both types of EScript commands
Note EScript supports and is compatible with Backlite+ 2.1 macros (where macro commands start with a BL prefix) although BL macros are no longer supported. It is recommended that you use EScript versions.
Courier
Courier
Wait,pause,freeze
EsWaitforClose:(Message$)
EsWaitforClosed
EScript V1.10F (Build 120)
Welcome
ESDebugOFF
EsDebugON:
EsDebugON:d
Switches the macro debug mode off (default mode) so that macro commands are executed normally.
(See EsDebugON for a full explaination of the EScript debug mode)
ESDebugON
EsDebugOFF:
EsDebugOFFd
Sends pen down event to the application or document that has macro focus. x and y are the screen co-ordinates to send the pen down event to.
EsPenClick,EsPenMove
EsPenDown:(x&,y&) EsPenDownd
"Developing your own EScript macros
Tutorial: Writing Macros
Creating Macros
Using EScript
cnSends a pen click event to the application that has focus. x and y are the co-ordinates to send the event to.
EsPenDown,EsPenMove
EsPenClick:(x&,y&)
EsPenClickd
cqSends a pen move event to the application that has focus. x& and y& are the co-ordiantes to move the pointer to.
EsPenDown,EsPenClick
EsPenMove:(x&,y&) EsPenMoved
KRefer to the EsLink command on how to add Macros to your own applications.
Using EScript.opo&Adding macros to your own applications
EsLink:(Procname$)
EsLink
Using EScript settings
Tutorial: Macro settings
FBThis is a callback event within ExtraBars. This means that when the user launches a shortcut, this event is called and if a macro module exists within the <appdrive>\system\apps\extrabars\pluginevents folder cotains this procedure, then the procedure is called BEFORE the shortcut is launched. This allows you to write macros that append dialogs or extra instruction onto a luanch command before you run the shortcut. Passing KTrue% (-1) back as a return value has the effect of stopping the launch from occurring and KFalse% (0) will inform EB to continue and launch the shortcut.
c=Restores the windows hidden with the BLHideBacklite command.
BLHideBacklite
BLUnhideBacklite:
BLUnhideBacklite0
jReturns a string description of the Shortcut type specified as Type%. For example "Document", "Macro" etc
EbGetType$:(type%) EbGetType
c1Returns the name of the current bar as a string.
(.txt)