Description

Schema for describing Windows Installer database files (.msi/.msm/.pcp).

Remarks

Copyright (c) Microsoft Corporation. All rights reserved.

The use and distribution terms for this software are covered by the Common Public License 1.0 (http://opensource.org/licenses/cpl.php) which can be found in the file CPL.TXT at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license.

You must not remove this notice, or any other, from this software.

See Also

Elements | Attributes | Complex Types | Simple Types

Elements

Name	Description
AdminExecuteSequence
AdminUISequence
AdvertiseExecuteSequence
AllocateRegistrySpace	Ensures the needed amount of space exists in the registry.
AppData	Optional way for defining AppData, generally used for complex CDATA.
AppId	Application ID containing DCOM information for the associated application GUID.
AppSearch	Uses file signatures to search for existing versions of products.
AssemblyName	The MsiAssemblyName table specifies the schema for the elements of a strong assembly cache name for a .NET Framework or Win32 assembly.
Billboard	Billboard to display during install of a Feature
BillboardAction	Billboard action during which child Billboards are displayed
Binary	Binary data used for CustomAction elements and UI controls.
BinaryRef	Used only for PatchFamilies to include only a binary table entry in a patch.
BindImage	Binds each executable or DLL that must be bound to the DLLs imported by it.
Category	Qualified published component for parent Component
CCPSearch	Uses file signatures to validate that qualifying products are installed on a system before an upgrade installation is performed.
Class	COM Class registration for parent Component.
Column	Column definition for a Custom Table
ComboBox	Set of items for a particular ComboBox control tied to an install Property
ComplianceCheck	Adds a row to the CCPSearch table.
ComplianceDrive	Sets the parent of a nested DirectorySearch element to CCP_DRIVE.
Component	Component for parent Directory
ComponentGroup	Groups together multiple components to be used in other locations.
ComponentGroupRef	Create a reference to a ComponentGroup in another Fragment.
ComponentRef	Create a reference to a Feature element in another Fragment.
ComponentSearch	Searches for file or directory and assigns to value of parent Property.
Condition	Conditions for components, controls, features, and products.
Configuration	Defines the configurable attributes of merge module.
ConfigurationData	Data to use as input to a configurable merge module.
Control	Contains the controls that appear on each dialog.
CopyFile	Copy or move an existing file on the target machine, or copy a file that is being installed, to another destination.
CostFinalize	Ends the internal installation costing process begun by the CostInitialize action.
CostInitialize	Initiates the internal installation costing process.
CreateFolder	Create folder as part of parent Component.
CreateFolders	Creates empty folders for components that are set to be installed.
CreateShortcuts	Manages the creation of shortcuts.
Custom	Use to sequence a custom action.
CustomAction	Specifies a custom action to be added to the MSI CustomAction table.
CustomActionRef	This will cause the entire contents of the Fragment containing the referenced CustomAction to be included in the installer database.
CustomProperty	A custom property for the PatchMetadata table.
CustomTable	Defines a custom table for use from a custom action.
Data	Used for a Custom Table. Specifies the data for the parent Row and specified Column.
DeleteServices	Stops a service and removes its registration from the system.
Dependency	Declares a dependency on another merge module.
Dialog	Defines a dialog box in the Dialog Table.
DialogRef	Reference to a Dialog.
DigitalCertificate	Adds a digital certificate.
DigitalSignature	Adds a digital signature.
Directory	Directory layout for the product.
DirectoryRef	Create a reference to a Directory element in another Fragment.
DirectorySearch	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	References an existing DirectorySearch element.
DisableRollback	Disables rollback for the remainder of the installation.
DuplicateFiles	Duplicates files installed by the InstallFiles action.
EmbeddedChainer
EmbeddedChainerRef	Reference to an EmbeddedChainer element.
EmbeddedUI	Element value is the condition.
EmbeddedUIResource	Defines a resource for use by the embedded UI.
EnsureTable	Use this element to ensure that a table appears in the installer database, even if its empty.
Environment	Environment variables added or removed for the parent component.
Error
Exclusion	Declares a merge module with which this merge module is incompatible.
ExecuteAction	Initiates the execution sequence.
Extension	Extension for a Component
ExternalFile	Contains information about specific files that are not part of a regular target image.
Family	Group of one or more upgraded images of a product.
Feature	A feature for the Feature table.
FeatureGroup	Groups together multiple components, features, and merges to be used in other locations.
FeatureGroupRef	Create a reference to a FeatureGroup in another Fragment.
FeatureRef	Create a reference to a Feature element in another Fragment.
File	File specification for File table, must be child node of Component.
FileCost	Initiates dynamic costing of standard installation actions.
FileSearch	Searches for file and assigns to fullpath value of parent Property
FileSearchRef	References an existing FileSearch element.
FileTypeMask	FileType data for class Id registration.
FindRelatedProducts	Runs through each record of the Upgrade table in sequence and compares the upgrade code, product version, and language in each row to products installed on the system.
ForceReboot	Prompts the user for a restart of the system during the installation.
Fragment	The Fragment element is the building block of creating an installer database in WiX.
Icon	Icon used for Shortcut, ProgId, or Class elements (but not UI controls)
IconRef	Used only for PatchFamilies to include only a icon table entry in a patch.
IgnoreModularization	This element has been deprecated.
IgnoreRange	Specifies part of a file that is to be ignored during patching.
IgnoreTable	Specifies a table from the merge module that is not merged into an .msi file.
Include	This is the top-level container element for every wxi file.
IniFile	Adds or removes .ini file entries.
IniFileSearch	Searches for file, directory or registry key and assigns to value of parent Property
InstallAdminPackage	Copies the product database to the administrative installation point. The condition for this action may be specified in the element's inner text.
InstallExecute	Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.
InstallExecuteAgain	Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.
InstallExecuteSequence
InstallFiles	Copies files specified in the File table from the source directory to the destination directory.
InstallFinalize	Marks the end of a sequence of actions that change the system.
InstallInitialize	Marks the beginning of a sequence of actions that change the system.
InstallODBC	Installs the drivers, translators, and data sources in the ODBCDriver table, ODBCTranslator table, and ODBCDataSource table.
InstallServices	Registers a service for the system.
InstallUISequence
InstallValidate	Verifies that all costed volumes have enough space for the installation.
Instance	Defines an instance transform for your product.
InstanceTransforms	Use this element to contain definitions for instance transforms.
Interface	COM Interface registration for parent Typelib.
IsolateComponent	Shared Component to be privately replicated in folder of parent Component
IsolateComponents	Installs a copy of a component (commonly a shared DLL) into a private location for use by a specific application (typically an .exe).
LaunchConditions	Queries the LaunchCondition table and evaluates each conditional statement recorded there.
ListBox	Set of items for a particular ListBox control tied to an install Property
ListItem	The value (and optional text) associated with an item in a ComboBox, ListBox, or ListView.
ListView	Set of items for a particular ListView control tied to an install Property
Media	Media element describes a disk that makes up the source media for the installation.
Merge	Merge directive to bring in a merge module that will be redirected to the parent directory.
MergeRef	Merge reference to connect a Merge Module to parent Feature
MigrateFeatureStates	Used for upgrading or installing over an existing application.
MIME	MIME content-type for an Extension
Module	The Module element is analogous to the main function in a C program.
MoveFiles	Locates existing files on the system and moves or copies those files to a new location.
MsiPublishAssemblies	Manages the advertisement of CLR and Win32 assemblies.
MsiUnpublishAssemblies	Manages the unadvertisement of CLR and Win32 assemblies that are being removed.
MultiStringValue	Use several of these elements to specify each registry value in a multiString registry value.
ODBCDataSource	ODBCDataSource for a Component
ODBCDriver	ODBCDriver for a Component
ODBCTranslator	ODBCTranslator for a Component
OptimizeCustomActions	Indicates whether custom actions can be skipped when applying the patch.
Package	Properties about the package to be placed in the Summary Information Stream.
Patch	The Patch element is analogous to the main function in a C program.
PatchBaseline	Identifies a set of product versions.
PatchCertificates	Identifies the possible signer certificates used to digitally sign patches.
PatchCreation	The PatchCreation element is analogous to the main function in a C program.
PatchFamily	Collection of items that should be kept from the differences between two products.
PatchFamilyRef	This will cause the entire contents of the Fragment containing the referenced PatchFamily to be used in the process of creating a patch.
PatchFiles	Queries the Patch table to determine which patches are to be applied.
PatchInformation	Properties about the patch to be placed in the Summary Information Stream.
PatchMetadata	Properties about the patch to be placed in the PatchMetadata table.
PatchProperty	A property for this patch database.
PatchSequence	Sequence information for this patch database.
Permission	Sets ACLs on File, Registry, or CreateFolder.
ProcessComponents	Registers and unregisters components, their key paths, and the component clients.
Product	The Product element is analogous to the main function in a C program.
ProgId	ProgId registration for parent Component.
ProgressText
Property	Property value for a Product or Module.
PropertyRef	Reference to a Property value.
ProtectFile	Specifies a file to be protected.
ProtectRange	Specifies part of a file that cannot be overwritten during patching.
Publish
PublishComponents	Manages the advertisement of the components from the PublishComponent table.
PublishFeatures	Writes each feature's state into the system registry.
PublishProduct	Manages the advertisement of the product information with the system.
RadioButton	Text or Icon plus Value that is assigned to the Property of the parent Control (RadioButtonGroup).
RadioButtonGroup	Set of radio buttons tied to the specified Property
RegisterClassInfo	Manages the registration of COM class information with the system.
RegisterComPlus	Registers COM+ applications.
RegisterExtensionInfo	Manages the registration of extension related information with the system.
RegisterFonts	Registers installed fonts with the system.
RegisterMIMEInfo	Registers MIME-related registry information with the system.
RegisterProduct	Registers the product information with the installer.
RegisterProgIdInfo	Manages the registration of OLE ProgId information with the system.
RegisterTypeLibraries	Registers type libraries with the system.
RegisterUser	Registers the user information with the installer to identify the user of a product.
Registry
RegistryKey	Used for organization of child RegistryValue elements or to create a registry key (and optionally remove it during uninstallation).
RegistrySearch	Searches for file, directory or registry key and assigns to value of parent Property
RegistrySearchRef	References an existing RegistrySearch element.
RegistryValue	Used to create a registry value. For multi-string values, this can be used to prepend or append values.
RemoveDuplicateFiles	Deletes files installed by the DuplicateFiles action.
RemoveEnvironmentStrings	Modifies the values of environment variables.
RemoveExistingProducts	Goes through the product codes listed in the ActionProperty column of the Upgrade table and removes the products in sequence.
RemoveFile	Remove a file(s) if the parent component is selected for installation or removal.
RemoveFiles	Removes files previously installed by the InstallFiles action.
RemoveFolder	Remove an empty folder if the parent component is selected for installation or removal.
RemoveFolders	Removes any folders linked to components set to be removed or run from source.
RemoveIniValues	Removes .ini file information specified for removal in the RemoveIniFile table if the component is set to be installed locally or run from source.
RemoveODBC	Removes the data sources, translators, and drivers listed for removal during the installation.
RemoveRegistryKey	Used for removing registry keys and all child keys either during install or uninstall.
RemoveRegistryValue	Used to remove a registry value during installation.
RemoveRegistryValues	Removes a registry value that has been authored into the registry table if the associated component was installed locally or as run from source, and is now set to be uninstalled.
RemoveShortcuts	Manages the removal of an advertised shortcut whose feature is selected for uninstallation or a nonadvertised shortcut whose component is selected for uninstallation.
ReplacePatch	A patch that is deprecated by this patch.
ReserveCost	Disk cost to reserve in a folder for running locally and/or from source.
ResolveSource	Determines the location of the source and sets the SourceDir property if the source has not been resolved yet.
RMCCPSearch	Uses file signatures to validate that qualifying products are installed on a system before an upgrade installation is performed.
Row	Row data for a Custom Table
ScheduleReboot	Prompts the user to restart the system at the end of installation.
SelfRegModules	Processes all modules listed in the SelfReg table and registers all installed modules with the system.
SelfUnregModules	Unregisters all modules listed in the SelfReg table that are scheduled to be uninstalled.
ServiceArgument	Argument used in ServiceControl parent
ServiceControl	Starts, stops, and removes services for parent Component.
ServiceDependency	Service or group of services that must start before the parent service.
ServiceInstall	Adds and removes services for parent Component.
SetDirectory	Sets a Directory to a particular value.
SetODBCFolders	Checks for existing ODBC drivers and sets the target directory for each new driver to the location of an existing driver.
SetProperty	Sets a Property to a particular value.
SFPCatalog	Adds a system file protection update catalog file
SFPFile	Provides a many-to-many mapping from the SFPCatalog table to the File table
Shortcut	Shortcut, default target is parent File, CreateFolder, or Component's Directory
Show
StartServices	Starts system services.
StopServices	Stops system services.
Subscribe	Sets attributes for events in the EventMapping table
Substitution	Specifies the configurable fields of a module database and provides a template for the configuration of each field.
SymbolPath	A path to symbols.
TargetFile	Information about specific files in a target image.
TargetImage	Contains information about the target images of the product.
TargetProductCode	A product code for a product that may receive this patch (or '*' for all products).
Text	An alternative to using the Text attribute when the value contains special XML characters like <, >, or &.
TextStyle
TypeLib	Register a type library (TypeLib).
UI	Enclosing element to compartmentalize UI specifications.
UIRef	Reference to a UI element. This will force the entire referenced Fragment's contents to be included in the installer database.
UIText	Text associated with certain controls
UnpublishComponents	Manages the unadvertisement of components listed in the PublishComponent table.
UnpublishFeatures	Removes selection-state and feature-component mapping information from the registry.
UnregisterClassInfo	Manages the removal of COM class information from the system registry.
UnregisterComPlus	Removes COM+ applications from the registry.
UnregisterExtensionInfo	Manages the removal of extension-related information from the system registry.
UnregisterFonts	Removes registration information about installed fonts from the system.
UnregisterMIMEInfo	Unregisters MIME-related registry information from the system.
UnregisterProgIdInfo	Manages the unregistration of OLE ProgId information with the system.
UnregisterTypeLibraries	Unregisters type libraries from the system.
Upgrade	Upgrade info for a particular UpgradeCode
UpgradeFile	Specifies files to either ignore or to specify optional data about a file.
UpgradeImage	Contains information about the upgraded images of the product.
UpgradeVersion
Validate	Sets information on the patch transform that determines to which product the transform applies and what errors should be ignored when applying the patch transform.
ValidateProductID	Sets the ProductID property to the full product identifier.
Verb	Verb definition for an Extension.
Wix	This is the top-level container element for every wxs file.
WixVariable	This element exposes advanced WiX functionality.
WriteEnvironmentStrings	Modifies the values of environment variables.
WriteIniValues	Writes the .ini file information that the application needs written to its .ini files.
WriteRegistryValues	Sets up an application's registry information.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
CostFinalize	ActionSequenceType	Ends the internal installation costing process begun by the CostInitialize action.
CostInitialize	ActionSequenceType	Initiates the internal installation costing process.
Custom	string (extension)	Use to sequence a custom action.
FileCost	ActionSequenceType	Initiates dynamic costing of standard installation actions.
InstallAdminPackage	ActionSequenceType	Copies the product database to the administrative installation point. The condition for this action may be specified in the element's inner text.
InstallFiles	ActionSequenceType	Copies files specified in the File table from the source directory to the destination directory.
InstallFinalize	ActionSequenceType	Marks the end of a sequence of actions that change the system.
InstallInitialize	ActionSequenceType	Marks the beginning of a sequence of actions that change the system.
InstallValidate	ActionSequenceType	Verifies that all costed volumes have enough space for the installation.
LaunchConditions	ActionModuleSequenceType	Queries the LaunchCondition table and evaluates each conditional statement recorded there.
ResolveSource	ActionModuleSequenceType	Determines the location of the source and sets the SourceDir property if the source has not been resolved yet.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
CostFinalize	ActionSequenceType	Ends the internal installation costing process begun by the CostInitialize action.
CostInitialize	ActionSequenceType	Initiates the internal installation costing process.
Custom	string (extension)	Use to sequence a custom action.
ExecuteAction	ActionSequenceType	Initiates the execution sequence.
FileCost	ActionSequenceType	Initiates dynamic costing of standard installation actions.
InstallAdminPackage	ActionSequenceType	Copies the product database to the administrative installation point. The condition for this action may be specified in the element's inner text.
InstallFiles	ActionSequenceType	Copies files specified in the File table from the source directory to the destination directory.
InstallFinalize	ActionSequenceType	Marks the end of a sequence of actions that change the system.
InstallInitialize	ActionSequenceType	Marks the beginning of a sequence of actions that change the system.
InstallValidate	ActionSequenceType	Verifies that all costed volumes have enough space for the installation.
LaunchConditions	ActionModuleSequenceType	Queries the LaunchCondition table and evaluates each conditional statement recorded there.
Show	string (extension)

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
CostFinalize	ActionSequenceType	Ends the internal installation costing process begun by the CostInitialize action.
CostInitialize	ActionSequenceType	Initiates the internal installation costing process.
CreateShortcuts	ActionSequenceType	Manages the creation of shortcuts.
Custom	string (extension)	Use to sequence a custom action.
InstallFinalize	ActionSequenceType	Marks the end of a sequence of actions that change the system.
InstallInitialize	ActionSequenceType	Marks the beginning of a sequence of actions that change the system.
InstallValidate	ActionSequenceType	Verifies that all costed volumes have enough space for the installation.
MsiPublishAssemblies	ActionSequenceType	Manages the advertisement of CLR and Win32 assemblies.
PublishComponents	ActionSequenceType	Manages the advertisement of the components from the PublishComponent table.
PublishFeatures	ActionSequenceType	Writes each feature's state into the system registry.
PublishProduct	ActionSequenceType	Manages the advertisement of the product information with the system.
RegisterClassInfo	ActionSequenceType	Manages the registration of COM class information with the system.
RegisterExtensionInfo	ActionSequenceType	Manages the registration of extension related information with the system.
RegisterMIMEInfo	ActionSequenceType	Registers MIME-related registry information with the system.
RegisterProgIdInfo	ActionSequenceType	Manages the registration of OLE ProgId information with the system.

Description

Ensures the needed amount of space exists in the registry.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Description

Optional way for defining AppData, generally used for complex CDATA.

Derived By

Type string

Description

Application ID containing DCOM information for the associated application GUID.

Derived By

Restricting anyType

Attributes

Name	Type	Description
ActivateAtStorage	YesNoType	Set this value to 'yes' to configure the client to activate on the same system as persistent storage.
Advertise	YesNoType	Set this value to 'yes' in order to create a normal AppId table row. Set this value to 'no' in order to generate Registry rows that perform similar registration (without the often problematic Windows Installer advertising behavior).
Description	string	Set this value to the description of the AppId.
DllSurrogate	string	Set this value to specify that the class is a DLL that is to be activated in a surrogate EXE process, and the surrogate process to be used is the path of a surrogate EXE file specified by the value.
Id	Guid	Set this value to the AppID GUID that corresponds to the named executable.
LocalService	string	Set this value to the name of a service to allow the object to be installed as a Win32 service.
RemoteServerName	string	Set this value to the name of the remote server to configure the client to request the object be run at a particular machine whenever an activation function is called for which a COSERVERINFO structure is not specified.
RunAsInteractiveUser	YesNoType	Set this value to 'yes' to configure a class to run under the identity of the user currently logged on and connected to the interactive desktop when activated by a remote client without being written as a Win32 service.
ServiceParameters	string	Set this value to the parameters to be passed to a LocalService on invocation.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
Class	anyType (restriction)	COM Class registration for parent Component.

Remarks

If this element is nested under a Fragment, Module, or Product element, it must be advertised.

Description

Uses file signatures to search for existing versions of products.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The AppSearch action may use this information to determine where upgrades are to be installed. The AppSearch action can also be used to set a property to the existing value of an registry or .ini file entry. AppSearch should be authored into the InstallUISequence table and InstallExecuteSequence table. The installer prevents The AppSearch action from running in the InstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. The AppSearch action searches for file signatures using the CompLocator table first, the RegLocator table next, then the IniLocator table, and finally the DrLocator table. The condition for this action may be specified in the element's inner text.

Description

The MsiAssemblyName table specifies the schema for the elements of a strong assembly cache name for a .NET Framework or Win32 assembly.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Name of the attribute associated with the value specified in the Value column.
Value	string	Value associated with the name specified in the Name column.

Content Model

Always empty.

Remarks

Consider using the Assembly attribute on File element to have the toolset populate these entries automatically.

Description

Billboard to display during install of a Feature

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier for the Billboard.
Feature	string	Feature whose state determines if the Billboard is shown.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
Control	anyType (restriction)	Contains the controls that appear on each dialog.

Description

Billboard action during which child Billboards are displayed

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Action name that determines when the Billboard should be shown.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
Billboard	anyType (restriction)	Billboard to display during install of a Feature

Description

Binary data used for CustomAction elements and UI controls.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The Id cannot by longer than 55 characters.
SourceFile	string	Path to the binary file.
src	string
SuppressModularization	YesNoType	Use to suppress modularization of this Binary identifier in merge modules.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.

Description

Used only for PatchFamilies to include only a binary table entry in a patch.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the Binary element to reference.

Content Model

Always empty.

Description

Binds each executable or DLL that must be bound to the DLLs imported by it.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Description

Qualified published component for parent Component

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	Guid	A string GUID that represents the category of components being grouped together.
Qualifier	string	A text string that qualifies the value in the Id attribute.
AppData	string	An optional localizable text describing the category.
Feature	string	Feature that controls the advertisement of the category.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
AppData	string	Optional way for defining AppData, generally used for complex CDATA.

Description

Uses file signatures to validate that qualifying products are installed on a system before an upgrade installation is performed.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The CCPSearch action should be authored into the InstallUISequence table and InstallExecuteSequence table. The installer prevents the CCPSearch action from running in the InstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. The CCPSearch action must come before the RMCCPSearch action. The condition for this action may be specified in the element's inner text.

Description

COM Class registration for parent Component.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	Guid	The Class identifier (CLSID) of a COM server.
Context	anySimpleType (list)	The server context(s) for this server.
Description	string	Localized description associated with the Class ID and Program ID.
AppId	Guid	This attribute is only allowed when a Class is advertised.
Icon	string	The file providing the icon associated with this CLSID.
IconIndex	integer	Icon index into the icon file.
Handler	string	The default inproc handler.
Argument	string	This column is optional only when the Context column is set to "LocalServer" or "LocalServer32" server context.
RelativePath	YesNoType	When the value is "yes", the bare file name can be used for COM servers.
Advertise	YesNoType	Set this value to "yes" in order to create a normal Class table row. Set this value to "no" in order to generate Registry rows that perform similar registration (without the often problematic Windows Installer advertising behavior).
ThreadingModel	NMTOKEN (restriction)	Threading model for the CLSID.
Version	string	Version for the CLSID.
Insertable	YesNoType	Specifies the CLISD may be insertable.
Programmable	YesNoType	Specifies the CLSID may be programmable.
Server	string	May only be specified if the value of the Advertise attribute is "no".
ShortPath	YesNoType	Specifies whether or not to use the short path for the COM server.
SafeForScripting	YesNoType	May only be specified if the value of the Advertise attribute is "no".
SafeForInitializing	YesNoType	May only be specified if the value of the Advertise attribute is "no".
Control	YesNoType	Set this attribute's value to 'yes' to identify an object as an ActiveX Control.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
FileTypeMask	anyType (restriction)	FileType data for class Id registration.
Interface	anyType (restriction)	COM Interface registration for parent Typelib.
ProgId	anyType (restriction)	ProgId registration for parent Component.

Description

Column definition for a Custom Table

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for the column.
PrimaryKey	YesNoType	Whether this column is a primary key.
Type	NMTOKEN (restriction)	The type of this column.
Width	integer	Width of this column.
Nullable	YesNoType	Whether this column can be left null.
Localizable	YesNoType	Whether this column can be localized.
MinValue	integer	Minimum value for a numeric value, date or version in this column.
MaxValue	integer	Maximum value for a numeric value, date or version in this column.
KeyTable	string	Table in which this column is an external key.
KeyColumn	integer	Column in the table in KeyTable attribute.
Category	NMTOKEN (restriction)	Category of this column.
Set	string	Semicolon delimited list of permissible values.
Description	string	Description of this column.
Modularize	NMTOKEN (restriction)	How this column should be modularized, if at all.

Content Model

Always empty.

Description

Set of items for a particular ComboBox control tied to an install Property

Derived By

Restricting anyType

Attributes

Name	Type	Description
Property	string	Property tied to this group

Content Model

Contains elements as defined in the following table.

Component	Type	Description
ListItem	anyType (restriction)	The value (and optional text) associated with an item in a ComboBox, ListBox, or ListView.

Description

Adds a row to the CCPSearch table.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
ComplianceDrive	anyType (restriction)	Sets the parent of a nested DirectorySearch element to CCP_DRIVE.
ComponentSearch	anyType (restriction)	Searches for file or directory and assigns to value of parent Property.
RegistrySearch	anyType (restriction)	Searches for file, directory or registry key and assigns to value of parent Property
IniFileSearch	anyType (restriction)	Searches for file, directory or registry key and assigns to value of parent Property
DirectorySearch	anyType (restriction)	Searches for directory and assigns to value of parent Property.

Description

Sets the parent of a nested DirectorySearch element to CCP_DRIVE.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
DirectorySearch	anyType (restriction)	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	anyType (restriction)	References an existing DirectorySearch element.

Description

Component for parent Directory

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Component identifier; this is the primary key for identifying components.
ComPlusFlags	integer	Set this attribute to create a ComPlus entry.
DisableRegistryReflection	YesNoType	Set this attribute to 'yes' in order to disable registry reflection on all existing and new registry keys affected by this component.
Directory	string	Sets the Directory of the Component.
DiskId	integer	This attribute must be set either on a Component element or all of its children File elements.
Feature	string	Identifies a feature to which this component belongs, as a shorthand for a child ComponentRef element of the Feature element.
Guid	ComponentGuid	This value should be a guid that uniquely identifies this component's contents, language, platform, and version.
KeyPath	YesNoType	If this attribute's value is set to 'yes', then the Directory of this Component is used as the KeyPath.
Location	NMTOKEN (restriction)
NeverOverwrite	YesNoType	If this attribute is set to 'yes', the installer does not install or reinstall the component if a key path file or a key path registry entry for the component already exists.
Permanent	YesNoType	If this attribute is set to 'yes', the installer does not remove the component during an uninstall.
Shared	YesNoType	If this attribute's value is set to 'yes', enables advanced patching semantics for Components that are shared across multiple Products.
SharedDllRefCount	YesNoType	If this attribute's value is set to 'yes', the installer increments the reference count in the shared DLL registry of the component's key file.
Transitive	YesNoType	If this attribute is set to 'yes', the installer reevaluates the value of the statement in the Condition upon a reinstall.
UninstallWhenSuperseded	YesNoType	If this attribute is set to 'yes', the installer will uninstall the Component's files and registry keys when it is superseded by a patch.
Win64	YesNoType	Set this attribute to 'yes' to mark this as a 64-bit component.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
AppId	anyType (restriction)	Application ID containing DCOM information for the associated application GUID.
Category	anyType (restriction)	Qualified published component for parent Component
Class	anyType (restriction)	COM Class registration for parent Component.
Condition	string (extension)	Conditions for components, controls, features, and products.
CopyFile	anyType (restriction)	Copy or move an existing file on the target machine, or copy a file that is being installed, to another destination.
CreateFolder	anyType (restriction)	Create folder as part of parent Component.
Environment	anyType (restriction)	Environment variables added or removed for the parent component.
Extension	anyType (restriction)	Extension for a Component
File	anyType (restriction)	File specification for File table, must be child node of Component.
IniFile	anyType (restriction)	Adds or removes .ini file entries.
Interface	anyType (restriction)	COM Interface registration for parent Typelib.
IsolateComponent	anyType (restriction)	Shared Component to be privately replicated in folder of parent Component
ODBCDataSource	anyType (restriction)	ODBCDataSource for a Component
ODBCDriver	anyType (restriction)	ODBCDriver for a Component
ODBCTranslator	anyType (restriction)	ODBCTranslator for a Component
ProgId	anyType (restriction)	ProgId registration for parent Component.
Registry	anyType (restriction)
RegistryKey	anyType (restriction)	Used for organization of child RegistryValue elements or to create a registry key (and optionally remove it during uninstallation).
RegistryValue	anyType (restriction)	Used to create a registry value. For multi-string values, this can be used to prepend or append values.
RemoveFile	anyType (restriction)	Remove a file(s) if the parent component is selected for installation or removal.
RemoveFolder	anyType (restriction)	Remove an empty folder if the parent component is selected for installation or removal.
RemoveRegistryKey	anyType (restriction)	Used for removing registry keys and all child keys either during install or uninstall.
RemoveRegistryValue	anyType (restriction)	Used to remove a registry value during installation.
ReserveCost	anyType (restriction)	Disk cost to reserve in a folder for running locally and/or from source.
ServiceControl	anyType (restriction)	Starts, stops, and removes services for parent Component.
ServiceInstall	anyType (restriction)	Adds and removes services for parent Component.
Shortcut	anyType (restriction)	Shortcut, default target is parent File, CreateFolder, or Component's Directory
SymbolPath	anyType (restriction)	A path to symbols.
TypeLib	anyType (restriction)	Register a type library (TypeLib).

Description

Groups together multiple components to be used in other locations.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for the ComponentGroup.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Component	anyType (restriction)	Component for parent Directory
ComponentGroupRef	anyType (restriction)	Create a reference to a ComponentGroup in another Fragment.
ComponentRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.

Description

Create a reference to a ComponentGroup in another Fragment.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the ComponentGroup to reference.
Primary	YesNoType	Set this attribute to 'yes' in order to make the parent feature of this component the primary feature for this component.

Content Model

Always empty.

Description

Create a reference to a Feature element in another Fragment.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the Component element to reference.
Primary	YesNoType	Set this attribute to 'yes' in order to make the parent feature of this component the primary feature for this component.

Content Model

Always empty.

Description

Searches for file or directory and assigns to value of parent Property.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string
Guid	Guid	The component ID of the component whose key path is to be used for the search.
Type	NMTOKEN (restriction)	Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
DirectorySearch	anyType (restriction)	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	anyType (restriction)	References an existing DirectorySearch element.
FileSearch	anyType (restriction)	Searches for file and assigns to fullpath value of parent Property
FileSearchRef	anyType (restriction)	References an existing FileSearch element.

Description

Conditions for components, controls, features, and products.

Derived By

Extending string

Attributes

Name	Type	Description
Action	NMTOKEN (restriction)	Used only under Control elements and is required. Allows specific actions to be applied to a control based on the result of this condition.
Level	integer	Used only under Feature elements and is required.
Message	string	Used only under Fragment or Product elements and is required.

Content Model

Contains text only.

Remarks

The condition is specified in the inner text of the element.

Description

Defines the configurable attributes of merge module.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Name	string	Defines the name of the configurable item.
Format	string (restriction)	Specifies the format of the data being changed.
Type	string	Specifies the type of the data being changed.
ContextData	string	Specifies a semantic context for the requested data.
DefaultValue	string	Specifies a default value for the item in this record if the merge tool declines to provide a value.
KeyNoOrphan	YesNoType	Does not merge rule according to rules in MSI SDK.
NonNullable	YesNoType	If yes, null is not a valid entry.
DisplayName	string	Display name for authoring.
Description	string	Description for authoring.
HelpLocation	string	Location of chm file for authoring.
HelpKeyword	string	Keyword into chm file for authoring.

Content Model

Always empty.

Description

Data to use as input to a configurable merge module.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Name	string	Key into the ModuleConfiguration table.
Value	string	Value to be passed to configurable merge module.

Content Model

Always empty.

Description

Contains the controls that appear on each dialog.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Combined with the Dialog Id to make up the primary key of the Control table.
Type	string	The type of the control.
X	LocalizableInteger	Horizontal coordinate of the upper-left corner of the rectangular boundary of the control.
Y	LocalizableInteger	Vertical coordinate of the upper-left corner of the rectangular boundary of the control.
Width	LocalizableInteger	Width of the rectangular boundary of the control.
Height	LocalizableInteger	Height of the rectangular boundary of the control.
Property	string	The name of a defined property to be linked to this control.
Text	string	A localizable string used to set the initial text contained in a control.
Help	string	This attribute is reserved for future use.
ToolTip	string	The string used for the Tooltip.
CheckBoxValue	string	This attribute is only valid for CheckBox Controls.
TabSkip	YesNoType	Set this attribute to "yes" to cause this Control to be skipped in the tab sequence.
Default	YesNoType	Set this attribute to "yes" to cause this Control to be invoked by the return key.
Cancel	YesNoType	Set this attribute to "yes" to cause this Control to be invoked by the escape key.
Hidden	YesNoType	Set this attribute to "yes" to cause the Control to be hidden.
Disabled	YesNoType	Set this attribute to "yes" to cause the Control to be disabled.
Sunken	YesNoType	Set this attribute to "yes" to cause the Control to be sunken.
Indirect	YesNoType	Specifies whether the value displayed or changed by this control is referenced indirectly.
Integer	YesNoType	Set this attribute to "yes" to cause the linked Property value for the Control to be treated as an integer. Otherwise, the Property will be treated as a string.
RightToLeft	YesNoType	Set this attribute to "yes" to cause the Control to display from right to left.
RightAligned	YesNoType	Set this attribute to "yes" to cause the Control to be right aligned.
LeftScroll	YesNoType	Set this attribute to "yes" to cause the scroll bar to display on the left side of the Control.
Transparent	YesNoType	This attribute is only valid for Text Controls.
NoPrefix	YesNoType	This attribute is only valid for Text Controls.
NoWrap	YesNoType	This attribute is only valid for Text Controls.
FormatSize	YesNoType	This attribute is only valid for Text Controls.
UserLanguage	YesNoType	This attribute is only valid for Text Controls.
Multiline	YesNoType	This attribute is only valid for Edit Controls.
Password	YesNoType	This attribute is only valid for Edit Controls.
ProgressBlocks	YesNoType	This attribute is only valid for ProgressBar Controls.
Removable	YesNoType	This attribute is only valid for Volume and Directory Controls.
Fixed	YesNoType	This attribute is only valid for Volume and Directory Controls.
Remote	YesNoType	This attribute is only valid for Volume and Directory Controls.
CDROM	YesNoType	This attribute is only valid for Volume and Directory Controls.
RAMDisk	YesNoType	This attribute is only valid for Volume and Directory Controls.
Floppy	YesNoType	This attribute is only valid for Volume and Directory Controls.
ShowRollbackCost	YesNoType	This attribute is only valid for VolumeCostList Controls.
Sorted	YesNoType	This attribute is only valid for Listbox, ListView, and ComboBox Controls.
ComboList	YesNoType	This attribute is only valid for ComboBox Controls.
Image	YesNoType	This attribute is only valid for RadioButton, PushButton, and Icon Controls.
IconSize	NMTOKEN (restriction)	This attribute is only valid for RadioButton, PushButton, and Icon Controls.
FixedSize	YesNoType	This attribute is only valid for RadioButton, PushButton, and Icon Controls.
Icon	YesNoType	This attribute is only valid for RadioButton and PushButton Controls.
Bitmap	YesNoType	This attribute is only valid for RadioButton and PushButton Controls.
PushLike	YesNoType	This attribute is only valid for RadioButton and Checkbox Controls.
HasBorder	YesNoType	This attribute is only valid for RadioButton Controls.
ElevationShield	YesNoType	This attribute is only valid for PushButton controls.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
Text	string (extension)	An alternative to using the Text attribute when the value contains special XML characters like <, >, or &.
ComboBox	anyType (restriction)	Set of items for a particular ComboBox control tied to an install Property
ListBox	anyType (restriction)	Set of items for a particular ListBox control tied to an install Property
ListView	anyType (restriction)	Set of items for a particular ListView control tied to an install Property
RadioButtonGroup	anyType (restriction)	Set of radio buttons tied to the specified Property
Property	anyType (restriction)	Property value for a Product or Module.
Binary	anyType (restriction)	Binary data used for CustomAction elements and UI controls.
Condition	string (extension)	Conditions for components, controls, features, and products.
Publish	string (extension)
Subscribe	anyType (restriction)	Sets attributes for events in the EventMapping table

Description

Copy or move an existing file on the target machine, or copy a file that is being installed, to another destination.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Primary key used to identify this particular entry.
FileId	string	This attribute cannot be specified if the element is nested under a File element.
SourceDirectory	string	This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified.
SourceProperty	string	This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified.
SourceName	WildCardLongFileNameType	This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified.
DestinationDirectory	string	Set this value to the destination directory where an existing file on the target machine should be moved or copied to.
DestinationProperty	string	Set this value to a property that will have a value that resolves to the full path of the destination directory.
DestinationName	LongFileNameType	In prior versions of the WiX toolset, this attribute specified the short file name.
DestinationLongName	LongFileNameType
DestinationShortName	ShortFileNameType	The short file name of the file in 8.3 format.
Delete	YesNoType	This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified.

Content Model

Always empty.

Remarks

When this element is nested under a File element, the parent file will be installed, then copied to the specified destination if the parent component of the file is selected for installation or removal. When this element is nested under a Component element and no FileId attribute is specified, the file to copy or move must already be on the target machine.

When this element is nested under a Component element and the FileId attribute is specified, the specified file is installed, then copied to the specified destination if the parent component is selected for installation or removal (use this option to control the copy of a file in a different component by the parent component's installation state). If the specified destination directory is the same as the directory containing the original file and the name for the proposed source file is the same as the original, then no action takes place.

Description

Ends the internal installation costing process begun by the CostInitialize action.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action and then call the CostFinalize action to make all final cost calculations available to the installer through the Component table. The CostFinalize action must be executed before starting any user interface sequence which allows the user to view or modify Feature table selections or directories. The CostFinalize action queries the Condition table to determine which features are scheduled to be installed. Costing is done for each component in the Component table. The CostFinalize action also verifies that all the target directories are writable before allowing the installation to continue. The condition for this action may be specified in the element's inner text.

Description

Initiates the internal installation costing process.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action. Then call the CostFinalize action following the CostInitialize action to make all final cost calculations available to the installer through the Component table. The condition for this action may be specified in the element's inner text.

Description

Create folder as part of parent Component.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Directory	string	Identifier of Directory to create.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Permission	anyType (restriction)	Sets ACLs on File, Registry, or CreateFolder.
Shortcut	anyType (restriction)	Shortcut, default target is parent File, CreateFolder, or Component's Directory

Description

Creates empty folders for components that are set to be installed.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Description

Manages the creation of shortcuts.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Description

Use to sequence a custom action.

Derived By

Extending string

Attributes

Name	Type	Description
Action	string	The action to which the Custom element applies.
OnExit	NMTOKEN (restriction)	Mutually exclusive with Before, After, and Sequence attributes
Before	string	The name of the standard or custom action before which this action should be performed. Mutually exclusive with OnExit, After, and Sequence attributes
After	string	The name of the standard or custom action after which this action should be performed.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	The sequence number for this action.

Content Model

Contains text only.

Description

Specifies a custom action to be added to the MSI CustomAction table.

Derived By

Extending string

Attributes

Name	Type	Description
Id	string	The identifier of the custom action.
BinaryKey	string	This attribute is a reference to a Binary element with matching Id attribute.
FileKey	string	This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code in the file after the file is installed.
Property	string	This attribute specifies a reference to a Property element with matching Id attribute that specifies the Property to be used or updated on execution of this custom action.
Directory	string	This attribute specifies a reference to a Directory element with matching Id attribute containing a directory path.
DllEntry	string	This attribute specifies the name of a function in a custom action to execute.
ExeCommand	string	This attribute specifies the command line parameters to supply to an externally run executable.
JScriptCall	string	This attribute specifies the name of the JScript function to execute in a script.
VBScriptCall	string	This attribute specifies the name of the VBScript Subroutine to execute in a script.
Script	NMTOKEN (restriction)	Creates a type 37 or 38 custom action.
SuppressModularization	YesNoType	Use to suppress modularization of this custom action name in merge modules.
Value	string	This attribute specifies a string value to use in the custom action.
Error	string	This attribute specifies an index in the MSI Error table to use as an error message for a type 19 custom action that displays the error message and aborts a product's installation.
Return	NMTOKEN (restriction)	Set this attribute to set the return behavior of the custom action.
Execute	NMTOKEN (restriction)	This attribute indicates the scheduling of the custom action.
Impersonate	YesNoType	This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of the installing user when executing this custom action.
PatchUninstall	YesNoType	This attribute specifies that the Windows Installer, execute the custom action only when a patch is being uninstalled.
Win64	YesNoType	Specifies that a script custom action targets a 64-bit platform.
TerminalServerAware	YesNoType	This attribute specifies controls whether the custom action will impersonate the installing user during per-machine installs on Terminal Server machines.
HideTarget	YesNoType	Ensures the installer does not log the CustomActionData for the deferred custom action.

Content Model

Contains text only.

Remarks

Various combinations of the attributes for this element correspond to different custom action types. For more information about custom actions see the Custom Action Types topic on MSDN.

Description

This will cause the entire contents of the Fragment containing the referenced CustomAction to be included in the installer database.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the CustomAction to reference.

Content Model

Always empty.

Description

A custom property for the PatchMetadata table.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Company	string	The name of the company.
Property	string	The name of the metadata property.
Value	string	Value of the metadata property.

Content Model

Always empty.

Description

Defines a custom table for use from a custom action.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for the custom table.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
Column	anyType (restriction)	Column definition for a Custom Table
Row	anyType (restriction)	Row data for a Custom Table

Description

Used for a Custom Table. Specifies the data for the parent Row and specified Column.

Derived By

Extending string

Attributes

Name	Type	Description
Column	string	Specifies in which column to insert this data.

Content Model

Contains text only.

Description

Stops a service and removes its registration from the system.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Description

Declares a dependency on another merge module.

Derived By

Restricting anyType

Attributes

Name	Type	Description
RequiredId	string	Identifier of the merge module required by the merge module.
RequiredLanguage	integer	Numeric language ID of the merge module in RequiredID.
RequiredVersion	string	Version of the merge module in RequiredID.

Content Model

Always empty.

Description

Defines a dialog box in the Dialog Table.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier for the dialog.
X	integer	Horizontal placement of the dialog box as a percentage of screen width.
Y	integer	Vertical placement of the dialog box as a percentage of screen height.
Width	integer	The width of the dialog box in dialog units.
Height	integer	The height of the dialog box in dialog units.
Title	string	The title of the dialog box.
Hidden	YesNoType	Used to hide the dialog.
Modeless	YesNoType	Used to set the dialog as modeless.
NoMinimize	YesNoType	Used to specify if the dialog can be minimized.
SystemModal	YesNoType	Used to set the dialog as system modal.
KeepModeless	YesNoType	Keep modeless dialogs alive when this dialog is created through DoAction.
TrackDiskSpace	YesNoType	Have the dialog periodically call the installer to check if available disk space has changed.
CustomPalette	YesNoType	Used to specify if pictures in the dialog box are rendered with a custom palette.
RightToLeft	YesNoType	Used to specify if the text in the dialog should be displayed in right to left reading order.
RightAligned	YesNoType	Align text on the right.
LeftScroll	YesNoType	Used to align the scroll bar on the left.
ErrorDialog	YesNoType	Specifies this dialog as an error dialog.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
Control	anyType (restriction)	Contains the controls that appear on each dialog.

Description

Reference to a Dialog.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the Dialog to reference.

Content Model

Always empty.

Remarks

This will cause the entire referenced section's contents
to be included in the installer database.

Description

Adds a digital certificate.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for a certificate file.
SourceFile	string	The path to the certificate file.

Content Model

Always empty.

Description

Adds a digital signature.

Derived By

Restricting anyType

Attributes

Name	Type	Description
SourceFile	string	The path to signature's optional hash file.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
DigitalCertificate	anyType (restriction)	Adds a digital certificate.

Description

Directory layout for the product.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	This value is the unique identifier of the directory entry.
ComponentGuidGenerationSeed	Guid	The Component Guid Generation Seed is a guid that must be used when a Component with the generate guid directive ("*") is not rooted in a standard Windows Installer directory (for example, ProgramFilesFolder or CommonFilesFolder, etc).
DiskId	integer	Sets the default disk identifier for the files contained in this directory.
FileSource	string	Used to set the file system source for this directory's child elements.
LongName	LongFileNameType
LongSource	LongFileNameType
Name	LongFileNameType	The name of the directory.
ShortName	ShortFileNameType	The short name of the directory in 8.3 format.
ShortSourceName	ShortFileNameType	The short name of the directory on the source media in 8.3 format.
SourceName	LongFileNameType	The name of the directory on the source media.
src	string

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Component	anyType (restriction)	Component for parent Directory
Directory	anyType (restriction)	Directory layout for the product.
Merge	anyType (restriction)	Merge directive to bring in a merge module that will be redirected to the parent directory.
SymbolPath	anyType (restriction)	A path to symbols.

Remarks

Also specifies the mappings between source and target directories.

Description

Create a reference to a Directory element in another Fragment.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the Directory element to reference.
DiskId	integer	Sets the default disk identifier for the files contained in this directory.
FileSource	string	Used to set the file system source for this directory ref's child elements.
src	string

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Component	anyType (restriction)	Component for parent Directory
Directory	anyType (restriction)	Directory layout for the product.
Merge	anyType (restriction)	Merge directive to bring in a merge module that will be redirected to the parent directory.

Description

Searches for directory and assigns to value of parent Property.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier for the directory search.
Path	string	Path on the user's system. Either absolute, or relative to containing directories.
Depth	integer	Depth below the path that the installer searches for the file or directory specified by the search.
AssignToProperty	YesNoType	Set the result of this search to the value of the outer Property.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
DirectorySearch	anyType (restriction)	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	anyType (restriction)	References an existing DirectorySearch element.
FileSearch	anyType (restriction)	Searches for file and assigns to fullpath value of parent Property
FileSearchRef	anyType (restriction)	References an existing FileSearch element.

Description

References an existing DirectorySearch element.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Id of the search being referred to.
Parent	string	This attribute is the signature of the parent directory of the file or directory in the Signature_ column.
Path	string	Path on the user's system. Either absolute, or relative to containing directories.
AssignToProperty	YesNoType	Set the result of this search to the value of the outer Property.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
DirectorySearch	anyType (restriction)	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	anyType (restriction)	References an existing DirectorySearch element.
FileSearch	anyType (restriction)	Searches for file and assigns to fullpath value of parent Property
FileSearchRef	anyType (restriction)	References an existing FileSearch element.

Description

Disables rollback for the remainder of the installation.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Description

Duplicates files installed by the InstallFiles action.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Derived By

Extending string

Attributes

Name	Type	Description
Id	string	Unique identifier for embedded chainer.
CommandLine	string	Value to append to the transaction handle and passed to the chainer executable.
BinarySource	string	Reference to the Binary element that contains the chainer executeable.
FileSource	string	Reference to the File element that is the chainer executeable.
PropertySource	string	Reference to a Property that resolves to the full path to the chainer executeable.

Content Model

Contains text only.

Description

Reference to an EmbeddedChainer element.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string

Content Model

Always empty.

Remarks

This will force the entire referenced Fragment's contents to be included in the installer database.

Description

Element value is the condition.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier for embedded UI.
IgnoreFatalExit	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_FATALEXIT messages.
IgnoreError	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_ERROR messages.
IgnoreWarning	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_WARNING messages.
IgnoreUser	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_USER messages.
IgnoreInfo	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_INFO messages.
IgnoreFilesInUse	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_FILESINUSE messages.
IgnoreResolveSource	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_RESOLVESOURCE messages.
IgnoreOutOfDiskSpace	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_OUTOFDISKSPACE messages.
IgnoreActionStart	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_ACTIONSTART messages.
IgnoreActionData	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_ACTIONDATA messages.
IgnoreProgress	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_PROGRESS messages.
IgnoreCommonData	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_COMMONDATA messages.
IgnoreInitialize	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_INITIALIZE messages.
IgnoreTerminate	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_TERMINATE messages.
IgnoreShowDialog	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_SHOWDIALOG messages.
IgnoreRMFilesInUse	YesNoType	Embedded UI will not recieve any INSTALLLOGMODE_RMFILESINUSE messages.
Name	LongFileNameType	The name for the embedded UI DLL when it is extracted from the Product and executed. (Windows Installer does not support the typical short filename and long filename combination for embedded UI files as it does for other kinds of files.)
SourceFile	string	Path to the binary file that is the embedded UI.
SupportBasicUI	YesNoType	Set yes to allow the Windows Installer to display the embedded UI during basic UI level installation.

Content Model

Can contain a mix of text and the elements defined in the following table.

Component	Type	Description
EmbeddedUIResource	anyType (restriction)	Defines a resource for use by the embedded UI.

Remarks

Use CDATA if message contains delimiter characters.

Description

Defines a resource for use by the embedded UI.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for the embedded UI resource.
Name	LongFileNameType	The name for the resource when it is extracted from the Product for use by the embedded UI DLL. (Windows Installer does not support the typical short filename and long filename combination for embedded UI files as it does for other kinds of files.)
SourceFile	string	Path to the binary file that is the embedded UI resource.

Content Model

Always empty.

Description

Use this element to ensure that a table appears in the installer database, even if its empty.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The name of the table.

Content Model

Always empty.

Description

Environment variables added or removed for the parent component.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier for environment entry.
Name	string	Name of the environment variable.
Value	string	The value to set into the environment variable.
Separator	string	Optional attribute to change the separator used between values.
Action	NMTOKEN (restriction)	Specfies whether the environmental variable should be created, set or removed when the parent component is installed.
Part	NMTOKEN (restriction)
Permanent	YesNoType	Specifies that the environment variable should not be removed on uninstall.
System	YesNoType	Specifies that the environment variable should be added to the system environment space.

Content Model

Always empty.

Derived By

Extending string

Attributes

Name	Type	Description
Id	integer	Number of the error for which a message is being provided.

Content Model

Contains text only.

Description

Declares a merge module with which this merge module is incompatible.

Derived By

Restricting anyType

Attributes

Name	Type	Description
ExcludedId	string	Identifier of the merge module that is incompatible.
ExcludeExceptLanguage	integer	Numeric language ID of the merge module in ExcludedID.
ExcludeLanguage	integer	Numeric language ID of the merge module in ExcludedID.
ExcludedMinVersion	string	Minimum version excluded from a range.
ExcludedMaxVersion	string	Maximum version excluded from a range.

Content Model

Always empty.

Description

Initiates the execution sequence.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

The condition for this action may be specified in the element's inner text.

Description

Extension for a Component

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	This is simply the file extension, like "doc" or "xml". Do not include the preceding period.
ContentType	string	The MIME type that is to be written.
Advertise	YesNoType	Whether this extension is to be advertised. The default is "no".

Content Model

Contains elements as defined in the following table.

Component	Type	Description
MIME	anyType (restriction)	MIME content-type for an Extension
Verb	anyType (restriction)	Verb definition for an Extension.

Description

Contains information about specific files that are not part of a regular target image.

Derived By

Restricting anyType

Attributes

Name	Type	Description
File	string	Foreign key into the File table.
Source	string	Full path of the external file.
src	string
Order	int	Specifies the order of the external files to use when creating the patch.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
ProtectRange	anyType (restriction)	Specifies part of a file that cannot be overwritten during patching.
SymbolPath	anyType (restriction)	A path to symbols.
IgnoreRange	anyType (restriction)	Specifies part of a file that is to be ignored during patching.

Description

Group of one or more upgraded images of a product.

Derived By

Restricting anyType

Attributes

Name	Type	Description
DiskId	int	Entered into the DiskId field of the new Media table record.
DiskPrompt	string	Value to display in the "[1]" of the DiskPrompt Property.
MediaSrcProp	string	Entered into the Source field of the new Media table entry of the upgraded image.
Name	string	Identifier for the family.
SequenceStart	int	Sequence number for the starting file.
VolumeLabel	string	Entered into the VolumeLabel field of the new Media table record.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
UpgradeImage	anyType (restriction)	Contains information about the upgraded images of the product.
ExternalFile	anyType (restriction)	Contains information about specific files that are not part of a regular target image.
ProtectFile	anyType (restriction)	Specifies a file to be protected.

Description

A feature for the Feature table.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier of the feature.
Absent	NMTOKEN (restriction)	This attribute determines if a user will have the option to set a feature to absent in the user interface.
AllowAdvertise	NMTOKEN (restriction)	This attribute determins the possible advertise states for this feature.
ConfigurableDirectory	string	Specify the Id of a Directory that can be configured by the user at installation time.
Description	string	Longer string of text describing the feature.
Display	string	Determines the initial display of this feature in the feature tree.
InstallDefault	NMTOKEN (restriction)	This attribute determines the default install/run location of a feature.
Level	integer	Sets the install level of this feature.
Title	string	Short string of text identifying the feature.
TypicalDefault	NMTOKEN (restriction)	This attribute determines the default advertise state of the feature.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Component	anyType (restriction)	Component for parent Directory
ComponentGroupRef	anyType (restriction)	Create a reference to a ComponentGroup in another Fragment.
ComponentRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
Condition	string (extension)	Conditions for components, controls, features, and products.
Feature	anyType (restriction)	A feature for the Feature table.
FeatureGroupRef	anyType (restriction)	Create a reference to a FeatureGroup in another Fragment.
FeatureRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
MergeRef	anyType (restriction)	Merge reference to connect a Merge Module to parent Feature

Remarks

Features are the smallest installable unit. See msi.chm for more detailed information on the myriad installation options for a feature.

Description

Groups together multiple components, features, and merges to be used in other locations.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for the FeatureGroup.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Component	anyType (restriction)	Component for parent Directory
ComponentGroupRef	anyType (restriction)	Create a reference to a ComponentGroup in another Fragment.
ComponentRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
Feature	anyType (restriction)	A feature for the Feature table.
FeatureGroupRef	anyType (restriction)	Create a reference to a FeatureGroup in another Fragment.
FeatureRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
MergeRef	anyType (restriction)	Merge reference to connect a Merge Module to parent Feature

Description

Create a reference to a FeatureGroup in another Fragment.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the FeatureGroup to reference.
IgnoreParent	YesNoType	Normally feature group references that end up nested under a parent element create a connection to that parent.
Primary	YesNoType	Set this attribute to 'yes' in order to make the parent feature of this group the primary feature for any components and merges contained in the group.

Content Model

Always empty.

Description

Create a reference to a Feature element in another Fragment.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the Feature element to reference.
IgnoreParent	YesNoType	Normally feature references that are nested under a parent element create a connection to that parent.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
Component	anyType (restriction)	Component for parent Directory
ComponentGroupRef	anyType (restriction)	Create a reference to a ComponentGroup in another Fragment.
ComponentRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
Feature	anyType (restriction)	A feature for the Feature table.
FeatureGroup	anyType (restriction)	Groups together multiple components, features, and merges to be used in other locations.
FeatureGroupRef	anyType (restriction)	Create a reference to a FeatureGroup in another Fragment.
FeatureRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
MergeRef	anyType (restriction)	Merge reference to connect a Merge Module to parent Feature

Description

File specification for File table, must be child node of Component.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The unique identifier for this File element.
CompanionFile	string	Set this attribute to make this file a companion child of another file.
Name	LongFileNameType	In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's value may now be either a short or long file name.
LongName	LongFileNameType
KeyPath	YesNoType	Set to yes in order to force this file to be the key path for the parent component.
ShortName	ShortFileNameType	The short file name of the file in 8.3 format.
ReadOnly	YesNoType	Set to yes in order to have the file's read-only attribute set when it is installed on the target machine.
Hidden	YesNoType	Set to yes in order to have the file's hidden attribute set when it is installed on the target machine.
System	YesNoType	Set to yes in order to have the file's system attribute set when it is installed on the target machine.
Vital	YesNoType	If a file is vital, then installation cannot proceed unless the file is successfully installed.
Checksum	YesNoType	This attribute should be set to "yes" for every executable file in the installation that has a valid checksum stored in the Portable Executable (PE) file header.
Compressed	YesNoDefaultType	Sets the file's source type compression.
BindPath	string	A list of paths, separated by semicolons, that represent the paths to be searched to find the imported DLLs.
SelfRegCost	integer	The cost of registering the file in bytes.
TrueType	YesNoType	Causes an entry to be generated for the file in the Font table with no FontTitle specified.
FontTitle	string	Causes an entry to be generated for the file in the Font table with the specified FontTitle.
DefaultLanguage	string	This is the default language of this file.
DefaultSize	integer	This is the default size of this file.
DefaultVersion	string	This is the default version of this file.
Assembly	NMTOKEN (restriction)	Specifies if this File is a Win32 Assembly or .NET Assembly that needs to be installed into the Global Assembly Cache.
AssemblyManifest	string	Specifies the file identifier of the manifest file that describes this assembly.
AssemblyApplication	string	Specifies the file identifier of the application file.
ProcessorArchitecture	NMTOKEN (restriction)	Specifies the architecture for this assembly.
DiskId	integer	Specifies the Media this File should be sourced on.
Source	string	Specifies the path to the File in the build process.
src	string
PatchGroup	integer	This attribute must be set for patch-added files.
PatchIgnore	YesNoType	Prevents the updating of the file that is in fact changed in the upgraded image relative to the target images.
PatchAllowIgnoreOnError	YesNoType	Set to indicate that the patch is non-vital.
PatchWholeFile	YesNoType	Set if the entire file should be installed rather than creating a binary patch.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
AppId	anyType (restriction)	Application ID containing DCOM information for the associated application GUID.
AssemblyName	anyType (restriction)	The MsiAssemblyName table specifies the schema for the elements of a strong assembly cache name for a .NET Framework or Win32 assembly.
Class	anyType (restriction)	COM Class registration for parent Component.
CopyFile	anyType (restriction)	Copy or move an existing file on the target machine, or copy a file that is being installed, to another destination.
ODBCDriver	anyType (restriction)	ODBCDriver for a Component
ODBCTranslator	anyType (restriction)	ODBCTranslator for a Component
Permission	anyType (restriction)	Sets ACLs on File, Registry, or CreateFolder.
Shortcut	anyType (restriction)	Shortcut, default target is parent File, CreateFolder, or Component's Directory
SymbolPath	anyType (restriction)	A path to symbols.
TypeLib	anyType (restriction)	Register a type library (TypeLib).

Description

Initiates dynamic costing of standard installation actions.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Any standard or custom actions that affect costing should sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action. Then call the CostFinalize action following the FileCost action to make all final cost calculations available to the installer through the Component table. The CostInitialize action must be executed before the FileCost action. The installer then determines the disk-space cost of every file in the File table, on a per-component basis, taking both volume clustering and the presence of existing files that may need to be overwritten into account. All actions that consume or release disk space are also considered. If an existing file is found, a file version check is performed to determine whether the new file actually needs to be installed or not. If the existing file is of an equal or greater version number, the existing file is not overwritten and no disk-space cost is incurred. In all cases, the installer uses the results of version number checking to set the installation state of each file. The FileCost action initializes cost calculation with the installer. Actual dynamic costing does not occur until the CostFinalize action is executed. The condition for this action may be specified in the element's inner text.

Description

Searches for file and assigns to fullpath value of parent Property

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Unique identifier for the file search and external key into the Signature table.
Name	LongFileNameType	In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's value may now be either a short or long file name.
LongName	LongFileNameType
ShortName	ShortFileNameType	The short file name of the file in 8.3 format.
MinSize	int	The minimum size of the file.
MaxSize	int	The maximum size of the file.
MinVersion	string	The minimum version of the file.
MaxVersion	string	The maximum version of the file.
MinDate	dateTime	The minimum modification date and time of the file.
MaxDate	dateTime	The maximum modification date and time of the file.
Languages	string	The languages supported by the file.

Content Model

Always empty.

Description

References an existing FileSearch element.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Specify the Id to the FileSearch to reference.

Content Model

Always empty.

Description

FileType data for class Id registration.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Offset	integer	Offset into file. If positive, offset is from the beginning; if negative, offset is from the end.
Mask	HexType	Hex value that is AND'd against the bytes in the file at Offset.
Value	HexType	If the result of the AND'ing of Mask with the bytes in the file is Value, the file is a match for this File Type.

Content Model

Always empty.

Description

Runs through each record of the Upgrade table in sequence and compares the upgrade code, product version, and language in each row to products installed on the system.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

When FindRelatedProducts detects a correspondence between the upgrade information and an installed product, it appends the product code to the property specified in the ActionProperty column of the UpgradeTable. The FindRelatedProducts action only runs the first time the product is installed. The FindRelatedProducts action does not run during maintenance mode or uninstallation. FindRelatedProducts should be authored into the InstallUISequence table and InstallExecuteSequence tables. The installer prevents FindRelated Products from running in InstallExecuteSequence if the action has already run in InstallUISequence. The FindRelatedProducts action must come before the MigrateFeatureStates action and the RemoveExistingProducts action. The condition for this action may be specified in the element's inner text.

Description

Prompts the user for a restart of the system during the installation.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Description

The Fragment element is the building block of creating an installer database in WiX.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Optional identifier for a Fragment.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##other namespace.
AppId	anyType (restriction)	Application ID containing DCOM information for the associated application GUID.
Binary	anyType (restriction)	Binary data used for CustomAction elements and UI controls.
ComplianceCheck	anyType (restriction)	Adds a row to the CCPSearch table.
Component	anyType (restriction)	Component for parent Directory
ComponentGroup	anyType (restriction)	Groups together multiple components to be used in other locations.
Condition	string (extension)	Conditions for components, controls, features, and products.
CustomAction	string (extension)	Specifies a custom action to be added to the MSI CustomAction table.
CustomActionRef	anyType (restriction)	This will cause the entire contents of the Fragment containing the referenced CustomAction to be included in the installer database.
CustomTable	anyType (restriction)	Defines a custom table for use from a custom action.
Directory	anyType (restriction)	Directory layout for the product.
DirectoryRef	anyType (restriction)	Create a reference to a Directory element in another Fragment.
EmbeddedChainer	string (extension)
EmbeddedChainerRef	anyType (restriction)	Reference to an EmbeddedChainer element.
EnsureTable	anyType (restriction)	Use this element to ensure that a table appears in the installer database, even if its empty.
Feature	anyType (restriction)	A feature for the Feature table.
FeatureGroup	anyType (restriction)	Groups together multiple components, features, and merges to be used in other locations.
FeatureRef	anyType (restriction)	Create a reference to a Feature element in another Fragment.
Icon	anyType (restriction)	Icon used for Shortcut, ProgId, or Class elements (but not UI controls)
IgnoreModularization	anyType (restriction)	This element has been deprecated.
Media	anyType (restriction)	Media element describes a disk that makes up the source media for the installation.
PatchCertificates	anyType (restriction)	Identifies the possible signer certificates used to digitally sign patches.
PatchFamily	anyType (restriction)	Collection of items that should be kept from the differences between two products.
Property	anyType (restriction)	Property value for a Product or Module.
PropertyRef	anyType (restriction)	Reference to a Property value.
InstallExecuteSequence	anyType (restriction)
InstallUISequence	anyType (restriction)
AdminExecuteSequence	anyType (restriction)
AdminUISequence	anyType (restriction)
AdvertiseExecuteSequence	anyType (restriction)
SetDirectory	string (extension)	Sets a Directory to a particular value.
SetProperty	string (extension)	Sets a Property to a particular value.
SFPCatalog	anyType (restriction)	Adds a system file protection update catalog file
UI	anyType (restriction)	Enclosing element to compartmentalize UI specifications.
UIRef	anyType (restriction)	Reference to a UI element. This will force the entire referenced Fragment's contents to be included in the installer database.
Upgrade	anyType (restriction)	Upgrade info for a particular UpgradeCode
WixVariable	anyType (restriction)	This element exposes advanced WiX functionality.

Remarks

Once defined, the Fragment becomes an immutable, atomic unit which can either be completely included or excluded from a product. The contents of a Fragment element can be linked into a product by utilizing one of the many *Ref elements. When linking in a Fragment, it will be necessary to link in all of its individual units. For instance, if a given Fragment contains two Component elements, you must link both under features using ComponentRef for each linked Component. Otherwise, you will get a linker warning and have a floating Component that does not appear under any Feature.

Description

Icon used for Shortcut, ProgId, or Class elements (but not UI controls)

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The Id cannot by longer than 55 characters.
SourceFile	string	Path to the icon file.
src	string

Content Model

Always empty.

Description

Used only for PatchFamilies to include only a icon table entry in a patch.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The identifier of the Icon element to reference.

Content Model

Always empty.

Description

This element has been deprecated.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Name	string	The name of the item to ignore modularization for.
Type	NMTOKEN (restriction)	The type of the item to ignore modularization for.

Content Model

Always empty.

Remarks

Use the Binary/@SuppressModularization, CustomAction/@SuppressModularization, or Property/@SuppressModularization attributes instead.

Description

Specifies part of a file that is to be ignored during patching.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Offset	int	Offset of the start of the range.
Length	int	Length of the range.

Content Model

Always empty.

Description

Specifies a table from the merge module that is not merged into an .msi file.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	The name of the table in the merge module that is not to be merged into the .msi file.

Content Model

Always empty.

Remarks

If the table already exists in an .msi file, it is not modified by the merge. The specified table can therefore contain data that is unneeded after the merge. To minimize the size of the .msm file, it is recommended that developers remove unused tables from modules intended for redistribution rather than creating IgnoreTable elements for those tables.

Description

This is the top-level container element for every wxi file.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
any		Allow any element from the ##any namespace.

Description

Adds or removes .ini file entries.

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	Identifier for ini file.
Action	NMTOKEN (restriction)	The type of modification to be made.
Directory	string	Name of a property, the value of which is the full path of the folder containing the .ini file.
Key	string	The localizable .ini file key within the section.
LongName	LongFileNameType
Name	LongFileNameType	In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now be either a short or long name.
Section	string	The localizable .ini file section.
ShortName	ShortFileNameType	The short name of the in 8.3 format.
Value	string	The localizable value to be written or deleted. This attribute must be set if the Action attribute's value is "addLine", "addTag", or "createLine".

Content Model

Always empty.

Description

Searches for file, directory or registry key and assigns to value of parent Property

Derived By

Restricting anyType

Attributes

Name	Type	Description
Id	string	External key into the Signature table.
Field	integer	The field in the .ini line. If field is Null or 0, the entire line is read.
Key	string	The key value within the section.
LongName	LongFileNameType
Name	LongFileNameType	In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now be either a short or long name.
Section	string	The localizable .ini file section.
ShortName	ShortFileNameType	The short name of the file in 8.3 format.
Type	NMTOKEN (restriction)	Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.

Content Model

Contains elements as defined in the following table.

Component	Type	Description
DirectorySearch	anyType (restriction)	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	anyType (restriction)	References an existing DirectorySearch element.
FileSearch	anyType (restriction)	Searches for file and assigns to fullpath value of parent Property
FileSearchRef	anyType (restriction)	References an existing FileSearch element.

Description

Copies the product database to the administrative installation point. The condition for this action may be specified in the element's inner text.

Derived By

Type ActionSequenceType

Attributes

Name	Type	Description
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Description

Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Description

Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.

Derived By

Type ActionModuleSequenceType

Attributes

Name	Type	Description
After	string	The name of an action that this action should come after.
Before	string	The name of an action that this action should come before.
Overridable	YesNoType	If "yes", the sequencing of this action may be overridden by sequencing elsewhere.
Sequence	integer	A value used to indicate the position of this action in a sequence.
Suppress	YesNoType	If yes, this action will not occur.

Content Model

Contains text only.

Remarks

Should only be used after InstallExecute. Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Description
AllocateRegistrySpace	ActionSequenceType	Ensures the needed amount of space exists in the registry.
AppSearch	ActionModuleSequenceType	Uses file signatures to search for existing versions of products.
BindImage	ActionSequenceType	Binds each executable or DLL that must be bound to the DLLs imported by it.
CCPSearch	ActionModuleSequenceType	Uses file signatures to validate that qualifying products are installed on a system before an upgrade installation is performed.
CostFinalize	ActionSequenceType	Ends the internal installation costing process begun by the CostInitialize action.
CostInitialize	ActionSequenceType	Initiates the internal installation costing process.
CreateFolders	ActionSequenceType	Creates empty folders for components that are set to be installed.
CreateShortcuts	ActionSequenceType	Manages the creation of shortcuts.
Custom	string (extension)	Use to sequence a custom action.
DeleteServices	ActionSequenceType	Stops a service and removes its registration from the system.
DisableRollback	ActionModuleSequenceType	Disables rollback for the remainder of the installation.
DuplicateFiles	ActionSequenceType	Duplicates files installed by the InstallFiles action.
FileCost	ActionSequenceType	Initiates dynamic costing of standard installation actions.
FindRelatedProducts	ActionModuleSequenceType	Runs through each record of the Upgrade table in sequence and compares the upgrade code, product version, and language in each row to products installed on the system.
ForceReboot	ActionModuleSequenceType	Prompts the user for a restart of the system during the installation.
InstallExecute	ActionModuleSequenceType	Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.
InstallExecuteAgain	ActionModuleSequenceType	Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.
InstallFiles	ActionSequenceType	Copies files specified in the File table from the source directory to the destination directory.
InstallFinalize	ActionSequenceType	Marks the end of a sequence of actions that change the system.
InstallInitialize	ActionSequenceType	Marks the beginning of a sequence of actions that change the system.
InstallODBC	ActionSequenceType	Installs the drivers, translators, and data sources in the ODBCDriver table, ODBCTranslator table, and ODBCDataSource table.
InstallServices	ActionSequenceType	Registers a service for the system.
InstallValidate	ActionSequenceType	Verifies that all costed volumes have enough space for the installation.
IsolateComponents	ActionSequenceType	Installs a copy of a component (commonly a shared DLL) into a private location for use by a specific application (typically an .exe).
LaunchConditions	ActionModuleSequenceType	Queries the LaunchCondition table and evaluates each conditional statement recorded there.
MigrateFeatureStates	ActionSequenceType	Used for upgrading or installing over an existing application.
MoveFiles	ActionSequenceType	Locates existing files on the system and moves or copies those files to a new location.
MsiPublishAssemblies	ActionSequenceType	Manages the advertisement of CLR and Win32 assemblies.
MsiUnpublishAssemblies	ActionSequenceType	Manages the unadvertisement of CLR and Win32 assemblies that are being removed.
PatchFiles	ActionSequenceType	Queries the Patch table to determine which patches are to be applied.
ProcessComponents	ActionSequenceType	Registers and unregisters components, their key paths, and the component clients.
PublishComponents	ActionSequenceType	Manages the advertisement of the components from the PublishComponent table.
PublishFeatures	ActionSequenceType	Writes each feature's state into the system registry.
PublishProduct	ActionSequenceType	Manages the advertisement of the product information with the system.
RegisterClassInfo	ActionSequenceType	Manages the registration of COM class information with the system.
RegisterComPlus	ActionSequenceType	Registers COM+ applications.
RegisterExtensionInfo	ActionSequenceType	Manages the registration of extension related information with the system.
RegisterFonts	ActionSequenceType	Registers installed fonts with the system.
RegisterMIMEInfo	ActionSequenceType	Registers MIME-related registry information with the system.
RegisterProduct	ActionSequenceType	Registers the product information with the installer.
RegisterProgIdInfo	ActionSequenceType	Manages the registration of OLE ProgId information with the system.
RegisterTypeLibraries	ActionSequenceType	Registers type libraries with the system.
RegisterUser	ActionSequenceType	Registers the user information with the installer to identify the user of a product.
RemoveDuplicateFiles	ActionSequenceType	Deletes files installed by the DuplicateFiles action.
RemoveEnvironmentStrings	ActionSequenceType	Modifies the values of environment variables.
RemoveExistingProducts	ActionModuleSequenceType	Goes through the product codes listed in the ActionProperty column of the Upgrade table and removes the products in sequence.
RemoveFiles	ActionSequenceType	Removes files previously installed by the InstallFiles action.
RemoveFolders	ActionSequenceType	Removes any folders linked to components set to be removed or run from source.
RemoveIniValues	ActionSequenceType	Removes .ini file information specified for removal in the RemoveIniFile table if the component is set to be installed locally or run from source.
RemoveODBC	ActionSequenceType	Removes the data sources, translators, and drivers listed for removal during the installation.
RemoveRegistryValues	ActionSequenceType	Removes a registry value that has been authored into the registry table if the associated component was installed locally or as run from source, and is now set to be uninstalled.
RemoveShortcuts	ActionSequenceType	Manages the removal of an advertised shortcut whose feature is selected for uninstallation or a nonadvertised shortcut whose component is selected for uninstallation.
ResolveSource	ActionModuleSequenceType	Determines the location of the source and sets the SourceDir property if the source has not been resolved yet.
RMCCPSearch	ActionModuleSequenceType	Uses file signatures to validate that qualifying products are installed on a system before an upgrade installation is performed.
ScheduleReboot	ActionModuleSequenceType	Prompts the user to restart the system at the end of installation.
SelfRegModules	ActionSequenceType	Processes all modules listed in the SelfReg table and registers all installed modules with the system.
SelfUnregModules	ActionSequenceType	Unregisters all modules listed in the SelfReg table that are scheduled to be uninstalled.
SetODBCFolders	ActionSequenceType	Checks for existing ODBC drivers and sets the target directory for each new driver to the location of an existing driver.
StartServices	ActionSequenceType	Starts system services.
StopServices	ActionSequenceType	Stops system services.
UnpublishComponents	ActionSequenceType	Manages the unadvertisement of components listed in the PublishComponent table.
UnpublishFeatures	ActionSequenceType	Removes selection-state and feature-component mapping information from the registry.
UnregisterClassInfo	ActionSequenceType	Manages the removal of COM class information from the system registry.
UnregisterComPlus	ActionSequenceType	Removes COM+ applications from the registry.
UnregisterExtensionInfo	ActionSequenceType	Manages the removal of extension-related information from the system registry.
UnregisterFonts	ActionSequenceType	Removes registration information about installed fonts from the system.
UnregisterMIMEInfo	ActionSequenceType	Unregisters MIME-related registry information from the system.
UnregisterProgIdInfo	ActionSequenceType	Manages the unregistration of OLE ProgId information with the system.
UnregisterTypeLibraries	ActionSequenceType	Unregisters type libraries from the system.
ValidateProductID	ActionSequenceType	Sets the ProductID property to the full product identifier.
WriteEnvironmentStrings	ActionSequenceType	Modifies the values of environment variables.
WriteIniValues	ActionSequenceType	Writes the .ini file information that the application needs written to its .ini files.
WriteRegistryValues	ActionSequenceType	Sets up an application's registry information.