Skip to main content

PSLang auto-completion

The user interface can be configured to offer auto-completion of variable or function calls when writing PSLang expressions. Enabling auto-complete provides quick access to help and formatting information.

Only the PSLang functions in the string, time, and misc sections are available for auto-completion.

The auto-complete drop-down list appears as you type a valid expression into a PSLang text area. Only variables, functions and completion options that match your typing are displayed. For detailed information, click the ? link to the right of each listed item.

To see the complete drop-down list of all available options:

  • Click in an empty PSLang text field.

  • Press the ↓ key at a word break while typing an expression in a PSLang text area.

  • Press the ↓ key mid-word while typing an expression that does not match any of the available expressions.

Navigation through the list can be done with the mouse, or using the ↑ and ↓ keys. Selections can be made using the Enter or Tab keys. The Esc key closes the menu.

The PSLang auto-completion functionality can be disabled or enabled by clicking disable auto-completion or enable auto-completion beneath any PSLang text area.

The default settings for the PSLang auto-complete functionality are controlled by the config.js script, located in the \<instance>\design\src\js\ directory. In this script, the AutoCompletePslang group has the following options:

Table 1. PSLang auto-complete options in config.js

Option

Description

enabled

Controls whether the script is available to users.The default value is true.

initiallyOff

Controls whether PSLang auto-completion is enabled when a page loads. The default value is false. If set to true, then PSLang auto-completion is off by default when a page loads..