Dialog Boxes (Windows Installer)
Dialog boxes are specified in the Dialog column of the Dialog table. For more information on adding a dialog box or billboard to a user interface, see Using the User Interface.
Reserved Dialog Box Names
The following dialog box names are reserved by Windows Installer and should not be used for any user-authored custom dialog boxes. The installer requires that these dialog boxes be listed in the Dialog table using the following reserved names. Each dialog box and name can only be listed once. Developers must author these dialog boxes into the user interface. For information about how to preview dialog boxes, see Importing the User Interface.
Dialog box name | Brief description of dialog box |
---|---|
FilesInUse Dialog | Alerts user to processes overwriting or deleting files. |
FirstRun Dialog | Collects user name, company name, and product ID. |
MsiRMFilesInUse Dialog | Alerts the user to processes overwriting or deleting files and gives the user the option to use the Restart Manager to close and restart applications. |
Required Dialog Boxes
During the installation, certain events cause Windows Installer to check the user interface sequence tables in the package and display the specified dialog box. For example, in the case of a fatal error, Windows Installer displays the dialog box that is listed with a sequence number of -3 in the user interface sequence table regardless of what that dialog box is named in the Dialog table. The following table lists the specific events and their corresponding sequence number in the user interface sequence table:
Type of Event | User interface sequence table sequence number | Description of dialog box |
---|---|---|
Fatal error | -3 | The installation was terminated by a fatal error. |
User exit | -2 | The installation was terminated at the user's request. |
Exit | -1 | The installation completed successfully. |
In addition, the package author must create a generic dialog box to display Windows Installer error messages. This dialog box can be named anything, but this name must be specified in the ErrorDialog property.
Typical Dialog Boxes
The following dialog boxes are optional and are commonly included in the authored user interface of an installation package. These dialogs are typical of most user interface wizards for installing files. These dialog boxes can have any name in the Dialog table. The names shown are only recommended for clarity and can be modified as necessary. For example, two different custom LicenseAgreement dialog boxes can be used in the package and distinguished in the Dialog table by the names ProfessionalLicenseAgreement and LimitedLicenseAgreement.
Dialog box type | Brief description of dialog box |
---|---|
DiskCost dialog box | Indicates insufficient disk space for the installation. |
Browse dialog box | Enables user to select a directory. |
Cancel dialog box | Confirms a request to terminate the installation. |
License agreement dialog box | Modal box displaying the license agreement. |
Selection dialog box | Modal box enabling the user to select items. |