Script Editor Properties Dialog Box

InstallShield 2018 » Script Editor

The Script Editor Properties dialog box is where you specify how script code should be displayed in various views throughout InstallShield. This dialog box is available in views that enables you to edit a script file (for example, the InstallScript, SQL Scripts, and Custom Actions and Sequences views).

To open the Script Editor Properties dialog box, right-click in a script editor pane and then click Properties.

Tip • Note that the script editor properties are global per-user settings that affect all InstallShield script editors. For example, the same font is used for all script editors. If you change the font in the SQL Scripts view, the font is also changed in the InstallScript view the next time that the InstallScript is reloaded in that view.

The settings on the Script Editor Properties dialog box are organized into the following main categories:

General
Colors

General Settings

The following settings are available in the General area on the Script Editor Properties dialog box.

General Settings on the Script Editor Properties DIalog Box

Setting

Description

Font

This setting displays the font, style, and size that is used for the content in the script editor. To change the option that is selected, click the ellipsis button in this setting. Doing so opens the Font dialog box, which enables you to view and modify the font, style, and size of script content.

Syntax highlighting

Specify whether you want to InstallShield to use color coding for various script elements that are displayed in all of the script editors. If you select Yes, InstallShield uses color coding according to the selections that are made for the settings in the Colors area of the Script Editor Properties dialog box.

For more information, see Changing Colors for Syntax Highlighting in the Script Editors.

Auto completion

Specify whether you want InstallShield to display a pop-up list of alphabetically ordered functions, keywords, constants, and other script words that begin with the letters that you are typing. Auto completion also displays a list of available string identifiers when you enter the string constant operator (@) in the InstallScript view.

The default value is Yes.

Auto completion can increase your efficiency because it can reduce the time that you spend typing code. It can also help you avoid typographical errors in your code.

For more information, see Using Auto Completion when Writing Code in the Script Editors.

Include local variables

Specify whether you want InstallShield to include in the pop-up list all of the local variables that are defined in the selected script. The default value is Yes.

Note that if you select No, the Functions, Properties, and Methods folders in the center pane of the InstallScript view does not list any functions, properties, or methods from your script files.

If Yes is selected for this setting and you notice performance issues when you are typing code in the InstallScript view, you might want to change this setting to No.

This setting is ignored if you select No for the Auto completion setting.

For more information, see Using Auto Completion when Writing Code in the Script Editors.

Show function call tips

Specify whether you want InstallShield to display a function call tip—a type of tooltip—when you are typing a function call in your script. The function call tip shows the function’s parameter information. It also shows a description of the function, as well as a description of the parameter that you are entering. The default value is Yes.

For more information, see Viewing Function Call Tips for an InstallScript Function in the Script Editor.

Line numbering

Specify whether you want the left margin of the script editor to contain line numbers. The default value is No.

For more information, see Going to a Line Number in a Script that Is Displayed in a Script Editor.

Syntax folding

Specify whether you want to use syntax folding for your script. If you select Yes, InstallShield adds a plus sign (+) or a minus sign (–) in the margin next to each line of code that starts an expandable or collapsible block of script. Click the plus sign to expand the hidden code. Click the minus sign to hide the code.

The default value is No.

Syntax folding can help you minimize the clutter of large scripts and focus on the code that is relevant to the work that you are currently doing. It can also help you see the overall structure of a script.

Automatic indentation

Specify whether you want InstallShield to indent new lines of code in your script. The default value is Yes.

For more information, see Enabling or Disabling Automatic Indentation in the Script Editors.

Show whitespace

Specify whether you want InstallShield to display a symbol or other mark in place of each instance of white space in your script. For example, if you select Yes, InstallShield displays each space character in the script as a middle dot (·) and each tab character as an arrow. InstallShield also identifies line breaks when whitespace is enabled.

The default value is No

Tab width

Specify the tab size as a multiple of the character space size. For example, setting a tab space of 5 causes the cursor to move five character spaces when you press the TAB key.

Replace by space

Specify the number of character space(s) to move forward/backward. For example, if you select Yes; the cursor moves backward by 1 character space and based on the tab width selection; the cursor will move forward accordingly. If you select No, based on the tab width selection; the cursor will move forward/backward accordingly.

Colors Settings

The Colors area on the Script Editor Properties dialog box is where you view and modify the foreground color and—in some cases—the background color for various script elements.

The following settings are available in the Colors area on the Script Editor Properties dialog box.

Color Settings on the Script Editor Properties DIalog Box

Setting

Description

Default

Specify the colors for the text that is not one of the predefined types of script words.

Selection

Specify the colors for text that is selected in the script editor.

Cursor

Specify the colors for the blinking cursor.

Keywords

Specify the colors for script keywords such as built-in functions, data types, and constants.

Identifiers

Specify the colors that are used to show identifiers. This includes variables.

Operators

Specify the colors that are used to show operators. Examples include parentheses, brackets, and braces; arithmetic symbols like plus, minus, asterisk, and slash; and comma.

Comments

Specify the colors for the comments in your code; this includes the comment delimiters such as /*, */, or //.

Strings

Specify the colors for strings; this includes the surrounding quotes.

Unterminated strings

Specify color overrides for strings that have not been closed with a terminating quote; this helps you find strings that could cause compilation errors.

Preprocessor directives

Specify the colors that are used to show preprocessor directives; this includes any lines that start with a pound sign (#).

Constants

Specify the colors that are used to show script constants.

Labels

Specify the colors that are used to show labels.

Errors

Specify the colors that are used to show script errors.

Line numbers

Specify the colors that are used to show line numbers in the left margin, if line numbering is enabled.

Function call tips

Specify the colors that are used to call tips for InstallScript functions.

Matching braces

Specify the colors that are used to show opening and corresponding closing braces—{ }. This is used whenever the insertion point is within parentheses, brackets, or braces. The syntax coloring takes into account nesting (for example, Foo(array[array.GetLength() - 1])).

Unmatched braces

Specify the colors that are used to show an opening brace—{—that is missing its corresponding closing brace—}. This is used whenever the insertion point is after the opening parenthesis, bracket, or brace that is missing a closing mark. The syntax coloring takes into account nesting (for example, Foo(array[array.GetLength() - 1])).

To learn more about changing colors in the script editors, see Changing Colors for Syntax Highlighting in the Script Editors.

See Also