Xbasic

Script Functions

Description

Alpha Anywhere provides the following script functions.

Name
Description
a5_clip_library Function

Displays the script editor's code library

a5_export_scripts_udfs Function

Export, print, or send scripts and functions. Method is 'export', 'print' or 'sent'.

a5_get_actionscript_Xbasic Function

Gets the Xbasic code from a saved Action Script. If action_script_parameters is .t., then returns the Action Script Parameters instead.

a5_is_actionscript Function

Returns .t. if the code is in the format of an Action Script.

a5_is_scr_being_edited Function

Returns .t. if the script/function is currently being edited.

a5_new_script_w_prompt Function

Creates a new script. Allows user to add script to Favorites list. Mode is Xbasic or Action.

a5_prmpt_script_name Function

Prompt for the name of a script or function to edit.

a5_save_script Function

Saves text as a script. If favorites_prompt = .t., then allows user to put script on Favorites list (only if in context of a Layout)

a5_script_create_new Function

Create a new script or function. If the specified name exits, the existing script or function is deleted. If editor_style is Xbasic or Genie

a5_script_favorites Function

Script Favorites. Mode = "play", "save", "manage", "Toolbar", "pick-list", "dialog"

a5_script_favorites_menu Function

Generates a string to add favorites to the Scripts menus in Froms and Browses

a5_script_rename Function

Displays the Script/UDF Re-Name Dialog for the script or function that is currently selected in the control panel.

a5_scripteditor_popup Function

Pop up script editor. Returns .text and .lastbutton properties

a5_scriptgenie_multistep Function

Pop up script genie that allows the user to select multiple actions. Returns .code and .lastbutton properties

a5_scriptgenie_multistp2 Function

Pop up script genie that allows the user to select multiple actions. Returns .code and .lastbutton properties

a5_select_script_action Function

Prompts the user for a Action Script Category and Action

A5_SETUP_ASK_VARS Function

Call by functions that support command line ask variables.

a5_what_being_edited Function

Returns a list of scripts currently open for editing. Active script is listed first.

DEBUG Function

Forces the application to break in the XBASIC debugger 1 debug next line of Xbasic, -1 ask if debugger is on, -2 toggle debugger.

EXPORT_SCRIPTS_AND_UDF Function

Exports all scripts and user defined functions (UDFs) to a file.

export_scripts_and_udfs Function

Exports global scripts and functions

export_scripts_udfs Function

Exports global scripts and functions

IMPORT_SCRIPTS_UDF Function

The IMPORT_SCRIPTS_UDF() function imports scripts and user defined functions from a text file.

import_scripts_udfs Function

Imports Global Scripts and Functions from a Text File

load_compiled_script Function

Loads a compiled script so that it can be referenced through a code pointer.

LOAD_LIBRARY Function

Load an AEX file so that a5 can use it, returns a level handle 0-255, run_autoexec is assumed TRUE if not specified - any script named autoexec is run when the AEX file is opened.

ON_CONDITION Function

Run code (once) when condition is met.

PROFILER_BEGIN Function

Start profiling code after the command.

PROFILER_END Function

End code profiling after the command.

script_drop Function

Drop a script (must include password if dropping a protected script).

script_exists Function

Return True if the script exists.

SCRIPT_LOAD Function

Return script contents (optional password can be used to load protected scripts).

script_load_compiled Function

Load the compiled form of a script into memory.

SCRIPT_PLAY Function

Returns TRUE if script was played.

SCRIPT_PLAY_LOCAL Function

Returns TRUE if script was played.

script_rename Function

Rename a script (must include password if renaming a protected script).

script_save Function

Save a script (must include password if saving over a protected script).

SCRIPT_SCHEDULE Function

Schedule a script for playback at a specific time.

SCRIPT_SCHEDULE_NAME_GET Function

Return the scripts name (if one is scheduled for the slot).

SCRIPT_SCHEDULE_TIME_GET Function

Return the scripts time (if one is scheduled for the slot).

SCRIPT_SPAWN Function

Runs a script in a new session.

SCRIPTEDITOR_OPEN Function

Opens the multi-pane script editor.

SLEEP Function

Sleep for specified number of seconds.

UDF_LOAD Function

Return udf contents (optional password can be used to load protected scripts).

VARIABLES_ENUM Function

Returns CR-LF separated variable list.

WAIT_UNTIL Function

Wait for an event, Returns TRUE if event returned TRUE, options - event returns true -- 'every' is time between event checks in seconds, optional timeout is time to give up after in seconds.

XBASIC_ASYNCHRONOUS Function

Run current script asynchronously (after call).

XBASIC_SYNCHRONOUS Function

Force current script to run synchronously (in the foreground thread).

XBASIC_WAIT_FOR_IDLE Function

Run current script asynchronously (after call) and wait for an idle.