6ASends the document/application that currently has focus to the background of all other tasks.
The Switchto command by default does not bring the application/document to the foreground when launching it. This allows a macro to switchto a file, manipulate and and exit the file without the user seeing anything.
APauses execution until the user presses the ENTER
key.
This is a useful command when you need to display a dialog (like the battery dialog) 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. BacklitePlus appears to hang if the user attempts to switch back to it. Pressing RETURN at any time continues execution of the macro.
ABrings Backlite+Plus to the foreground.
Use this in conjuction with the BLHideBacklite command to hide all of the application windows (and Sticky notes). This then allows you to use dialog, and other user interaction routines without the Backlite+Plus screens being visible, eg:-
PROC macHelloWorld:
BLHideBacklite:
BLBacklitetoFront:
GIPRINT "Hello World"
BLBacklitetoBack:
BLUnhideBacklite:
Arial
Arial
Arial
Arial
Arial
Arial
Arial
AReturns a string variable containing a setting stored under the name SettingName$ within the Backlite+Plus ini file. All settings are stored as strings so conversion is required for integers and other number based formats, eg:-
TurnOn%=val(BLLoadSetting$:("TurnON"))
ith the add-on macro recorder).
xAThis command allows saves a setting to the BacklitePlus.ini file. INI file settings are stored as strings, so the value should be converted using the OPL Num$ command first. eg:
BLSaveSetting:("UserName","John Smith")
BLSaveSetting:("HideWin",num$(Hidewin%,1))
The num$ command has two parameters, a number variable to convert, and a length of characters to convert it to.
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 BLTypeText command which inserts each character at a time. However, you can't use this command to insert dates/times into dialogs. BLTypetext 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:-
BLKeyCommand:("CTRL+C")
BLKeyCommand:("CTRL+SHIFT+C")
BLKeyCommand:("CTRL+ENTER")
BLKeyCommand:("MENU")
BLKeyCommand:("FN+RIGHT")
Any commands that are not recognised will be reported when you run the Macro for the first time.
Note: BLClickOK,BLAppMenu and BLClickCancel are all shortcut commands to the ENTER,MENU and ESC commands available with KeyCommand
AReturns a 1 or 0 to indiciate wether the application/document 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. TIP You can use this command to assign the SAME hotkey to several Macros, all of which perform a different function depending on the application or document you have loaded.
kAHides all Backlite+Plus windows including Toolbars and Stickynotes. This command can be used when you need to display messages, dialogs or allow user interaction. Use this in combination with the BLBacklitetoFront . You must remember to use the BlUnhideBacklite command after you send BacklitePlus to the background otherwise the program will appear "invisible".
7ABrings the document/application that currently has focus to the foreground of all other tasks.
The Switchto command by default does not bring the application/document to the foreground when launching it. This allows a macro to switchto a file, manipulate and and exit the file without the user seeing anything.
>c:\Help-017Temp
Table1C
.Description
2Program name
"Keywords
"See Also
Usage
Title
Order
Arial
Times New Roman
Arial
Arial
Arial
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).
PASends Backlite+Plus to the background of the currently running tasks. If this command has been used after a BLHideBacklite command then you must use BLUnHideBacklite to restore all windows and Sticky notes, eg:-
PROC macHelloWorld:
BLHideBacklite:
BLBacklitetoFront:
GIPRINT "Hello World"
BLBacklitetoBack:
BLUnhideBacklite:
Arial
Arial
Arial
Arial
Arial
Arial
.AInvokes the Add sticky command and displays the new entry dialog. if BL is in the foreground, then this would behave no differently than the normal ENTER hotkey. If however, this command is run whilst BL is in the background, then the new Sticky dialog appears over the top of the running application.
gCSwitches the focus of macro commands to the document or application specified as file$.
If BlSwitchto is used, the application or document is brought to the foreground. If BLbg Switchto is used, the app/doc is kept or sent to the background.
If file$ is not running, it is opened automatically.
File$ can be a path to a document, a path to an application file (with an APP extension) or a single name of a registered application (such as "Word" or "Sheet".
Examples:-
BLSwitchto:("Word")
BLBgSwitchto:("c:\Jotter")
BLSwitchto:("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:-
AUse this to send a quick status message (the GIPRINT command in OPL). text$ is a string to show.
This command allows you to show quick messages like "LINK
ON" to the user whether Backlite+Plus is in the foreground or background. The message lasts about 1/2 second, and then disapears.
FAHalts execution of any futher Macro commands until the current application or document that has the focus is exited.
Example:-
BLSwitchto:("Help.dbf")
BLWaitforFileExit:
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.
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:
BLSwitchtoCurrent:
BLPasteText$:(UPPER$(BLCopy$:))
Message,Status,GIPRINT
BLMessage:(text$) BLMessaged
Courier
Wait,pause,freeze
BLWaitforFiletoExit:(Message$)
BLWaitForFileExitd
Welcom to the Backlite+Plus macro language database. This database details all of the current BL+ macro commands with syntax, explanation and some examples.
Command listing
Backlite+Plus Macros
Arial
Arial
Arial
Arial
cADisplays the menu of the application or document that has focus.
BlSwitchto
BLAppMenu: BLAppMenud
Displays a dialog asking for a time. Returns a string in the format: "HHMMSS". This string can then be "typed" into a dialog with BLTypeText:
BLAskforTime$:(Title$,Prompt$)
BLAskforTimed
%background,foreground,order,priority
BLForeground,Switchto
BLBackground:
BLBackgroundd
back,priority,order,backlite
BLBacklitetoBack
BLBacklitetoFront:
BLBacklitetoFrontd
BLBacklitetoFront
BLBacklitetoBack:
BLBacklitetoBackd
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)
U BLClickOK
BLClickCANCEL:
BLClickCANCELd
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).
BLClickCancel
BLClickOK: BLClickOKd
Keycommand
BLClipText$
BLClipTextd
c5Copies the text specified in text$ to the clipboard.
ClipText
BLCopyClip:(text$)
BLCopyClipd
Returns a string containg the body text from the currently highlighted Sticky note in Backlite+Plus.
The string is up to 255 characters in length and will contain any special characters (tabs, carriage returns etc) that the sticky note contains.
BLCurrentStickyText$:
BLCurrentStickyTextd
Sends a cursor down command to the application/document that has focus n% number of times. BLCursorDown:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
%BlCursorUp,BLCursorLeft,BLCursorRight
BLCursorDown:(n%)
BLCursorDownd
Sends a cursor left command to the application/document that has focus n% number of times. BLCursorLeft:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
%BLCursorRight,BLCursorUp,BLCursorDown
BLCursorLeft:(n%)
BLCursorLeftd
Sends a cursor right command to the application/document that has focus n% number of times. BLCursorRight:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
$BLCursorLeft,BLCursorUp,BLCursorDown
BLCursorRight:(n%)
BLCursorRightd
Sends a cursor Up command to the application/document that has focus n% number of times. BLCursorUp:(1) sends one keypress, and increasing n% will send multiple keypresses in a single command.
'BLCursorLeft,BLCursorRight,BLCursorDown
BLCursorUp:(n%)
BLCursorUpd
This is an internal Backlite+Plus command that invokes Cycles through currently running tasks. This can be assigned to a Hotkey within the Hotkey settings dialog.
c\Switchs the focus of macro commands to the application that is currently in the foreground.
BLSwitchto
BLSwitchtoCurrent:
BLSwitchtoCurrentd
c;Switches the focus of macro commands to the System screen.
BLSwitchtoSystem:
BLSwitchtoSystem
c]Switches the focus of macro commands to Agenda, loading it if necessary (with the last file)
BLSwitchtoAgenda:
BLSwitchtoAgendad
c[Switches the focus of macro commands to Data, loading it if necessary (with the last file)
BLSwitchtoData:
BLSwitchtoDatad
c[Switches the focus of macro commands to Word, loading it if necessary (with the last file)
BLSwitchtoWord:
BLSwitchtoWordd
c\Switches the focus of macro commands to Sheet, loading it if necessary (with the last file)
BLSwitchtoSheet:
BLSwitchtoSheetd
c.Switches the focus of macro commands to Calc.
BLSwitchtoCalc:
BLSwitchtoCalcd
c]Switches the focus of macro commands to Sketch, loading it if necessary (with the last file)
BLSwitchtoSketch:
BLSwitchtoSketchd
Switches the focus of macro commands to Email.
NB. The "real" name for the Psion Email application s "Message". If you use the Switchto:(name$, use must specify the application name as "Message"
BLSwitchtoEmail:
BLSwitchtoEmaild
c1Switches the focus of macro commands to Browser.
BLSwitchtoWeb:
BLSwitchtoWebd
c>Displays the current tasklist of open documents/applications.
BLTasklist:
BLTasklistd
Inserst the string Text$ into the application or document that has the focus, character by character. This is slower that BLPasteText but can be used in dialogs where you want to paste single characters.
BlPasteText
BLTypeText:(Text$)
BLTypeTextd
{Restores all Backlite+Plus windows (including toolbars and sticky notes) that were hidden with the BLHideBacklite command.
BLHideBacklite
BLUnHideBacklite:
BLUnHideBacklited
BLClickOK
BLWaitforOK:
BLWaitforOKd
cRWaits for a the number of seconds specified in secs% before continuing execution.
(.txt)