Action Text Settings

InstallShield 2015

Project: Use the Custom Actions and Sequences view to configure action text settings in the following project types:

Basic MSI
InstallScript MSI
MSI Database
Transform

To keep end users informed, installations commonly display text on the progress dialog to describe the installation’s current activity. This usually accompanies the progress bar as a means of installation status. As each standard action and custom action is encountered, a message about the action is displayed on the progress dialog. This may be especially useful for actions that take a long time to execute. The same action text is also written to the installation’s log file if one is created.

The Action Text explorer in the Custom Actions and Sequences view lets you specify the action text for any action in your project.

When you click a custom action item or a standard action item in the Action Text area of the Custom Actions and Sequences view, the following settings are available.

Action Text Settings

Setting

Description

Description

Enter text that describes the selected action. For example, the default description for the InstallFiles action is:

Copying new files

When the Windows Installer launches this action, the text that you enter is displayed on the progress dialog. For more information, see Displaying Action Descriptions on the Progress Dialog.

If a log file is created at run time, this description is written to the log file when the Windows Installer launches this action.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

Template

Enter the template that should be used to format action data records. For example, the default template for the InstallFiles action is:

File: [1],  Directory: [9],  Size: [6]

When the Windows Installer launches this action, the action details may be displayed on the progress dialog. For the aforementioned InstallFiles example, the [1] property is replaced with the names of files as they are transferred to the target system. The [9] property is replaced with the directory that contains the file, and the [6] property is replaced with the file’s size in bytes.

Note that by default, the action data is not displayed on the progress dialog. For more information, see Displaying Action Data on the Progress Dialog.

If a template is not specified for the selected action, no data is displayed when the action is launched. In addition, the installation must be run with a full user interface; if the installation is run silently or with a reduced or basic user interface, the action data is not shown.

To find out what data fields are available for use in the Template setting value of a particular standard action, see Standard Actions Reference in the Windows Installer Help Library, and then refer to the help for the specific action.

Project: InstallScript MSI installations cannot display action data on the status dialog. However, the template is written to the installation’s log file.

Note: The value of this setting must always be [1] for several standard actions:

GenerateScript
Rollback
RollbackCleanup

Therefore, the Template setting is disabled for these actions.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

See Also