Component Element

WiX Help

previous page next page

Component Element

Description

Component for parent Directory

Windows Installer references
Component Table, Condition Table, Directory Table
Parents
Directory, DirectoryRef
Inner Text
None
Children
Choice of elements (min: 0, max: unbounded)
Attributes
Name Type Description Required
Id String Component identifier; this is the primary key for identifying components. Yes
ComPlusFlags Integer Set this attribute to create a ComPlus entry. The value should be the export flags used during the generation of the .msi file. For more information see the COM+ documentation in the Platform SDK.  
DisableRegistryReflection YesNoType Set this attribute to 'yes' in order to disable registry reflection on all existing and new registry keys affected by this component. When set to 'yes', the Windows Installer calls the RegDisableReflectionKey on each key being accessed by the component. This bit is available with Windows Installer version 4.0 and is ignored on 32-bit systems.  
DiskId String This attribute must be set either on a Component element or all of its children File elements. The value of this attribute should correspond to the Id attribute of a Media element authored elsewhere. By creating this connection between a component (or particular files), you set the packaging options to the values specified in the Media element (values such as compression level, cab embedding, etc...).  
DriverAddRemovePrograms YesNoType Specifies that the DIFxApp CustomActions should add an entry in the Add/Remove Programs Control Panel applet. The default is 'yes'.  
DriverDeleteFiles YesNoType If set to "yes", configures DIFxApp to delete binary files that were copied to the system from the driver store when a driver package was installed. If this attribute is set to "no" or not present, DIFxApp does not remove these files from a system. Note that configuring DIFxApp to delete these files is controlled by the Flags entry value of the component that represents the driver package in the MsiDriverPackages custom table. Setting DriverDeleteFiles to "yes" sets the corresponding bit in the Flags entry value. Setting DriverLegacy to "no" clears the corresponding bit in the Flags entry value. If this attribute is not present, DIFxApp uses a default value of "no".  
DriverForceInstall YesNoType Specifies that the DIFxApp CustomActions should force the installation of a new Plug and Play driver on a device, even if the currently installed driver on the device is a better match than the new driver. Specifying 'no' is an excellent way to ensure the DIFxApp CustomActions recognize the Component contains a driver for installation. The default is null which means the Component does not install a driver via DIFxApp CustomActions. See http://www.microsoft.com/whdc/driver/install/difxtools.mspx for more information.  
DriverLegacy YesNoType If set to "yes", configures DIFxApp to install unsigned driver packages and driver packages with missing files. For more information, see "Installing Unsigned Driver Packages in Legacy Mode" earlier in this paper. If this attribute is set to "no" or not present, DIFxApp will install only signed driver packages. Note that configuring DIFxApp to install unsigned drivers is controlled by the Flags entry value of the component that represents the driver package in the MsiDriverPackages custom table. Setting DriverLegacy to "yes" sets the corresponding bit in the Flags entry value. Setting DriverLegacy to "no" clears the bit in the Flags entry value that configures DIFxApp to install unsigned driver packages. If this attribute is not present, DIFxApp uses a default value of "no".  
DriverPlugAndPlayPrompt YesNoType Specifies that the DIFxApp CustomActions should prompt the user to connect the Plug and Play device if it is not connected. The default is 'yes'.  
DriverSequence Integer Specifies an optional installation sequence number. DIFxApp CustomActions install the driver packages in an installation package in the order of increasing sequence numbers. The same sequence number can be used for more than one driver; however, the order in which packages with the same sequence number are actually installed cannot be determined.  
Guid ComponentGuid This value should be a guid that uniquely identifies this component's contents, language, platform, and version. It's also possible to set the value to an empty string to specify an unmanaged component. Unmanaged components are a security vulnerability because the component cannot be removed or repaired by Windows Installer (it is essentially an unpatchable, permanent component). Therefore, a guid should always be specified for any component which contains resources that may need to be patched in the future. Yes
KeyPath YesNoType If this attribute's value is set to 'yes', then the Directory of this Component is used as the KeyPath. To set a Registry key or File as the KeyPath of a component, set the KeyPath attribute to 'yes' on one of those child elements.  
Location Enumeration This attribute's value should be one of the following:
local
Prevents the component from running from the source or the network (this is the default behavior if this attribute is not set).
source
Enforces that the component can only be run from the source (it cannot be run from the user's computer).
either
Allows the component to run from source or locally.
 
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. The application does register itself as a client of the component. Use this flag only for components that are being registered by the Registry table. Do not use this flag for components registered by the AppId, Class, Extension, ProgId, MIME, and Verb tables.  
Permanent YesNoType If this attribute is set to 'yes', the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings (which basically just means that at least one product is always referencing this component). Note that this option differs from the behavior of not setting a guid because although the component is permanent, it is still patchable (because Windows Installer still tracks it), it's just not uninstallable.  
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. If this bit is not set, the installer increments the reference count only if the reference count already exists.  
Transitive YesNoType If this attribute is set to 'yes', the installer reevaluates the value of the statement in the Condition upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. If the value was previously True and has changed to False, the installer removes the component even if the component has other products as clients.  
Win64 YesNoType Set this attribute to 'yes' to mark this as a 64-bit component. This attribute facilitates the installation of packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered as a 32-bit component. If this is a 64-bit component replacing a 32-bit component, set this bit and assign a new GUID in the Guid attribute.  
Any attribute namespace='##other' processContents='lax'
See Also
Wix Schema, ComponentRef, Media
previous page start next page