documentation.HELP! Windows Installer XML Documentation

Windows Installer XML (WiX)

Windows Installer XML

Table of contents

• Windows Installer XML (WiX)
  • Getting Started
  • Help Resources
• Fundamental Tools and Concepts
  • File Types
  • List of Tools
  • Tools Diagram
  • Preprocessor
  • Compiler (Candle)
  • Linker (Light)
  • Inscriber (Insignia)
  • WixCop
  • MSI Tables to WiX Schema
  • Code Pages
  • Useful Windows Installer Information
• Creating Installation Packages
  • Creating a Simple Setup
  • Creating a Merge Module
  • Incorporating an MSM into an MSI
  • Using a Custom Action
  • Modifying the Installation User Interface
    • Using Built-in WixUI Dialog Sets
    • Customizing Built-in WixUI Dialog Sets
    • Using Localized Versions of WixUI
    • WixUI Dialog Reference
      • WixUI_Advanced Dialog Set
      • WixUI_FeatureTree Dialog Set
      • WixUI_InstallDir Dialog Set
      • WixUI_Minimal Dialog Set
      • WixUI_Mondo Dialog Set
      • WixUI Dialogs
• Working in Visual Studio
  • WiX Project Types
  • WiX Item Templates
  • WiX Project Property Pages
  • Reading the Project Template
  • Creating a Simple Setup
  • Using Project References
• Working with MSBuild
  • Creating a .wixproj File
  • Integrating WiX Projects Into Daily Builds
  • Building WiX Projects In Team Foundation Build
  • Task Reference
    • Candle Task
    • HeatDirectory Task
    • HeatFile Task
    • HeatProject Task
    • Light Task
    • Lit Task
  • Target Reference
    • HarvestDirectory Target
    • HarvestFile Target
    • HarvestProjects Target
• Working with NAnt
  • WiX NAnt Task Reference
    • Candle Task
    • Light Task
    • Lit Task
• How To Guides
  • Files, Shortcuts, and Registry
    • Add a file to your installer
    • Check the version number of a file during installation
    • Write a registry entry during installation
    • Read a registry entry during installation
    • Create a shortcut on the Start Menu
    • Create a shortcut to a web page
    • Create an uninstall shortcut
    • NGen managed assemblies during installation
    • Reference another DirectorySearch element
    • Get the parent directory of a file search
  • Redistributables and Install Checks
    • Check for .NET Framework versions
    • Install the .NET Framework using a bootstrapper
    • Install DirectX 9.0 with your installer
    • Install the Visual C++ Redistributable with your installer
    • Block installation based on OS version
  • Product Updates
    • Implement a major upgrade in your installer
  • Others
    • Get a log of your installation for debugging
    • Look inside your MSI with Orca
    • Generate a GUID
    • Use WiX Extensions
    • Optimize building cabinet file
    • Specify source file locations
• Standard Custom Actions
  • Using Standard Custom Actions
  • OSInfo Custom Actions
  • Performance Counter Custom Action
  • Quiet Execution Custom Action
  • ShellExecute Custom Action
  • WixDirectXExtension
  • WixExitEarlyWithSuccess
  • WixFailWhenDeferred
  • WixGamingExtension
  • WixNetfxExtension
  • WixVSExtension
• Creating an Installation Patch
  • Restrictions for Patches
  • Building a patch using Patch Creation Properties
  • Building a patch using WiX
