WiXBundleBuilder

The WiXBundleBuilder type allows building simple bundle installers with the WiX Toolset.

WiXBundleBuilder instances allow you to create .exe installers that are composed of a chain of actions. At execution time, each action in the chain is evaluated. See the WiX Toolset documentation for more.

Constructors

WiXBundleBuilder()

WiXBundleBuilder() is called to construct new instances. It accepts the following arguments:

id_prefix

(string) The string prefix to add to auto-generated IDs in the .wxs XML.

The value must be alphanumeric and - cannot be used.

The value should reflect the application whose installer is being defined.

name

(string) The name of the application being installed.

version

(string) The version of the application being installed.

This is a string like X.Y.Z, where each component is an integer.

manufacturer

(string) The author of the application.

Methods

Sections below document methods available on WiXBundleBuilder instances.

WiXBundleBuilder.add_condition()

Defines a <bal:Condition> that must be satisfied to run this installer.

See the WiX Toolkit documentation for more.

This method accepts the following arguments:

condition

(string) The condition expression that must be satisfied.

message

(string) The message that will be displayed if the condition is not met.

WiXBundleBuilder.add_vc_redistributable()

This method registers the Visual C++ Redistributable to be installed.

This method accepts the following arguments:

platform

(string) The architecture to install for. Valid values are x86, x64, and arm64.

The bundle can contain Visual C++ Redistributables for multiple runtime architectures. The bundle installer will only install the Redistributable when running on a machine of that architecture. This allows a single bundle installer to target multiple architectures.

WiXBundleBuilder.add_wix_msi_builder()

This method adds a WiXMSIBuilder to be installed by the produced installer.

This method accepts the following arguments:

builder

(WiXMSIBuilder) The WiXMSIBuilder representing an MSI to install.

display_internal_ui

(Optional[bool]) Whether to display the UI of the MSI. This is False by default.

install_condition

(Optional[string]) An expression that must be true for this MSI to be installed.

This method effectively coerces the WiXMSIBuilder instance to an <MsiPackage> element and adds it to the <Chain> in the bundle XML. See the WiX Toolset documentation for more.

WiXBundleBuilder.build()

This method will build an exe using the WiX Toolset.

This method accepts the following arguments:

target

(string) The name of the target being built.