WixUI Dialogs

Windows Installer XML (WiX) v3.0

WixUI Dialogs

The following table describes each of the built-in dialogs that is defined in the WixUI dialog library.

Dialog Name Description
AdvancedWelcomeEulaDlg A dialog that displays the end user license agreement. Unlike the LicenseAgreementDlg, it has Advanced and Install buttons instead of Next and Back buttons. This dialog is used by the WixUI_Advanced dialog set to provide the user with a quick way to perform a default installation.
BrowseDlg A dialog that allows the user to browse for a destination folder.
CancelDlg A dialog that appears after the user clicks a Cancel button on any dialog and confirms whether or not the user really wants to cancel the installation.
CustomizeDlg A dialog that displays a feature selection tree with a Browse button, Disk Usage button, and a text box that contains information about the currently selected feature.
DiskCostDlg A dialog that allows the user to select which drive to install to and that displays disk space usage information for each drive.
ErrorDlg A dialog that displays an error message to the user and can provide an option to retry the previous action.
ExitDlg A dialog that displays a summary dialog after setup completes successfully. It can also optionally display a checkbox and custom text. For details about how to add a checkbox and custom text to this dialog, see Customizing Built-in WixUI Dialog Sets and How To: Run the Installed Application After Setup.
FatalError A dialog that displays a summary error dialog if setup fails.
FeaturesDlg A dialog that displays a feature selection tree with a text box that contains information about the currently selected feature. Unlike the CustomizeDlg, it does not contain Browse or Disk Space buttons.
FilesInUse A dialog that displays a list of applications that are holding files in use that need to be updated by the current installation process. It includes Retry, Ignore and Exit buttons.
InstallDirDlg A dialog that has a text box that allows the user to type in a non-default installation path and a Browse button that allows the user to select a non-default installation folder. By default, the InstallDirDlg dialog validates that any path the user enters is valid for Windows Installer: That is, it's a path on a local hard drive, not a network path or on a removable drive. If you wish to disable path validation and allow invalid paths, set the public property WIXUI_DONTVALIDATEPATH to 1.
InstallScopeDlg A dialog that allows the user to choose to install the product for all users or for the current user.
InvalidDirDlg A dialog that displays an error if the user selects an invalid installation directory.
LicenseAgreementDlg A dialog that displays the end user license agreement and includes Back and Next buttons. Unlike the AdvancedWelcomeEulaDlg, this dialog does not allow the user to start a default installation.
MaintenanceTypeDlg A dialog that includes buttons that allow the user to change which features are installed, repair the product or remove the product. It only appears when the user runs setup after a product has been installed.
MaintenanceWelcomeDlg An introductory dialog that appears when running setup after the product has been installed.
MsiRMFilesInUse A dialog that is similar to the FilesInUse dialog, but that interacts with Restart Manager. It allows the user to attempt to automatically close applications or ignore the prompt and result in the setup requiring a reboot after it completes.
OutOfDiskDlg A dialog that informs the user that they have insufficient disk space on the selected drive and advises them to free up additional disk space or reduce the number of features to be installed to the drive.
OutOfRbDiskDlg A dialog that is similar to the OutOfDiskDlg, but also allows the user to disable Windows Installer rollback functionality in order to conserve disk space required by setup.
PrepareDlg A simple progress dialog that appears during setup initialization before the first interactive dialog appears.
ProgressDlg A dialog that appears during installation that displays a progress bar and messages about actions are being performed.
ResumeDlg An introductory dialog that appears when resuming a suspended setup.
SetupTypeDlg A dialog that allows the user to choose Typical, Custom or Complete installation configurations.
UserExit A dialog that that is similar to the FatalError dialog. It displays a summary dialog if the user chooses to cancel setup.
VerifyReadyDlg A dialog that appears immediately before starting installation. It asks the user for final confirmation before starting to make changes to the system.
WaitForCostingDlg A dialog that appears if the user advances too far in the setup wizard before Windows Installer has finished calculating disk cost requirements.
WelcomeDlg An introductory dialog that appears when running setup for a product that has not yet been installed.
WelcomeEulaDlg A dialog that displays an end user license agreement and allows the user to start installation after accepting the agreement. It is only used by the WixUI_Minimal dialog set and is intended for simple setup programs that do not offer any user configurable options.