• WiX Schema References
  • Wix Schema
    • AdminExecuteSequence Element
    • AdminUISequence Element
    • AdvertiseExecuteSequence Element
    • AllocateRegistrySpace Element
    • AppData Element
    • AppId Element
    • AppSearch Element
    • AssemblyName Element
    • Billboard Element
    • BillboardAction Element
    • Binary Element
    • BinaryRef Element
    • BindImage Element
    • Bundle Element
    • Category Element
    • CCPSearch Element
    • Chain Element
    • Class Element
    • Column Element
    • ComboBox Element
    • ComplianceCheck Element
    • ComplianceDrive Element
    • Component Element
    • ComponentGroup Element
    • ComponentGroupRef Element
    • ComponentRef Element
    • ComponentSearch Element
    • Condition Element
    • Configuration Element
    • ConfigurationData Element
    • Container Element
    • ContainerRef Element
    • Control Element
    • CopyFile Element
    • CostFinalize Element
    • CostInitialize Element
    • CreateFolder Element
    • CreateFolders Element
    • CreateShortcuts Element
    • Custom Element
    • CustomAction Element
    • CustomActionRef Element
    • CustomProperty Element
    • CustomTable Element
    • Data Element
    • DeleteServices Element
    • Dependency Element
    • Dialog Element
    • DialogRef Element
    • DigitalCertificate Element
    • DigitalSignature Element
    • Directory Element
    • DirectoryRef Element
    • DirectorySearch Element
    • DirectorySearchRef Element
    • DisableRollback Element
    • DuplicateFiles Element
    • EmbeddedChainer Element
    • EmbeddedChainerRef Element
    • EmbeddedUI Element
    • EmbeddedUIResource Element
    • EnsureTable Element
    • Environment Element
    • Error Element
    • Exclusion Element
    • ExecuteAction Element
    • ExePackage Element
    • Extension Element
    • ExternalFile Element
    • Failure Element
    • Family Element
    • Feature Element
    • FeatureGroup Element
    • FeatureGroupRef Element
    • FeatureRef Element
    • File Element
    • FileCost Element
    • FileSearch Element
    • FileSearchRef Element
    • FileTypeMask Element
    • FindRelatedProducts Element
    • ForceReboot Element
    • Fragment Element
    • Icon Element
    • IconRef Element
    • IgnoreModularization Element
    • IgnoreRange Element
    • IgnoreTable Element
    • Include Element
    • IniFile Element
    • IniFileSearch Element
    • InstallAdminPackage Element
    • InstallExecute Element
    • InstallExecuteAgain Element
    • InstallExecuteSequence Element
    • InstallFiles Element
    • InstallFinalize Element
    • InstallInitialize Element
    • InstallODBC Element
    • InstallServices Element
    • InstallUISequence Element
    • InstallValidate Element
    • Instance Element
    • InstanceTransforms Element
    • Interface Element
    • IsolateComponent Element
    • IsolateComponents Element
    • LaunchConditions Element
    • LayoutDirectory Element
    • LayoutDirectoryRef Element
    • LayoutFile Element
    • ListBox Element
    • ListItem Element
    • ListView Element
    • MajorUpgrade Element
    • Media Element
    • Merge Element
    • MergeRef Element
    • MigrateFeatureStates Element
    • MIME Element
    • Module Element
    • MoveFiles Element
    • MsiPackage Element
    • MsiProperty Element
    • MsiPublishAssemblies Element
    • MsiUnpublishAssemblies Element
    • MspPackage Element
    • MsuPackage Element
    • MultiStringValue Element
    • ODBCDataSource Element
    • ODBCDriver Element
    • ODBCTranslator Element
    • OptimizeCustomActions Element
    • Package Element
    • PackageCertificates Element
    • PackageGroup Element
    • PackageGroupRef Element
    • Patch Element
    • PatchBaseline Element
    • PatchCertificates Element
    • PatchCreation Element
    • PatchFamily Element
    • PatchFamilyRef Element
    • PatchFiles Element
    • PatchInformation Element
    • PatchMetadata Element
    • PatchProperty Element
    • PatchSequence Element
    • Payload Element
    • PayloadGroup Element
    • PayloadGroupRef Element
    • Permission Element
    • PermissionEx Element
    • ProcessComponents Element
    • Product Element
    • ProgId Element
    • ProgressText Element
    • Property Element
    • PropertyRef Element
    • ProtectFile Element
    • ProtectRange Element
    • Publish Element
    • PublishComponents Element
    • PublishFeatures Element
    • PublishProduct Element
    • RadioButton Element
    • RadioButtonGroup Element
    • RegisterClassInfo Element
    • RegisterComPlus Element
    • RegisterExtensionInfo Element
    • RegisterFonts Element
    • RegisterMIMEInfo Element
    • RegisterProduct Element
    • RegisterProgIdInfo Element
    • RegisterTypeLibraries Element
    • RegisterUser Element
    • Registry Element
    • RegistryKey Element
    • RegistrySearch Element
    • RegistrySearchRef Element
    • RegistryValue Element
    • RemoveDuplicateFiles Element
    • RemoveEnvironmentStrings Element
    • RemoveExistingProducts Element
    • RemoveFile Element
    • RemoveFiles Element
    • RemoveFolder Element
    • RemoveFolders Element
    • RemoveIniValues Element
    • RemoveODBC Element
    • RemoveRegistryKey Element
    • RemoveRegistryValue Element
    • RemoveRegistryValues Element
    • RemoveShortcuts Element
    • ReplacePatch Element
    • RequiredPrivilege Element
    • ReserveCost Element
    • ResolveSource Element
    • RMCCPSearch Element
    • Row Element
    • ScheduleReboot Element
    • SelfRegModules Element
    • SelfUnregModules Element
    • ServiceArgument Element
    • ServiceConfig Element
    • ServiceConfigFailureActions Element
    • ServiceControl Element
    • ServiceDependency Element
    • ServiceInstall Element
    • SetDirectory Element
    • SetODBCFolders Element
    • SetProperty Element
    • SFPCatalog Element
    • SFPFile Element
    • Shortcut Element
    • ShortcutProperty Element
    • Show Element
    • StartServices Element
    • StopServices Element
    • Subscribe Element
    • Substitution Element
    • SymbolPath Element
    • TargetFile Element
    • TargetImage Element
    • TargetProductCode Element
    • TargetProductCodes Element
    • Text Element
    • TextStyle Element
    • TypeLib Element
    • UI Element
    • UIRef Element
    • UIText Element
    • UnpublishComponents Element
    • UnpublishFeatures Element
    • UnregisterClassInfo Element
    • UnregisterComPlus Element
    • UnregisterExtensionInfo Element
    • UnregisterFonts Element
    • UnregisterMIMEInfo Element
    • UnregisterProgIdInfo Element
    • UnregisterTypeLibraries Element
    • Upgrade Element
    • UpgradeFile Element
    • UpgradeImage Element
    • UpgradeVersion Element
    • UX Element
    • Validate Element
    • ValidateProductID Element
    • Variable Element
    • Verb Element
    • Wix Element
    • WixVariable Element
    • WriteEnvironmentStrings Element
    • WriteIniValues Element
    • WriteRegistryValues Element
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Wixloc Schema
    • String Element
    • WixLocalization Element
    • LocalizationYesNoType Simple Type
  • Complus Schema
    • ComPlusApplication Element (Complus Extension)
    • ComPlusApplicationRole Element (Complus Extension)
    • ComPlusAssembly Element (Complus Extension)
    • ComPlusAssemblyDependency Element (Complus Extension)
    • ComPlusComponent Element (Complus Extension)
    • ComPlusGroupInApplicationRole Element (Complus Extension)
    • ComPlusGroupInPartitionRole Element (Complus Extension)
    • ComPlusInterface Element (Complus Extension)
    • ComPlusMethod Element (Complus Extension)
    • ComPlusPartition Element (Complus Extension)
    • ComPlusPartitionRole Element (Complus Extension)
    • ComPlusPartitionUser Element (Complus Extension)
    • ComPlusRoleForComponent Element (Complus Extension)
    • ComPlusRoleForInterface Element (Complus Extension)
    • ComPlusRoleForMethod Element (Complus Extension)
    • ComPlusSubscription Element (Complus Extension)
    • ComPlusUserInApplicationRole Element (Complus Extension)
    • ComPlusUserInPartitionRole Element (Complus Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • uuid Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Difxapp Schema
    • Driver Element (Difxapp Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Firewall Schema
    • FirewallException Element (Firewall Extension)
    • RemoteAddress Element (Firewall Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Gaming Schema
    • Game Element (Gaming Extension)
    • PlayTask Element (Gaming Extension)
    • SupportTask Element (Gaming Extension)
    • IsRichSavedGame Attribute
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Iis Schema
    • Certificate Element (Iis Extension)
    • CertificateRef Element (Iis Extension)
    • HttpHeader Element (Iis Extension)
    • MimeMap Element (Iis Extension)
    • RecycleTime Element (Iis Extension)
    • WebAddress Element (Iis Extension)
    • WebApplication Element (Iis Extension)
    • WebApplicationExtension Element (Iis Extension)
    • WebAppPool Element (Iis Extension)
    • WebDir Element (Iis Extension)
    • WebDirProperties Element (Iis Extension)
    • WebError Element (Iis Extension)
    • WebFilter Element (Iis Extension)
    • WebLog Element (Iis Extension)
    • WebProperty Element (Iis Extension)
    • WebServiceExtension Element (Iis Extension)
    • WebSite Element (Iis Extension)
    • WebVirtualDir Element (Iis Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • PercentType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • IsolatedApp Schema
    • Application Element (IsolatedApp Extension)
    • Description Element (IsolatedApp Extension)
    • Details Element (IsolatedApp Extension)
    • EntryPoint Element (IsolatedApp Extension)
    • Feed Element (IsolatedApp Extension)
    • Icon Element (IsolatedApp Extension)
    • Id Element (IsolatedApp Extension)
    • IsolatedApp Element (IsolatedApp Extension)
    • Manufacturer Element (IsolatedApp Extension)
    • Name Element (IsolatedApp Extension)
    • Package Element (IsolatedApp Extension)
    • PreviousFeed Element (IsolatedApp Extension)
    • Source Element (IsolatedApp Extension)
    • UpdateRate Element (IsolatedApp Extension)
    • Version Element (IsolatedApp Extension)
    • uuid Simple Type
    • VersionType Simple Type
  • Lux Schema
    • Condition Element (Lux Extension)
    • Expression Element (Lux Extension)
    • Mutation Element (Lux Extension)
    • UnitTest Element (Lux Extension)
    • UnitTestRef Element (Lux Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Msmq Schema
    • MessageQueue Element (Msmq Extension)
    • MessageQueuePermission Element (Msmq Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Netfx Schema
    • NativeImage Element (Netfx Extension)
    • YesNoType Simple Type
  • OfficeAddin Schema
    • Application Element (OfficeAddin Extension)
    • Description Element (OfficeAddin Extension)
    • Details Element (OfficeAddin Extension)
    • EntryPoint Element (OfficeAddin Extension)
    • ExtendsApplication Element (OfficeAddin Extension)
    • Feed Element (OfficeAddin Extension)
    • Icon Element (OfficeAddin Extension)
    • Id Element (OfficeAddin Extension)
    • Manufacturer Element (OfficeAddin Extension)
    • Name Element (OfficeAddin Extension)
    • OfficeAddin Element (OfficeAddin Extension)
    • Package Element (OfficeAddin Extension)
    • PreviousFeed Element (OfficeAddin Extension)
    • Source Element (OfficeAddin Extension)
    • UpdateRate Element (OfficeAddin Extension)
    • Version Element (OfficeAddin Extension)
    • SupportedOfficeApplications Simple Type
    • uuid Simple Type
    • VersionType Simple Type
  • Ps Schema
    • FormatsFile Element (Ps Extension)
    • SnapIn Element (Ps Extension)
    • TypesFile Element (Ps Extension)
    • RequiredVersion Attribute
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • EmbeddedResource Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Sql Schema
    • SqlDatabase Element (Sql Extension)
    • SqlFileSpec Element (Sql Extension)
    • SqlLogFileSpec Element (Sql Extension)
    • SqlScript Element (Sql Extension)
    • SqlString Element (Sql Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Util Schema
    • CloseApplication Element (Util Extension)
    • ComponentSearch Element (Util Extension)
    • DirectorySearch Element (Util Extension)
    • EventManifest Element (Util Extension)
    • EventSource Element (Util Extension)
    • FileSearch Element (Util Extension)
    • FileShare Element (Util Extension)
    • FileSharePermission Element (Util Extension)
    • Group Element (Util Extension)
    • GroupRef Element (Util Extension)
    • InternetShortcut Element (Util Extension)
    • PerfCounter Element (Util Extension)
    • PerfCounterManifest Element (Util Extension)
    • PerformanceCategory Element (Util Extension)
    • PerformanceCounter Element (Util Extension)
    • PermissionEx Element (Util Extension)
    • ProductSearch Element (Util Extension)
    • RegistrySearch Element (Util Extension)
    • ServiceConfig Element (Util Extension)
    • User Element (Util Extension)
    • XmlConfig Element (Util Extension)
    • XmlFile Element (Util Extension)
    • AutogenGuid Simple Type
    • ComponentGuid Simple Type
    • ExitType Simple Type
    • Guid Simple Type
    • HexType Simple Type
    • InstallUninstallType Simple Type
    • LocalizableInteger Simple Type
    • LongFileNameType Simple Type
    • PerformanceCounterLanguageType Simple Type
    • PerformanceCounterTypesType Simple Type
    • RegistryRootType Simple Type
    • SequenceType Simple Type
    • ShortFileNameType Simple Type
    • VersionType Simple Type
    • WildCardLongFileNameType Simple Type
    • WildCardShortFileNameType Simple Type
    • YesNoDefaultType Simple Type
    • YesNoType Simple Type
  • Vs Schema
    • HelpCollection Element (Vs Extension)
    • HelpCollectionRef Element (Vs Extension)
    • HelpFile Element (Vs Extension)
    • HelpFileRef Element (Vs Extension)
    • HelpFilter Element (Vs Extension)
    • HelpFilterRef Element (Vs Extension)
    • PlugCollectionInto Element (Vs Extension)
    • YesNoType Simple Type
• Developing for WiX
  • How to be a Windows Installer XML Developer
  • Building WiX
  • NAnt Configuration
  • NAnt Conventions
  • Developing for Votive
  • Adding to the WiX Documentation
  • Testing WiX
    • Running Tests
    • Writing Tests
  • Developing Extensions to WiX
    • Introduction
    • Extension Types
    • Creating a Skeleton Extension
    • Creating a Preprocessor Extension
    • Adding a Custom Action
    • Localizing extensions
    • Unit-testing custom actions with Lux

next page

Get in touch

Submit feedback about this site to:

• [email protected]