Syntax Highlighting and Code Completion

The Syntax Highlighter automatically color-codes key words, and provides lists of selectable options under specific conditions while you are scripting to assist you with completing your code. This means that while scripting you no longer need to remember the functions, or look up which properties belong to which classes and which parameters the various methods accept.

To use the code completion functionality:

1. Start typing into the scripting area the function you wish to use.

A drop-down list of the possible functions that include the characters you have typed, is presented, the first item in the list being highlighted.



Figure 1 - Example of the code completion functionality

2. Click on the function you wish to use to add it to the script field.

Or

1. Use the Up and Down arrow keys on your keyboard to move the highlight through the list.

While you move through the list, addition information may be presented.



Figure 2 - Additional information

2. Click the Information icon for an item or press the Ctrl+Space keys on your keyboard while the item is highlighted, to open a pop-up with more information.



Figure 3 - The Information icon opens a help pop-up

3. Once you have selected a function, you can hover the mouse pointer over it to display the possible options.



Figure 4 - The options relevant to the selected item

4. To open a complete list of all the available functions, press Ctrl+Space without first typing anything into the scripting area.

You can now drag the scroll-handle on the right edge of the list, or use the Up and Down arrow keys on your keyboard, to move through the list and select the function you wish to use.

Tip!
Note that Ctrl+Space will open a list of the relevant functions at the cursor at any time, so you can get assistance while editing the script later.



Figure 5 - The complete list of functions

5. As you type further characters into the field, the options available are presented. In the example below - a ( character has been typed after the f. The corresponding required ) character is then added automatically and the cursor is positioned between the two ready for your next entry.



Figure 6 - The ( and ) characters are added

6. Continue typing the script, in this case a " character. Again, the required second " character is added automatically.



Figure 7 - The two " characters are added

7. Add in this case the qid, and then the point . character on the end.

When you add the point character, a list of the methods available for f() is presented.

Figure 8 - The list of the methods available for f()

Continue building the script as required.