User interface variables
User interface variables are auxiliary variables that are used to control specific aspects of the installer's user interface behavior. For example, UILicensePage controls whether or not a License Agreement page is displayed; UILicenseAgreed is set to 1 if the customer has agreed to the license agreement. Most of the user interface variables are preset in the project file, but they may also be set or modified at runtime.
By convention, the names of user interface variables start with 'UI'. We suggest that you do not use this prefix for your own variables unless specifically intended to augment the predefined user interface behavior; this avoids potential conflicts with future additions to the user interface variables.
| Variable | Description |
|---|---|
| UIAllowCancel | Nonzero to enable Cancel buttons |
| UILevel | User interface level during install |
| UILicenseAgreed | Customer agrees to the license agreement |
| UILicensePage | Controls whether to show a License Agreement page |
| UIReadmePage | Controls whether to show a Readme page |
| UIRegistrationPage | Controls whether to show a Registration page |
| UIRunApp | Controls whether the application is started after installation |
| UIRunAppArgs | Arguments for <UIRunAppPath> |
| UIRunAppDir | Start folder for <UIRunAppPath> |
| UIRunAppPath | Application to start after installation |
| UIShowRunApp | Controls whether to show the Start application checkbox |
| UIWizardName | Display name of the Setup wizard |
| UserLanguageID | Language ID of the installation language (decimal) |
List of user interface variables
The following list shows the predefined user interface variables.
| Name | Description | Value |
|---|---|---|
| UILicenseAgreed | Tracks whether or not the customer has checked the I agree check box on the predefined LicenseDlg dialog box. This in turn is used to enable or disable the page's Next button. This variable is initially set to 0, which forces the customer to check the I agree box in order to continue with the installation. |
0=Not agreed 1=Agreed |
| UILicensePage | Determines if the predefined LicenseDlg dialog box is shown. This is for convenience only; if your installer never requires a License Agreement page, you can remove the corresponding RunDialog action altogether. This variable is initially set to 1. |
0=No License Agreement page 1= Show License Agreement page |
| UIReadmePage | Determines if the predefined ReadmeDlg dialog box is shown. This is for convenience only; if your installer never requires a Readme page, you can remove the corresponding RunDialog action altogether. This variable is initially set to 1. |
0=No Readme page 1=Show Readme page |
| UIRegistrationPage | Determines if the predefined RegistrationDlg dialog box is shown. This is for convenience only; if your installer never requires a Registration Information page, you can remove the corresponding RunDialog action altogether. This variable is initially set to 0. |
0=No Registration page 1=Show Registration page |
| UIRunApp | Determines if the installed application is started when the installation process is complete. The actual application parameters are part of a Run Program custom action that follows the predefined FinishDlg dialog box in the user interface sequence. This variable is initially set to 1 for converted Tarma QuickInstall 2 projects that include the corresponding option; it is set to 0 otherwise. It is linked to the Start the application checkbox on the Installation completed page, and can therefore be modified by the customer if the UIShowRunApp variable is set to 1. Note: If a reboot is required to complete the installation, the UIRunApp variable is automatically set to 0 before the Installation completed page is shown. |
0=Do not run the application 1=Run the application |
| UIShowRunApp | Determines if the Start the application checkbox is shown on the predefined FinishDlg dialog box. This checkbox is linked to the UIRunApp variable and allows the customer to change the value of UIRunApp, thus controlling whether the installed application is started after the installation is complete. This variable is initially set to 1. Note: If the UIRunApp variable is 0 when the Installation completed page is shown, the Start the application checkbox remains hidden regardless of the value of UIShowRunApp. |
0=Do not show the checkbox 1=Show the checkbox |