Configure built-in script
- Last UpdatedDec 06, 2024
- 3 minute read
To configure a built-in script
-
Open the layout in the Layout Editor and select the Scripts tab.
-
Select one of the three built-in scripts from the script list in the left pane of the Scripts tab:
-
On Show: Use this to configure a script that runs one time when the layout opens.
-
While Showing: the script runs periodically while the layout is open.
-
On Hide: the script runs one time, when the layout closes.
-
-
Set any applicable timing parameters for the script.
-
On Show: the default Data Timeout is 1000 ms. See Tips to ensure proper On Show script execution for more information about configuring the timeout period.
-
While Showing: the default Period is 1000 ms. This value sets the interval at which the script will run while the layout is showing.
-
On Hide: There are no configurable timing parameters for an On Hide script. The script runs only once when the layout closes.
-
-
Enter your script in the main edit box. Autocomplete helps by displaying valid items, based on the initial characters you enter. The script syntax is the same as the syntax of AutomationObject scripting.
-
Enter your script in the main edit box. enter.Autocomplete helps by displaying valid items, based on the initial characters you enter. The script syntax is the same as the syntax of AutomationObject scripting.
-
You can validate your script for syntax errors prior to saving by pressing the Validate Script
button.
-
To clear all data entered for the the script, including the expression, press the Clear Script
button. There is no undo for this action.
-
-
To save the script, select the Save
or Save and Close
button.
-
The script is validated automatically. If there are warnings or errors generated, a dialog listing the errors is displayed. You have the following options:
-
Select Yes to save the script and preserve the errors.
-
Select No to discard the changes you made to the script. If you selected Save and Close, the Layout editor closes and you will lose any changes you made to the script. If you selected Save, the Layout Editor remains open and you can resume editing the script.
-
Select Cancel to resume editing the script. The Layout Editor remains open and you can resume editing the script.
-