Using Built-in WixUI Dialog Sets

The WixUI dialog library contains the following built-in dialog sets that provide a familiar wizard-style setup user interface.

  1. WixUI_Advanced
  2. WixUI_FeatureTree
  3. WixUI_InstallDir
  4. WixUI_Minimal
  5. WixUI_Mondo

The built-in WixUI dialog sets are also customizable, from the bitmaps shown in the UI to adding and removing custom dialogs. See Customizing the WixUI Dialog Sets for additional information.

How to add a built-in WixUI dialog set to a product installer

Assuming you have an existing installer that is functional but is just lacking a user interface, here are the steps you need to follow to include a built-in WixUI dialog set:

  1. Add a UIRef element to your setup authoring that has an Id that matches the name of one of the dialog sets described above. For example:
    <Product ...>
    <UIRef Id="WixUI_InstallDir" />
    </Product>
    
  2. Pass the -ext and -cultures switches to light.exe to reference the WixUIExtension. For example:
    light -ext WixUIExtension -cultures:en-us Product.wixobj -out Product.msi
    

    Note - If you are using WiX in Visual Studio you can add the WixUIExtension using the Add Reference dialog and the necessary command lines will automatically be added when linking your .msi. To do this, use the following steps:

    1. Open your WiX project in Visual Studio
    2. Right click on your project in Solution Explorer and select Add Reference...
    3. Select the WixUIExtension.dll assembly from the list and click Add
    4. Close the Add Reference dialog