1353
WiX Database XML Schema

WiX Database XML Schema - · PDF fileComboList [element Control ... WiX Database XML Schema

Embed Size (px)

Citation preview

Page 1: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Page 2: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Table of Contents

WiX Database XML Schema..........................................................................................................................21

Elements...................................................................................................................................................... 22

AdminExecuteSequence............................................................................................................................30

AdminUISequence..................................................................................................................................... 33

AdvertiseExecuteSequence....................................................................................................................... 35

AllocateRegistrySpace............................................................................................................................... 38

AppData..................................................................................................................................................... 39

AppId.......................................................................................................................................................... 40

AppSearch..................................................................................................................................................45

AssemblyName.......................................................................................................................................... 47

Billboard..................................................................................................................................................... 49

BillboardAction........................................................................................................................................... 51

Binary......................................................................................................................................................... 53

BinaryRef....................................................................................................................................................55

BindImage.................................................................................................................................................. 56

Category.....................................................................................................................................................57

CCPSearch................................................................................................................................................ 59

Class.......................................................................................................................................................... 61

Column....................................................................................................................................................... 69

ComboBox..................................................................................................................................................74

ComplianceCheck...................................................................................................................................... 76

ComplianceDrive........................................................................................................................................78

Component.................................................................................................................................................79

ComponentGroup.......................................................................................................................................87

ComponentGroupRef................................................................................................................................. 89

ComponentRef........................................................................................................................................... 91

ComponentSearch..................................................................................................................................... 93

Condition.................................................................................................................................................... 95

Configuration..............................................................................................................................................98

ConfigurationData...................................................................................................................................... 100

Control........................................................................................................................................................101

CopyFile..................................................................................................................................................... 111

CostFinalize................................................................................................................................................115

CostInitialize...............................................................................................................................................117

CreateFolder.............................................................................................................................................. 118

CreateFolders.............................................................................................................................................120

CreateShortcuts......................................................................................................................................... 121

Custom....................................................................................................................................................... 122

CustomAction.............................................................................................................................................124

CustomActionRef....................................................................................................................................... 132

CustomProperty......................................................................................................................................... 133

CustomTable..............................................................................................................................................134

Data............................................................................................................................................................135

DeleteServices........................................................................................................................................... 136

Dependency............................................................................................................................................... 137

Dialog......................................................................................................................................................... 138

DialogRef....................................................................................................................................................142

DigitalCertificate......................................................................................................................................... 143

DigitalSignature..........................................................................................................................................144

Directory..................................................................................................................................................... 145

Page 3: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

DirectoryRef............................................................................................................................................... 149

DirectorySearch..........................................................................................................................................151

DirectorySearchRef....................................................................................................................................153

DisableRollback..........................................................................................................................................155

DuplicateFiles.............................................................................................................................................156

EmbeddedChainer..................................................................................................................................... 157

EmbeddedChainerRef................................................................................................................................159

EmbeddedUI.............................................................................................................................................. 160

EmbeddedUIResource...............................................................................................................................165

EnsureTable...............................................................................................................................................167

Environment............................................................................................................................................... 168

Error........................................................................................................................................................... 171

Exclusion.................................................................................................................................................... 172

ExecuteAction............................................................................................................................................ 174

Extension....................................................................................................................................................175

ExternalFile................................................................................................................................................ 177

Family.........................................................................................................................................................179

Feature....................................................................................................................................................... 181

FeatureGroup.............................................................................................................................................187

FeatureGroupRef....................................................................................................................................... 189

FeatureRef................................................................................................................................................. 191

File..............................................................................................................................................................193

FileCost...................................................................................................................................................... 202

FileSearch.................................................................................................................................................. 204

FileSearchRef.............................................................................................................................................207

FileTypeMask.............................................................................................................................................208

FindRelatedProducts..................................................................................................................................209

ForceReboot...............................................................................................................................................211

Fragment.................................................................................................................................................... 212

Icon.............................................................................................................................................................216

IconRef....................................................................................................................................................... 218

IgnoreModularization..................................................................................................................................219

IgnoreRange...............................................................................................................................................221

IgnoreTable................................................................................................................................................ 222

Include........................................................................................................................................................223

IniFile..........................................................................................................................................................224

IniFileSearch.............................................................................................................................................. 227

InstallAdminPackage..................................................................................................................................230

InstallExecute.............................................................................................................................................231

InstallExecuteAgain....................................................................................................................................232

InstallExecuteSequence.............................................................................................................................233

InstallFiles.................................................................................................................................................. 244

InstallFinalize..............................................................................................................................................245

InstallInitialize.............................................................................................................................................246

InstallODBC................................................................................................................................................247

InstallServices............................................................................................................................................ 248

InstallUISequence...................................................................................................................................... 249

InstallValidate.............................................................................................................................................252

Instance......................................................................................................................................................253

InstanceTransforms....................................................................................................................................254

Interface..................................................................................................................................................... 255

IsolateComponent...................................................................................................................................... 257

IsolateComponents.................................................................................................................................... 258

LaunchConditions.......................................................................................................................................260

ListBox........................................................................................................................................................262

3

Page 4: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

ListItem.......................................................................................................................................................264

ListView...................................................................................................................................................... 266

Media..........................................................................................................................................................268

Merge......................................................................................................................................................... 271

MergeRef....................................................................................................................................................273

MigrateFeatureStates.................................................................................................................................275

MIME.......................................................................................................................................................... 276

Module........................................................................................................................................................278

MoveFiles................................................................................................................................................... 282

MsiPublishAssemblies................................................................................................................................283

MsiUnpublishAssemblies........................................................................................................................... 284

MultiStringValue......................................................................................................................................... 285

ODBCDataSource......................................................................................................................................286

ODBCDriver............................................................................................................................................... 288

ODBCTranslator.........................................................................................................................................290

OptimizeCustomActions.............................................................................................................................292

Package..................................................................................................................................................... 293

Patch.......................................................................................................................................................... 298

PatchBaseline............................................................................................................................................ 303

PatchCertificates........................................................................................................................................ 304

PatchCreation.............................................................................................................................................305

PatchFamily................................................................................................................................................309

PatchFamilyRef..........................................................................................................................................312

PatchFiles...................................................................................................................................................313

PatchInformation........................................................................................................................................ 314

PatchMetadata........................................................................................................................................... 317

PatchProperty.............................................................................................................................................320

PatchSequence..........................................................................................................................................321

Permission..................................................................................................................................................323

ProcessComponents..................................................................................................................................327

Product....................................................................................................................................................... 328

ProgId.........................................................................................................................................................333

ProgressText..............................................................................................................................................335

Property......................................................................................................................................................336

PropertyRef................................................................................................................................................ 340

ProtectFile.................................................................................................................................................. 341

ProtectRange............................................................................................................................................. 342

Publish........................................................................................................................................................343

PublishComponents................................................................................................................................... 346

PublishFeatures......................................................................................................................................... 347

PublishProduct........................................................................................................................................... 348

RadioButton................................................................................................................................................349

RadioButtonGroup......................................................................................................................................351

RegisterClassInfo.......................................................................................................................................353

RegisterComPlus....................................................................................................................................... 354

RegisterExtensionInfo................................................................................................................................ 355

RegisterFonts.............................................................................................................................................356

RegisterMIMEInfo.......................................................................................................................................357

RegisterProduct..........................................................................................................................................358

RegisterProgIdInfo..................................................................................................................................... 359

RegisterTypeLibraries................................................................................................................................ 360

RegisterUser.............................................................................................................................................. 361

Registry...................................................................................................................................................... 362

RegistryKey................................................................................................................................................367

RegistrySearch...........................................................................................................................................370

4

Page 5: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

RegistrySearchRef..................................................................................................................................... 374

RegistryValue.............................................................................................................................................375

RemoveDuplicateFiles............................................................................................................................... 380

RemoveEnvironmentStrings...................................................................................................................... 381

RemoveExistingProducts........................................................................................................................... 382

RemoveFile................................................................................................................................................ 383

RemoveFiles.............................................................................................................................................. 386

RemoveFolder............................................................................................................................................387

RemoveFolders..........................................................................................................................................390

RemoveIniValues....................................................................................................................................... 391

RemoveODBC............................................................................................................................................392

RemoveRegistryKey...................................................................................................................................393

RemoveRegistryValue............................................................................................................................... 395

RemoveRegistryValues..............................................................................................................................397

RemoveShortcuts.......................................................................................................................................398

ReplacePatch.............................................................................................................................................399

ReserveCost...............................................................................................................................................400

ResolveSource...........................................................................................................................................402

RMCCPSearch...........................................................................................................................................403

Row............................................................................................................................................................ 405

ScheduleReboot.........................................................................................................................................406

SelfRegModules.........................................................................................................................................407

SelfUnregModules......................................................................................................................................408

ServiceArgument........................................................................................................................................409

ServiceControl............................................................................................................................................410

ServiceDependency................................................................................................................................... 414

ServiceInstall..............................................................................................................................................415

SetDirectory................................................................................................................................................420

SetODBCFolders........................................................................................................................................423

SetProperty................................................................................................................................................ 424

SFPCatalog................................................................................................................................................ 427

SFPFile.......................................................................................................................................................429

Shortcut...................................................................................................................................................... 430

Show.......................................................................................................................................................... 436

StartServices..............................................................................................................................................438

StopServices.............................................................................................................................................. 439

Subscribe................................................................................................................................................... 440

Substitution.................................................................................................................................................441

SymbolPath................................................................................................................................................443

TargetFile................................................................................................................................................... 444

TargetImage...............................................................................................................................................445

TargetProductCode....................................................................................................................................447

Text............................................................................................................................................................ 448

TextStyle.................................................................................................................................................... 449

TypeLib.......................................................................................................................................................451

UI................................................................................................................................................................455

UIRef.......................................................................................................................................................... 458

UIText.........................................................................................................................................................459

UnpublishComponents...............................................................................................................................460

UnpublishFeatures..................................................................................................................................... 461

UnregisterClassInfo....................................................................................................................................462

UnregisterComPlus.................................................................................................................................... 463

UnregisterExtensionInfo.............................................................................................................................464

UnregisterFonts..........................................................................................................................................465

UnregisterMIMEInfo................................................................................................................................... 466

5

Page 6: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

UnregisterProgIdInfo.................................................................................................................................. 467

UnregisterTypeLibraries.............................................................................................................................468

Upgrade......................................................................................................................................................469

UpgradeFile................................................................................................................................................471

UpgradeImage............................................................................................................................................473

UpgradeVersion......................................................................................................................................... 475

Validate...................................................................................................................................................... 478

ValidateProductID...................................................................................................................................... 481

Verb............................................................................................................................................................483

Wix............................................................................................................................................................. 486

WixVariable................................................................................................................................................ 488

WriteEnvironmentStrings............................................................................................................................490

WriteIniValues............................................................................................................................................ 491

WriteRegistryValues...................................................................................................................................492

Attributes...................................................................................................................................................... 493

Absent [element Feature]...........................................................................................................................521

Account [element ServiceInstall]................................................................................................................ 522

Action [element Condition]......................................................................................................................... 523

Action [element Custom]............................................................................................................................ 524

Action [element Environment].................................................................................................................... 525

Action [element IniFile]...............................................................................................................................526

Action [element ProgressText]................................................................................................................... 527

Action [element Registry]........................................................................................................................... 528

Action [element RegistryKey]..................................................................................................................... 529

Action [element RegistryValue].................................................................................................................. 530

Action [element RemoveRegistryKey]........................................................................................................531

ActivateAtStorage [element AppId]............................................................................................................ 532

Admin [element Property]...........................................................................................................................533

AdminImage [element Package]................................................................................................................ 534

AdminImage [element PatchInformation]................................................................................................... 535

Advertise [element AppId].......................................................................................................................... 536

Advertise [element Class].......................................................................................................................... 537

Advertise [element Extension]....................................................................................................................538

Advertise [element MIME].......................................................................................................................... 539

Advertise [element ProgId].........................................................................................................................540

Advertise [element Shortcut]...................................................................................................................... 541

Advertise [element TypeLib].......................................................................................................................542

After [element Custom]...............................................................................................................................543

After [element SetProperty]........................................................................................................................544

After [element Show]..................................................................................................................................545

After [type ActionModuleSequenceType]...................................................................................................546

AllowAdvertise [element Feature].............................................................................................................. 547

AllowIgnoreOnError [element UpgradeFile]............................................................................................... 548

AllowMajorVersionMismatches [element PatchCreation]...........................................................................549

AllowProductCodeMismatches [element PatchCreation]...........................................................................550

AllowRemoval [element Patch].................................................................................................................. 551

AllowRemoval [element PatchMetadata]................................................................................................... 552

ApiPatchingSymbolNoFailuresFlag [element Patch]..................................................................................553

ApiPatchingSymbolNoImagehlpFlag [element Patch]................................................................................554

ApiPatchingSymbolUndecoratedTooFlag [element Patch]........................................................................ 555

AppData [element Category]......................................................................................................................556

Append [element Permission].................................................................................................................... 557

AppId [element Class]................................................................................................................................ 558

Argument [element Class]..........................................................................................................................559

Argument [element Verb]........................................................................................................................... 560

6

Page 7: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Arguments [element ServiceInstall]............................................................................................................561

Arguments [element Shortcut]....................................................................................................................562

Assembly [element File]............................................................................................................................. 563

AssemblyApplication [element File]........................................................................................................... 564

AssemblyManifest [element File]............................................................................................................... 565

AssignToProperty [element DirectorySearch]............................................................................................ 566

AssignToProperty [element DirectorySearchRef]...................................................................................... 567

Attribute [element Subscribe]..................................................................................................................... 568

Before [element Custom]............................................................................................................................569

Before [element SetProperty].....................................................................................................................570

Before [element Show]...............................................................................................................................571

Before [type ActionModuleSequenceType]................................................................................................572

BinaryKey [element CustomAction]............................................................................................................573

BinarySource [element EmbeddedChainer]...............................................................................................574

BindPath [element File].............................................................................................................................. 575

Bitmap [element Control]............................................................................................................................576

Bitmap [element RadioButton]................................................................................................................... 577

Blue [element TextStyle]............................................................................................................................ 578

Bold [element TextStyle]............................................................................................................................ 579

Cabinet [element Media]............................................................................................................................ 580

Cancel [element Control]............................................................................................................................581

Category [element Column]....................................................................................................................... 582

CDROM [element Control]......................................................................................................................... 584

ChangePermission [element Permission].................................................................................................. 585

CheckBoxValue [element Control]............................................................................................................. 586

Checksum [element File]............................................................................................................................587

Class [element MIME]................................................................................................................................ 588

Classification [element Patch].................................................................................................................... 589

Classification [element PatchMetadata]..................................................................................................... 590

CleanWorkingFolder [element PatchCreation]...........................................................................................591

ClientPatchId [element Patch]....................................................................................................................592

Codepage [element Module]...................................................................................................................... 593

Codepage [element Patch].........................................................................................................................594

Codepage [element PatchCreation]........................................................................................................... 595

Codepage [element Product]..................................................................................................................... 596

Column [element Data]...............................................................................................................................597

Column [element Substitution]................................................................................................................... 598

ComboList [element Control]......................................................................................................................599

Command [element Verb].......................................................................................................................... 600

CommandLine [element EmbeddedChainer]............................................................................................. 601

Comments [element Package]................................................................................................................... 602

Comments [element PatchInformation]......................................................................................................603

CompanionFile [element File].................................................................................................................... 604

Company [element CustomProperty]......................................................................................................... 605

Company [element PatchProperty]............................................................................................................ 606

ComplianceCheck [element Property]........................................................................................................607

ComPlusFlags [element Component]........................................................................................................ 608

ComponentGuidGenerationSeed [element Directory]................................................................................609

Compressed [element File]........................................................................................................................ 610

Compressed [element Package]................................................................................................................ 611

Compressed [element PatchInformation]...................................................................................................612

CompressionLevel [element Media]...........................................................................................................613

ConfigurableDirectory [element Feature]................................................................................................... 614

ContentType [element Extension].............................................................................................................. 615

ContentType [element MIME].................................................................................................................... 616

7

Page 8: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Context [element Class]............................................................................................................................. 617

ContextData [element Configuration]......................................................................................................... 618

Control [element Class]..............................................................................................................................619

Control [element Publish]........................................................................................................................... 620

Control [element TypeLib].......................................................................................................................... 621

Cost [element TypeLib].............................................................................................................................. 622

CreateChild [element Permission]..............................................................................................................623

CreateFile [element Permission]................................................................................................................ 624

CreateLink [element Permission]............................................................................................................... 625

CreateSubkeys [element Permission]........................................................................................................ 626

CreationTimeUTC [element PatchMetadata]............................................................................................. 627

CustomPalette [element Dialog].................................................................................................................628

Default [element Control]............................................................................................................................629

Default [element MIME]..............................................................................................................................630

DefaultLanguage [element File]................................................................................................................. 631

DefaultSize [element File].......................................................................................................................... 632

DefaultValue [element Configuration]........................................................................................................ 633

DefaultVersion [element File]..................................................................................................................... 634

Delete [element CopyFile]..........................................................................................................................635

Delete [element Permission]...................................................................................................................... 636

DeleteChild [element Permission].............................................................................................................. 637

Dependency [element SFPCatalog]...........................................................................................................638

Depth [element DirectorySearch]............................................................................................................... 639

Description [element AppId]....................................................................................................................... 640

Description [element Class]....................................................................................................................... 641

Description [element Column].................................................................................................................... 642

Description [element Configuration]........................................................................................................... 643

Description [element Feature].................................................................................................................... 644

Description [element Package].................................................................................................................. 645

Description [element Patch]....................................................................................................................... 646

Description [element PatchInformation]..................................................................................................... 647

Description [element PatchMetadata]........................................................................................................ 648

Description [element ProgId]......................................................................................................................649

Description [element ServiceInstall]........................................................................................................... 650

Description [element Shortcut]................................................................................................................... 651

Description [element TypeLib]....................................................................................................................652

DescriptionResourceDll [element Shortcut]............................................................................................... 653

DescriptionResourceId [element Shortcut].................................................................................................654

DestinationDirectory [element CopyFile]....................................................................................................655

DestinationLongName [element CopyFile].................................................................................................656

DestinationName [element CopyFile].........................................................................................................657

DestinationProperty [element CopyFile].....................................................................................................658

DestinationShortName [element CopyFile]................................................................................................ 659

Dialog [element Publish]............................................................................................................................ 660

Dialog [element Show]............................................................................................................................... 661

Directory [element Component]................................................................................................................. 662

Directory [element CreateFolder]............................................................................................................... 663

Directory [element CustomAction]..............................................................................................................664

Directory [element IniFile]...........................................................................................................................665

Directory [element RemoveFile].................................................................................................................666

Directory [element RemoveFolder]............................................................................................................ 667

Directory [element ReserveCost]............................................................................................................... 668

Directory [element Shortcut].......................................................................................................................669

Disabled [element Control].........................................................................................................................670

DisableRegistryReflection [element Component].......................................................................................671

8

Page 9: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

DiskId [element Component]......................................................................................................................672

DiskId [element Directory].......................................................................................................................... 673

DiskId [element DirectoryRef].................................................................................................................... 674

DiskId [element Family]..............................................................................................................................675

DiskId [element File]...................................................................................................................................676

DiskId [element Merge].............................................................................................................................. 677

DiskPrompt [element Family]..................................................................................................................... 678

DiskPrompt [element Media]...................................................................................................................... 679

Display [element Feature].......................................................................................................................... 680

DisplayName [element Configuration]........................................................................................................681

DisplayName [element Patch]....................................................................................................................682

DisplayName [element PatchMetadata].....................................................................................................683

DisplayName [element ServiceInstall]........................................................................................................684

DisplayResourceDll [element Shortcut]......................................................................................................685

DisplayResourceId [element Shortcut].......................................................................................................686

DllEntry [element CustomAction]............................................................................................................... 687

DllSurrogate [element AppId]..................................................................................................................... 688

Domain [element Permission].................................................................................................................... 689

DriverName [element ODBCDataSource]..................................................................................................690

ElevationShield [element Control].............................................................................................................. 691

EmbedCab [element Media].......................................................................................................................692

EnumerateSubkeys [element Permission]................................................................................................. 693

EraseDescription [element ServiceInstall]..................................................................................................694

Error [element CustomAction].................................................................................................................... 695

ErrorControl [element ServiceInstall]......................................................................................................... 696

ErrorDialog [element Dialog]...................................................................................................................... 697

Event [element Publish]..............................................................................................................................698

Event [element Subscribe]......................................................................................................................... 699

ExcludedId [element Exclusion]................................................................................................................. 700

ExcludedMaxVersion [element Exclusion]................................................................................................. 701

ExcludedMinVersion [element Exclusion].................................................................................................. 702

ExcludeExceptLanguage [element Exclusion]........................................................................................... 703

ExcludeLanguage [element Exclusion]...................................................................................................... 704

ExcludeLanguages [element UpgradeVersion]..........................................................................................705

ExeCommand [element CustomAction]..................................................................................................... 706

Execute [element CustomAction]............................................................................................................... 707

Execute [element Permission]....................................................................................................................708

FaceName [element TextStyle]..................................................................................................................709

Feature [element Billboard]........................................................................................................................ 710

Feature [element Category]....................................................................................................................... 711

Feature [element Component]................................................................................................................... 712

Field [element IniFileSearch]......................................................................................................................713

File [element ExternalFile]..........................................................................................................................714

File [element ODBCDriver].........................................................................................................................715

File [element ODBCTranslator].................................................................................................................. 716

File [element ProtectFile]............................................................................................................................717

File [element UpgradeFile]......................................................................................................................... 718

FileCompression [element Merge]............................................................................................................. 719

FileId [element CopyFile]............................................................................................................................720

FileKey [element CustomAction]................................................................................................................ 721

FileSource [element Directory]...................................................................................................................722

FileSource [element DirectoryRef]............................................................................................................. 723

FileSource [element EmbeddedChainer]................................................................................................... 724

Fixed [element Control].............................................................................................................................. 725

FixedSize [element Control]....................................................................................................................... 726

9

Page 10: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Floppy [element Control]............................................................................................................................ 727

FontTitle [element File]...............................................................................................................................728

Format [element Configuration]..................................................................................................................729

FormatSize [element Control].................................................................................................................... 730

GenericAll [element Permission]................................................................................................................ 731

GenericExecute [element Permission]....................................................................................................... 732

GenericRead [element Permission]........................................................................................................... 733

GenericWrite [element Permission]............................................................................................................734

Green [element TextStyle]..........................................................................................................................735

Group [element ServiceDependency]........................................................................................................ 736

Guid [element Component]........................................................................................................................ 737

Guid [element ComponentSearch].............................................................................................................738

Guid [element Module]............................................................................................................................... 739

Handler [element Class].............................................................................................................................740

HasBorder [element Control]......................................................................................................................741

HasDiskImage [element TypeLib].............................................................................................................. 742

Height [element Control].............................................................................................................................743

Height [element Dialog]..............................................................................................................................744

Height [element RadioButton].................................................................................................................... 745

Help [element Control]................................................................................................................................746

Help [element RadioButton]....................................................................................................................... 747

HelpDirectory [element TypeLib]................................................................................................................748

HelpKeyword [element Configuration]........................................................................................................749

HelpLocation [element Configuration]........................................................................................................ 750

Hidden [element Control]........................................................................................................................... 751

Hidden [element Dialog].............................................................................................................................752

Hidden [element File]................................................................................................................................. 753

Hidden [element Property]......................................................................................................................... 754

Hidden [element TypeLib].......................................................................................................................... 755

HideTarget [element CustomAction].......................................................................................................... 756

Hotkey [element Shortcut]..........................................................................................................................757

Icon [element Class]...................................................................................................................................758

Icon [element Control]................................................................................................................................ 759

Icon [element ListItem]............................................................................................................................... 760

Icon [element ProgId]................................................................................................................................. 761

Icon [element RadioButton]........................................................................................................................762

Icon [element Shortcut].............................................................................................................................. 763

IconIndex [element Class]..........................................................................................................................764

IconIndex [element ProgId]........................................................................................................................ 765

IconIndex [element Shortcut]..................................................................................................................... 766

IconSize [element Control]......................................................................................................................... 767

Id [element AppId]...................................................................................................................................... 768

Id [element AssemblyName]...................................................................................................................... 769

Id [element Billboard]..................................................................................................................................770

Id [element BillboardAction]....................................................................................................................... 771

Id [element Binary]..................................................................................................................................... 772

Id [element BinaryRef]................................................................................................................................773

Id [element Category].................................................................................................................................774

Id [element Class].......................................................................................................................................775

Id [element Column]................................................................................................................................... 776

Id [element Component].............................................................................................................................777

Id [element ComponentGroup]...................................................................................................................778

Id [element ComponentGroupRef]............................................................................................................. 779

Id [element ComponentRef]....................................................................................................................... 780

Id [element ComponentSearch]................................................................................................................. 781

10

Page 11: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Id [element Control]....................................................................................................................................782

Id [element CopyFile]................................................................................................................................. 783

Id [element CustomAction]......................................................................................................................... 784

Id [element CustomActionRef]................................................................................................................... 785

Id [element CustomTable].......................................................................................................................... 786

Id [element Dialog]..................................................................................................................................... 787

Id [element DialogRef]................................................................................................................................788

Id [element DigitalCertificate]..................................................................................................................... 789

Id [element Directory]................................................................................................................................. 790

Id [element DirectoryRef]............................................................................................................................791

Id [element DirectorySearch]......................................................................................................................792

Id [element DirectorySearchRef]................................................................................................................ 793

Id [element EmbeddedChainer]................................................................................................................. 794

Id [element EmbeddedChainerRef]............................................................................................................795

Id [element EmbeddedUI].......................................................................................................................... 796

Id [element EmbeddedUIResource]........................................................................................................... 797

Id [element EnsureTable]........................................................................................................................... 798

Id [element Environment]........................................................................................................................... 799

Id [element Error]........................................................................................................................................800

Id [element Extension]................................................................................................................................801

Id [element Feature]................................................................................................................................... 802

Id [element FeatureGroup]......................................................................................................................... 803

Id [element FeatureGroupRef]................................................................................................................... 804

Id [element FeatureRef]..............................................................................................................................805

Id [element File]..........................................................................................................................................806

Id [element FileSearch].............................................................................................................................. 807

Id [element FileSearchRef].........................................................................................................................808

Id [element Fragment]................................................................................................................................ 809

Id [element Icon].........................................................................................................................................810

Id [element IconRef]................................................................................................................................... 811

Id [element IgnoreTable]............................................................................................................................ 812

Id [element IniFile]......................................................................................................................................813

Id [element IniFileSearch]...........................................................................................................................814

Id [element Instance]..................................................................................................................................815

Id [element Interface]..................................................................................................................................816

Id [element Media]......................................................................................................................................817

Id [element Merge]..................................................................................................................................... 818

Id [element MergeRef]................................................................................................................................819

Id [element Module]....................................................................................................................................820

Id [element ODBCDataSource].................................................................................................................. 821

Id [element ODBCDriver]............................................................................................................................822

Id [element ODBCTranslator].....................................................................................................................823

Id [element Package]..................................................................................................................................824

Id [element Patch]...................................................................................................................................... 825

Id [element PatchBaseline]........................................................................................................................ 826

Id [element PatchCreation].........................................................................................................................827

Id [element PatchFamily]............................................................................................................................828

Id [element PatchFamilyRef]...................................................................................................................... 829

Id [element Product]................................................................................................................................... 830

Id [element ProgId].....................................................................................................................................831

Id [element Property]..................................................................................................................................832

Id [element PropertyRef]............................................................................................................................ 833

Id [element Registry].................................................................................................................................. 834

Id [element RegistryKey]............................................................................................................................ 835

Id [element RegistrySearch].......................................................................................................................836

11

Page 12: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Id [element RegistrySearchRef]................................................................................................................. 837

Id [element RegistryValue]......................................................................................................................... 838

Id [element RemoveFile]............................................................................................................................ 839

Id [element RemoveFolder]........................................................................................................................840

Id [element RemoveRegistryKey]...............................................................................................................841

Id [element RemoveRegistryValue]............................................................................................................842

Id [element ReplacePatch]......................................................................................................................... 843

Id [element ReserveCost]...........................................................................................................................844

Id [element ServiceControl]........................................................................................................................845

Id [element ServiceDependency]............................................................................................................... 846

Id [element ServiceInstall].......................................................................................................................... 847

Id [element SetDirectory]............................................................................................................................848

Id [element SetProperty].............................................................................................................................849

Id [element SFPFile]...................................................................................................................................850

Id [element Shortcut].................................................................................................................................. 851

Id [element TargetFile]............................................................................................................................... 852

Id [element TargetImage]........................................................................................................................... 853

Id [element TargetProductCode]................................................................................................................ 854

Id [element TextStyle].................................................................................................................................855

Id [element TypeLib]...................................................................................................................................856

Id [element UI]............................................................................................................................................857

Id [element UIRef]...................................................................................................................................... 858

Id [element UIText].....................................................................................................................................859

Id [element Upgrade]..................................................................................................................................860

Id [element UpgradeImage]........................................................................................................................861

Id [element Verb]........................................................................................................................................862

Id [element WixVariable]............................................................................................................................ 863

Ignore [element UpgradeFile].....................................................................................................................864

IgnoreActionData [element EmbeddedUI]..................................................................................................865

IgnoreActionStart [element EmbeddedUI]..................................................................................................866

IgnoreAddExistingRow [element Validate]................................................................................................. 867

IgnoreAddExistingTable [element Validate]............................................................................................... 868

IgnoreChangingCodePage [element Validate]...........................................................................................869

IgnoreCommonData [element EmbeddedUI]............................................................................................. 870

IgnoreDeleteMissingRow [element Validate]............................................................................................. 871

IgnoreDeleteMissingTable [element Validate]............................................................................................872

IgnoreError [element EmbeddedUI]........................................................................................................... 873

IgnoreFatalExit [element EmbeddedUI]..................................................................................................... 874

IgnoreFilesInUse [element EmbeddedUI].................................................................................................. 875

IgnoreInfo [element EmbeddedUI]............................................................................................................. 876

IgnoreInitialize [element EmbeddedUI]...................................................................................................... 877

IgnoreMissingFiles [element TargetImage]................................................................................................ 878

IgnoreOutOfDiskSpace [element EmbeddedUI]........................................................................................ 879

IgnoreParent [element FeatureGroupRef]..................................................................................................880

IgnoreParent [element FeatureRef]............................................................................................................881

IgnoreProgress [element EmbeddedUI].....................................................................................................882

IgnoreRemoveFailure [element UpgradeVersion]......................................................................................883

IgnoreResolveSource [element EmbeddedUI]...........................................................................................884

IgnoreRMFilesInUse [element EmbeddedUI].............................................................................................885

IgnoreShowDialog [element EmbeddedUI]................................................................................................ 886

IgnoreTerminate [element EmbeddedUI]................................................................................................... 887

IgnoreUpdateMissingRow [element Validate]............................................................................................ 888

IgnoreUser [element EmbeddedUI]............................................................................................................889

IgnoreWarning [element EmbeddedUI]......................................................................................................890

Image [element Control].............................................................................................................................891

12

Page 13: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Impersonate [element CustomAction]........................................................................................................ 892

IncludeMaximum [element UpgradeVersion]............................................................................................. 893

IncludeMinimum [element UpgradeVersion].............................................................................................. 894

Indirect [element Control]........................................................................................................................... 895

Insertable [element Class]..........................................................................................................................896

InstallDefault [element Feature]................................................................................................................. 897

InstallerVersion [element Package]............................................................................................................898

InstallPrivileges [element Package]........................................................................................................... 899

InstallScope [element Package].................................................................................................................900

Integer [element Control]............................................................................................................................901

Interactive [element ServiceInstall]............................................................................................................ 902

Italic [element TextStyle]............................................................................................................................ 903

JScriptCall [element CustomAction]...........................................................................................................904

KeepModeless [element Dialog]................................................................................................................ 905

Key [element IniFile]...................................................................................................................................906

Key [element IniFileSearch]....................................................................................................................... 907

Key [element Registry]............................................................................................................................... 908

Key [element RegistryKey].........................................................................................................................909

Key [element RegistrySearch]....................................................................................................................910

Key [element RegistryValue]......................................................................................................................911

Key [element RemoveRegistryKey]........................................................................................................... 912

Key [element RemoveRegistryValue]........................................................................................................ 913

KeyColumn [element Column]................................................................................................................... 914

KeyNoOrphan [element Configuration]...................................................................................................... 915

KeyPath [element Component].................................................................................................................. 916

KeyPath [element File]............................................................................................................................... 917

KeyPath [element ODBCDataSource]....................................................................................................... 918

KeyPath [element Registry]........................................................................................................................919

KeyPath [element RegistryValue].............................................................................................................. 920

KeyTable [element Column].......................................................................................................................921

Keywords [element Package].....................................................................................................................922

Keywords [element PatchInformation]....................................................................................................... 923

Language [element Merge]........................................................................................................................ 924

Language [element Module].......................................................................................................................925

Language [element Product]...................................................................................................................... 926

Language [element TypeLib]......................................................................................................................927

Language [element UpgradeVersion]........................................................................................................ 928

Languages [element FileSearch]............................................................................................................... 929

Languages [element Package]...................................................................................................................930

Languages [element PatchInformation]..................................................................................................... 931

Layout [element Media]..............................................................................................................................932

LeftScroll [element Control]........................................................................................................................933

LeftScroll [element Dialog]......................................................................................................................... 934

Length [element IgnoreRange]...................................................................................................................935

Length [element ProtectRange]................................................................................................................. 936

Level [element Condition]...........................................................................................................................937

Level [element Feature]..............................................................................................................................938

LoadOrderGroup [element ServiceInstall]..................................................................................................939

Localizable [element Column].................................................................................................................... 940

LocalService [element AppId].................................................................................................................... 941

Location [element Component].................................................................................................................. 942

LongName [element Directory].................................................................................................................. 943

LongName [element File]........................................................................................................................... 944

LongName [element FileSearch]................................................................................................................945

LongName [element IniFile]....................................................................................................................... 946

13

Page 14: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

LongName [element IniFileSearch]............................................................................................................947

LongName [element RemoveFile]..............................................................................................................948

LongName [element Shortcut]................................................................................................................... 949

LongSource [element Directory].................................................................................................................950

MajorVersion [element TypeLib]................................................................................................................ 951

Manufacturer [element Package]............................................................................................................... 952

Manufacturer [element Patch].................................................................................................................... 953

Manufacturer [element PatchInformation].................................................................................................. 954

Manufacturer [element Product].................................................................................................................955

ManufacturerName [element PatchMetadata]........................................................................................... 956

Mask [element FileTypeMask]................................................................................................................... 957

MaxDate [element FileSearch]...................................................................................................................958

Maximum [element UpgradeVersion].........................................................................................................959

MaxSize [element FileSearch]................................................................................................................... 960

MaxValue [element Column]...................................................................................................................... 961

MaxVersion [element FileSearch].............................................................................................................. 962

MediaSrcProp [element Family]................................................................................................................. 963

Message [element Condition].....................................................................................................................964

MigrateFeatures [element UpgradeVersion].............................................................................................. 965

MinDate [element FileSearch]....................................................................................................................966

Minimum [element UpgradeVersion]..........................................................................................................967

MinorUpdateTargetRTM [element Patch].................................................................................................. 968

MinorUpdateTargetRTM [element PatchMetadata]................................................................................... 969

MinorVersion [element TypeLib]................................................................................................................ 970

MinSize [element FileSearch].................................................................................................................... 971

MinValue [element Column]....................................................................................................................... 972

MinVersion [element FileSearch]............................................................................................................... 973

Modeless [element Dialog].........................................................................................................................974

Modularize [element Column].................................................................................................................... 975

MoreInfoURL [element Patch]....................................................................................................................976

MoreInfoURL [element PatchMetadata].....................................................................................................977

Multiline [element Control]..........................................................................................................................978

Name [element Configuration]................................................................................................................... 979

Name [element ConfigurationData]............................................................................................................980

Name [element Directory].......................................................................................................................... 981

Name [element EmbeddedUI]....................................................................................................................982

Name [element EmbeddedUIResource].................................................................................................... 983

Name [element Environment].....................................................................................................................984

Name [element Family].............................................................................................................................. 985

Name [element File]................................................................................................................................... 986

Name [element FileSearch]........................................................................................................................987

Name [element IgnoreModularization]....................................................................................................... 988

Name [element IniFile]............................................................................................................................... 989

Name [element IniFileSearch]....................................................................................................................990

Name [element Interface]...........................................................................................................................991

Name [element ODBCDataSource]........................................................................................................... 992

Name [element ODBCDriver].....................................................................................................................993

Name [element ODBCTranslator].............................................................................................................. 994

Name [element PatchProperty].................................................................................................................. 995

Name [element Product].............................................................................................................................996

Name [element Registry]............................................................................................................................997

Name [element RegistrySearch]................................................................................................................ 998

Name [element RegistryValue].................................................................................................................. 999

Name [element RemoveFile]......................................................................................................................1000

Name [element RemoveRegistryValue]..................................................................................................... 1001

14

Page 15: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Name [element ServiceControl]................................................................................................................. 1002

Name [element ServiceInstall]................................................................................................................... 1003

Name [element SFPCatalog]..................................................................................................................... 1004

Name [element Shortcut]............................................................................................................................1005

NeverOverwrite [element Component].......................................................................................................1006

NoMinimize [element Dialog]..................................................................................................................... 1007

NonNullable [element Configuration]......................................................................................................... 1008

NoOpen [element ProgId].......................................................................................................................... 1009

NoPrefix [element Control]......................................................................................................................... 1010

Notify [element Permission]....................................................................................................................... 1011

NoWrap [element Control]..........................................................................................................................1012

Nullable [element Column]......................................................................................................................... 1013

NumMethods [element Interface]............................................................................................................... 1014

Offset [element FileTypeMask].................................................................................................................. 1015

Offset [element IgnoreRange].................................................................................................................... 1016

Offset [element ProtectRange]...................................................................................................................1017

On [element RemoveFile].......................................................................................................................... 1018

On [element RemoveFolder]...................................................................................................................... 1019

OnExit [element Custom]........................................................................................................................... 1020

OnExit [element Show]...............................................................................................................................1021

OnlyDetect [element UpgradeVersion].......................................................................................................1022

OptimizedInstallMode [element Patch].......................................................................................................1023

OptimizedInstallMode [element PatchMetadata]........................................................................................1024

OptimizePatchSizeForLargeFiles [element Patch].....................................................................................1025

Order [element ExternalFile]...................................................................................................................... 1026

Order [element Publish]..............................................................................................................................1027

Order [element TargetImage].....................................................................................................................1028

OutputPath [element PatchCreation]......................................................................................................... 1029

Overridable [element Custom]................................................................................................................... 1030

Overridable [element Show].......................................................................................................................1031

Overridable [element WixVariable].............................................................................................................1032

Overridable [type ActionModuleSequenceType]........................................................................................1033

Parent [element DirectorySearchRef]........................................................................................................ 1034

Part [element Environment]........................................................................................................................1035

Password [element Control]....................................................................................................................... 1036

Password [element ServiceInstall]............................................................................................................. 1037

PatchAllowIgnoreOnError [element File]....................................................................................................1038

PatchFamily [element PatchSequence]..................................................................................................... 1039

PatchGroup [element File]......................................................................................................................... 1040

PatchIgnore [element File]......................................................................................................................... 1041

PatchUninstall [element CustomAction]..................................................................................................... 1042

PatchWholeFile [element File]................................................................................................................... 1043

Path [element DirectorySearch]................................................................................................................. 1044

Path [element DirectorySearchRef]............................................................................................................1045

Path [element SymbolPath]........................................................................................................................1046

Permanent [element Component].............................................................................................................. 1047

Permanent [element Environment].............................................................................................................1048

Platform [element Package]....................................................................................................................... 1049

Platforms [element Package]..................................................................................................................... 1050

Platforms [element PatchInformation]........................................................................................................ 1051

Primary [element ComponentGroupRef]....................................................................................................1052

Primary [element ComponentRef]..............................................................................................................1053

Primary [element FeatureGroupRef].......................................................................................................... 1054

Primary [element MergeRef]...................................................................................................................... 1055

PrimaryKey [element Column]................................................................................................................... 1056

15

Page 16: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

ProcessorArchitecture [element File]......................................................................................................... 1057

ProductCode [element Instance]................................................................................................................1058

ProductCode [element PatchFamily]..........................................................................................................1059

ProductCode [element PatchSequence].................................................................................................... 1060

ProductId [element Validate]...................................................................................................................... 1061

ProductLanguage [element Validate]......................................................................................................... 1062

ProductName [element Instance]...............................................................................................................1063

ProductVersion [element Validate].............................................................................................................1064

ProductVersionOperator [element Validate]...............................................................................................1065

Programmable [element Class]..................................................................................................................1066

ProgressBlocks [element Control]..............................................................................................................1067

Property [element ComboBox]................................................................................................................... 1068

Property [element Control]......................................................................................................................... 1069

Property [element CustomAction].............................................................................................................. 1070

Property [element CustomProperty]...........................................................................................................1071

Property [element InstanceTransforms]..................................................................................................... 1072

Property [element ListBox]......................................................................................................................... 1073

Property [element ListView]....................................................................................................................... 1074

Property [element Publish]......................................................................................................................... 1075

Property [element RadioButtonGroup]....................................................................................................... 1076

Property [element RemoveFile]..................................................................................................................1077

Property [element RemoveFolder]............................................................................................................. 1078

Property [element UpgradeVersion]...........................................................................................................1079

PropertySource [element EmbeddedChainer]........................................................................................... 1080

ProxyStubClassId [element Interface]........................................................................................................1081

ProxyStubClassId32 [element Interface]....................................................................................................1082

PushLike [element Control]........................................................................................................................ 1083

Qualifier [element Category]...................................................................................................................... 1084

RAMDisk [element Control]........................................................................................................................1085

Read [element Permission]........................................................................................................................ 1086

ReadAttributes [element Permission].........................................................................................................1087

ReadExtendedAttributes [element Permission]..........................................................................................1088

ReadOnly [element File].............................................................................................................................1089

ReadOnly [element Package].................................................................................................................... 1090

ReadOnly [element PatchInformation]....................................................................................................... 1091

ReadPermission [element Permission]...................................................................................................... 1092

Red [element TextStyle].............................................................................................................................1093

Registration [element ODBCDataSource]..................................................................................................1094

RelativePath [element Class]..................................................................................................................... 1095

Remote [element Control].......................................................................................................................... 1096

RemoteServerName [element AppId]........................................................................................................ 1097

Removable [element Control].....................................................................................................................1098

Remove [element ServiceControl]............................................................................................................. 1099

RemoveFeatures [element UpgradeVersion].............................................................................................1100

RequiredId [element Dependency].............................................................................................................1101

RequiredLanguage [element Dependency]................................................................................................1102

RequiredVersion [element Dependency]................................................................................................... 1103

RequiredVersion [element Wix]..................................................................................................................1104

ResourceId [element TypeLib]................................................................................................................... 1105

Restricted [element TypeLib]..................................................................................................................... 1106

Return [element CustomAction]................................................................................................................. 1107

RightAligned [element Control].................................................................................................................. 1108

RightAligned [element Dialog]....................................................................................................................1109

RightToLeft [element Control].................................................................................................................... 1110

RightToLeft [element Dialog]......................................................................................................................1111

16

Page 17: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Root [element Registry]..............................................................................................................................1112

Root [element RegistryKey]....................................................................................................................... 1113

Root [element RegistrySearch].................................................................................................................. 1114

Root [element RegistryValue].................................................................................................................... 1115

Root [element RemoveRegistryKey].......................................................................................................... 1116

Root [element RemoveRegistryValue]....................................................................................................... 1117

Row [element Substitution]........................................................................................................................ 1118

RunAsInteractiveUser [element AppId]...................................................................................................... 1119

RunFromSource [element ReserveCost]................................................................................................... 1120

RunLocal [element ReserveCost].............................................................................................................. 1121

SafeForInitializing [element Class].............................................................................................................1122

SafeForScripting [element Class]...............................................................................................................1123

Script [element CustomAction]...................................................................................................................1124

Section [element IniFile].............................................................................................................................1125

Section [element IniFileSearch]................................................................................................................. 1126

Secure [element Property]......................................................................................................................... 1127

SelfRegCost [element File]........................................................................................................................ 1128

Separator [element Environment].............................................................................................................. 1129

Sequence [element Custom]......................................................................................................................1130

Sequence [element PatchSequence].........................................................................................................1131

Sequence [element SetDirectory].............................................................................................................. 1132

Sequence [element SetProperty]............................................................................................................... 1133

Sequence [element Show]......................................................................................................................... 1134

Sequence [element Verb]...........................................................................................................................1135

Sequence [type ActionModuleSequenceType].......................................................................................... 1136

Sequence [type ActionSequenceType]...................................................................................................... 1137

SequenceStart [element Family]................................................................................................................ 1138

Server [element Class]...............................................................................................................................1139

ServiceParameters [element AppId].......................................................................................................... 1140

Set [element Column].................................................................................................................................1141

SetupFile [element ODBCDriver]............................................................................................................... 1142

SetupFile [element ODBCTranslator].........................................................................................................1143

Shared [element Component].................................................................................................................... 1144

Shared [element IsolateComponent]..........................................................................................................1145

SharedDllRefCount [element Component].................................................................................................1146

ShortName [element Directory]..................................................................................................................1147

ShortName [element File]...........................................................................................................................1148

ShortName [element FileSearch]............................................................................................................... 1149

ShortName [element IniFile].......................................................................................................................1150

ShortName [element IniFileSearch]........................................................................................................... 1151

ShortName [element RemoveFile]............................................................................................................. 1152

ShortName [element Shortcut]...................................................................................................................1153

ShortNames [element Package]................................................................................................................ 1154

ShortNames [element PatchInformation]................................................................................................... 1155

ShortPath [element Class]......................................................................................................................... 1156

ShortSourceName [element Directory]...................................................................................................... 1157

Show [element Shortcut]............................................................................................................................ 1158

ShowRollbackCost [element Control].........................................................................................................1159

Size [element TextStyle].............................................................................................................................1160

SkipAssignment [element OptimizeCustomActions].................................................................................. 1161

SkipDeferred [element OptimizeCustomActions]....................................................................................... 1162

SkipImmediate [element OptimizeCustomActions].................................................................................... 1163

Sorted [element Control]............................................................................................................................ 1164

Source [element ExternalFile].................................................................................................................... 1165

Source [element File]................................................................................................................................. 1166

17

Page 18: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Source [element Media]............................................................................................................................. 1167

SourceDirectory [element CopyFile].......................................................................................................... 1168

SourceFile [element Binary]....................................................................................................................... 1169

SourceFile [element DigitalCertificate]....................................................................................................... 1170

SourceFile [element DigitalSignature]........................................................................................................1171

SourceFile [element EmbeddedUI]............................................................................................................ 1172

SourceFile [element EmbeddedUIResource].............................................................................................1173

SourceFile [element Icon].......................................................................................................................... 1174

SourceFile [element Merge]....................................................................................................................... 1175

SourceFile [element SFPCatalog]..............................................................................................................1176

SourceFile [element TargetImage].............................................................................................................1177

SourceFile [element Text].......................................................................................................................... 1178

SourceFile [element UpgradeImage]......................................................................................................... 1179

SourceList [element PatchCreation]...........................................................................................................1180

SourceName [element CopyFile]............................................................................................................... 1181

SourceName [element Directory]............................................................................................................... 1182

SourcePatch [element UpgradeImage]...................................................................................................... 1183

SourceProperty [element CopyFile]........................................................................................................... 1184

src [element Binary]....................................................................................................................................1185

src [element Directory]............................................................................................................................... 1186

src [element DirectoryRef]..........................................................................................................................1187

src [element ExternalFile]...........................................................................................................................1188

src [element File]........................................................................................................................................1189

src [element Icon].......................................................................................................................................1190

src [element Media]....................................................................................................................................1191

src [element Merge]....................................................................................................................................1192

src [element TargetImage]......................................................................................................................... 1193

src [element Text].......................................................................................................................................1194

src [element UpgradeImage]......................................................................................................................1195

srcPatch [element UpgradeImage].............................................................................................................1196

Start [element ServiceControl]................................................................................................................... 1197

Start [element ServiceInstall]..................................................................................................................... 1198

Stop [element ServiceControl]................................................................................................................... 1199

Strike [element TextStyle].......................................................................................................................... 1200

SummaryCodepage [element Package].................................................................................................... 1201

SummaryCodepage [element PatchInformation]....................................................................................... 1202

Sunken [element Control]...........................................................................................................................1203

Supersede [element PatchFamily]............................................................................................................. 1204

Supersede [element PatchSequence]........................................................................................................1205

SupportBasicUI [element EmbeddedUI].................................................................................................... 1206

Suppress [type ActionModuleSequenceType]........................................................................................... 1207

Suppress [type ActionSequenceType]....................................................................................................... 1208

SuppressModularization [element Binary]..................................................................................................1209

SuppressModularization [element CustomAction]..................................................................................... 1210

SuppressModularization [element Property].............................................................................................. 1211

SymbolFlags [element PatchCreation].......................................................................................................1212

Synchronize [element Permission].............................................................................................................1213

System [element Environment].................................................................................................................. 1214

System [element File].................................................................................................................................1215

SystemModal [element Dialog].................................................................................................................. 1216

Table [element Substitution].......................................................................................................................1217

TabSkip [element Control]..........................................................................................................................1218

TakeOwnership [element Permission]....................................................................................................... 1219

Target [element PatchSequence]...............................................................................................................1220

Target [element Shortcut]...........................................................................................................................1221

18

Page 19: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Target [element Verb].................................................................................................................................1222

TargetFile [element Verb]...........................................................................................................................1223

TargetImage [element PatchSequence].....................................................................................................1224

TargetProductName [element Patch].........................................................................................................1225

TargetProductName [element PatchMetadata]..........................................................................................1226

TargetProperty [element Verb]...................................................................................................................1227

Template [element ProgressText].............................................................................................................. 1228

TerminalServerAware [element CustomAction]......................................................................................... 1229

Text [element Control]................................................................................................................................1230

Text [element ListItem]...............................................................................................................................1231

Text [element RadioButton]........................................................................................................................1232

ThreadingModel [element Class]............................................................................................................... 1233

Title [element Dialog]..................................................................................................................................1234

Title [element Feature]............................................................................................................................... 1235

ToolTip [element Control]...........................................................................................................................1236

ToolTip [element RadioButton]...................................................................................................................1237

TrackDiskSpace [element Dialog].............................................................................................................. 1238

Transitive [element Component]................................................................................................................ 1239

Transparent [element Control]................................................................................................................... 1240

Traverse [element Permission].................................................................................................................. 1241

TrueType [element File]............................................................................................................................. 1242

Type [element Column].............................................................................................................................. 1243

Type [element ComponentSearch]............................................................................................................ 1244

Type [element Configuration]..................................................................................................................... 1245

Type [element Control]...............................................................................................................................1246

Type [element IgnoreModularization].........................................................................................................1247

Type [element IniFileSearch]..................................................................................................................... 1248

Type [element Registry]............................................................................................................................. 1249

Type [element RegistrySearch]..................................................................................................................1250

Type [element RegistryValue].................................................................................................................... 1251

Type [element ServiceInstall]..................................................................................................................... 1252

TypicalDefault [element Feature]............................................................................................................... 1253

Underline [element TextStyle].................................................................................................................... 1254

UninstallWhenSuperseded [element Component]..................................................................................... 1255

UpgradeCode [element Product]................................................................................................................1256

UpgradeCode [element Validate]............................................................................................................... 1257

User [element Permission]......................................................................................................................... 1258

UserLanguage [element Control]............................................................................................................... 1259

Validation [element TargetImage].............................................................................................................. 1260

Value [element AssemblyName]................................................................................................................ 1261

Value [element ConfigurationData]............................................................................................................ 1262

Value [element CustomAction]...................................................................................................................1263

Value [element CustomProperty]............................................................................................................... 1264

Value [element Environment]..................................................................................................................... 1265

Value [element FileTypeMask]...................................................................................................................1266

Value [element IniFile]................................................................................................................................1267

Value [element ListItem].............................................................................................................................1268

Value [element PatchProperty].................................................................................................................. 1269

Value [element Property]............................................................................................................................1270

Value [element Publish]..............................................................................................................................1271

Value [element RadioButton]..................................................................................................................... 1272

Value [element Registry]............................................................................................................................ 1273

Value [element RegistryValue]...................................................................................................................1274

Value [element SetDirectory]..................................................................................................................... 1275

Value [element SetProperty]...................................................................................................................... 1276

19

Page 20: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Value [element Substitution]...................................................................................................................... 1277

Value [element WixVariable]...................................................................................................................... 1278

VBScriptCall [element CustomAction]........................................................................................................1279

Version [element Class]............................................................................................................................. 1280

Version [element Module].......................................................................................................................... 1281

Version [element PatchFamily].................................................................................................................. 1282

Version [element Product]..........................................................................................................................1283

Versioned [element Interface].................................................................................................................... 1284

Vital [element File]......................................................................................................................................1285

Vital [element ServiceInstall]...................................................................................................................... 1286

VolumeLabel [element Family]...................................................................................................................1287

VolumeLabel [element Media]....................................................................................................................1288

Wait [element ServiceControl]....................................................................................................................1289

WholeFile [element UpgradeFile]...............................................................................................................1290

WholeFilesOnly [element PatchCreation].................................................................................................. 1291

Width [element Column].............................................................................................................................1292

Width [element Control]..............................................................................................................................1293

Width [element Dialog]............................................................................................................................... 1294

Width [element RadioButton]..................................................................................................................... 1295

Win64 [element Component]......................................................................................................................1296

Win64 [element CustomAction]..................................................................................................................1297

Win64 [element RegistrySearch]................................................................................................................1298

WorkingDirectory [element Shortcut]......................................................................................................... 1299

Write [element Permission]........................................................................................................................ 1300

WriteAttributes [element Permission]......................................................................................................... 1301

WriteExtendedAttributes [element Permission]..........................................................................................1302

X [element Control].....................................................................................................................................1303

X [element Dialog]......................................................................................................................................1304

X [element RadioButton]............................................................................................................................ 1305

Y [element Control].....................................................................................................................................1306

Y [element Dialog]......................................................................................................................................1307

Y [element RadioButton]............................................................................................................................ 1308

Complex Types............................................................................................................................................ 1309

ActionModuleSequenceType..................................................................................................................... 1310

ActionSequenceType................................................................................................................................. 1312

Simple Types............................................................................................................................................... 1315

AutogenGuid.............................................................................................................................................. 1316

ComponentGuid......................................................................................................................................... 1317

Guid............................................................................................................................................................1318

HexType..................................................................................................................................................... 1320

LocalizableInteger...................................................................................................................................... 1321

LongFileNameType....................................................................................................................................1322

PatchClassificationType.............................................................................................................................1324

RegistryRootType.......................................................................................................................................1326

ShortFileNameType................................................................................................................................... 1328

VersionType............................................................................................................................................... 1329

WildCardLongFileNameType..................................................................................................................... 1330

WildCardShortFileNameType.................................................................................................................... 1331

YesNoDefaultType..................................................................................................................................... 1332

YesNoType.................................................................................................................................................1333

20

Page 21: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

WiX Database XML Schema

Description

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

Namespace

http://schemas.microsoft.com/wix/2006/wi

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

21

Page 22: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements: WiX Database

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 complexCDATA.

AppId Application ID containing DCOM information for the associatedapplication GUID.

AppSearch Uses file signatures to search for existing versions of products.

AssemblyName The MsiAssemblyName table specifies the schema for the elements ofa strong assembly cache name for a .NET Framework or Win32assembly.

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 apatch.

BindImage Binds each executable or DLL that must be bound to the DLLsimported by it.

Category Qualified published component for parent Component

CCPSearch Uses file signatures to validate that qualifying products are installed ona 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 installProperty

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 thatis being installed, to another destination.

22

Page 23: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

CostFinalize Ends the internal installation costing process begun by theCostInitialize 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 thereferenced 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 andspecified 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 installerdatabase, 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 isincompatible.

ExecuteAction Initiates the execution sequence.

Extension Extension for a Component

23

Page 24: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

ExternalFile Contains information about specific files that are not part of a regulartarget 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 beused 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 andcompares the upgrade code, product version, and language in eachrow 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 installerdatabase 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 apatch.

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 ofparent Property

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

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

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

InstallExecuteSequence

InstallFiles Copies files specified in the File table from the source directory to thedestination directory.

24

Page 25: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

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 ODBCDrivertable, 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 parentComponent

IsolateComponents Installs a copy of a component (commonly a shared DLL) into a privatelocation for use by a specific application (typically an .exe).

LaunchConditions Queries the LaunchCondition table and evaluates each conditionalstatement 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 forthe installation.

Merge Merge directive to bring in a merge module that will be redirected tothe 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 toa new location.

MsiPublishAssemblies Manages the advertisement of CLR and Win32 assemblies.

MsiUnpublishAssemblies Manages the unadvertisement of CLR and Win32 assemblies that arebeing removed.

MultiStringValue Use several of these elements to specify each registry value in amultiString 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 thepatch.

25

Page 26: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

Package Properties about the package to be placed in the Summary InformationStream.

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 Cprogram.

PatchFamily Collection of items that should be kept from the differences betweentwo products.

PatchFamilyRef This will cause the entire contents of the Fragment containing thereferenced 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 InformationStream.

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 thecomponent 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 thePublishComponent 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 parentControl (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 thesystem.

RegisterFonts Registers installed fonts with the system.

26

Page 27: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

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 aproduct.

Registry

RegistryKey Used for organization of child RegistryValue elements or to create aregistry key (and optionally remove it during uninstallation).

RegistrySearch Searches for file, directory or registry key and assigns to value ofparent Property

RegistrySearchRef References an existing RegistrySearch element.

RegistryValue Used to create a registry value. For multi-string values, this can beused 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 ofthe Upgrade table and removes the products in sequence.

RemoveFile Remove a file(s) if the parent component is selected for installation orremoval.

RemoveFiles Removes files previously installed by the InstallFiles action.

RemoveFolder Remove an empty folder if the parent component is selected forinstallation or removal.

RemoveFolders Removes any folders linked to components set to be removed or runfrom source.

RemoveIniValues Removes .ini file information specified for removal in the RemoveIniFiletable if the component is set to be installed locally or run from source.

RemoveODBC Removes the data sources, translators, and drivers listed for removalduring the installation.

RemoveRegistryKey Used for removing registry keys and all child keys either during installor uninstall.

RemoveRegistryValue Used to remove a registry value during installation.

RemoveRegistryValues Removes a registry value that has been authored into the registry tableif the associated component was installed locally or as run fromsource, and is now set to be uninstalled.

RemoveShortcuts Manages the removal of an advertised shortcut whose feature isselected for uninstallation or a nonadvertised shortcut whosecomponent 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 propertyif the source has not been resolved yet.

27

Page 28: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

RMCCPSearch Uses file signatures to validate that qualifying products are installed ona 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 allinstalled modules with the system.

SelfUnregModules Unregisters all modules listed in the SelfReg table that are scheduledto 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 eachnew 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 theFile table

Shortcut Shortcut, default target is parent File, CreateFolder, or Component'sDirectory

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 atemplate 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 allproducts).

Text An alternative to using the Text attribute when the value containsspecial 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 referencedFragment's contents to be included in the installer database.

UIText Text associated with certain controls

28

Page 29: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Elements

Name Description

UnpublishComponents Manages the unadvertisement of components listed in thePublishComponent table.

UnpublishFeatures Removes selection-state and feature-component mapping informationfrom the registry.

UnregisterClassInfo Manages the removal of COM class information from the systemregistry.

UnregisterComPlus Removes COM+ applications from the registry.

UnregisterExtensionInfo Manages the removal of extension-related information from the systemregistry.

UnregisterFonts Removes registration information about installed fonts from thesystem.

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 whichproduct the transform applies and what errors should be ignored whenapplying 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.

29

Page 30: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AdminExecuteSequence

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

CostFinalize ActionSequenceType 1..1 Ends the internal installation costing processbegun by the CostInitialize action.

CostInitialize ActionSequenceType 1..1 Initiates the internal installation costingprocess.

Custom string (extension) 0..* Use to sequence a custom action.

FileCost ActionSequenceType 1..1 Initiates dynamic costing of standardinstallation actions.

InstallAdminPackage

ActionSequenceType 1..1 Copies the product database to theadministrative installation point. The conditionfor this action may be specified in the element'sinner text.

InstallFiles ActionSequenceType 1..1 Copies files specified in the File table from thesource directory to the destination directory.

InstallFinalize ActionSequenceType 1..1 Marks the end of a sequence of actions thatchange the system.

InstallInitialize ActionSequenceType 1..1 Marks the beginning of a sequence of actionsthat change the system.

InstallValidate ActionSequenceType 1..1 Verifies that all costed volumes have enoughspace for the installation.

LaunchConditions ActionModuleSequenceType

1..1 Queries the LaunchCondition table andevaluates each conditional statement recordedthere.

ResolveSource ActionModuleSequenceType

0..1 Determines the location of the source and setsthe SourceDir property if the source has notbeen resolved yet.

Definition

<xs:element name="AdminExecuteSequence"><xs:annotation><xs:appinfo><xse:msiRef table="AdminExecuteSequence" href="http://msdn.microsoft.com/library/aa367540.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Custom" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Use to sequence a custom action.</xs:documentation>

</xs:annotation>

30

Page 31: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:element><xs:element ref="CostInitialize"><xs:annotation><xs:documentation>Initiates the internal installation costing process.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="FileCost"><xs:annotation><xs:documentation>Initiates dynamic costing of standard installation actions.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CostFinalize"><xs:annotation><xs:documentation>Ends the internal installation costing process begun by the CostInitialize

action.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallValidate"><xs:annotation><xs:documentation>Verifies that all costed volumes have enough space for the

installation.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallInitialize"><xs:annotation><xs:documentation>Marks the beginning of a sequence of actions that change the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallAdminPackage"><xs:annotation><xs:documentation>Copies the product database to the administrative installation

point.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFiles"><xs:annotation><xs:documentation>Copies files specified in the File table from the source directory to the destination

directory.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFinalize"><xs:annotation><xs:documentation>Marks the end of a sequence of actions that change the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="LaunchConditions"><xs:annotation><xs:documentation>Queries the LaunchCondition table and evaluates each conditional statement

recorded there.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ResolveSource" minOccurs="0"><xs:annotation><xs:documentation>Determines the location of the source and sets the SourceDir property if the source

has not been resolved yet.</xs:documentation></xs:annotation>

</xs:element></xs:choice>

</xs:complexType>

31

Page 32: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:element>

32

Page 33: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AdminUISequence

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

CostFinalize ActionSequenceType 1..1 Ends the internal installation costing processbegun by the CostInitialize action.

CostInitialize ActionSequenceType 1..1 Initiates the internal installation costingprocess.

Custom string (extension) 0..* Use to sequence a custom action.

ExecuteAction ActionSequenceType 1..1 Initiates the execution sequence.

FileCost ActionSequenceType 1..1 Initiates dynamic costing of standardinstallation actions.

InstallAdminPackage

ActionSequenceType 1..1 Copies the product database to theadministrative installation point. The conditionfor this action may be specified in the element'sinner text.

InstallFiles ActionSequenceType 1..1 Copies files specified in the File table from thesource directory to the destination directory.

InstallFinalize ActionSequenceType 1..1 Marks the end of a sequence of actions thatchange the system.

InstallInitialize ActionSequenceType 1..1 Marks the beginning of a sequence of actionsthat change the system.

InstallValidate ActionSequenceType 1..1 Verifies that all costed volumes have enoughspace for the installation.

LaunchConditions ActionModuleSequenceType

1..1 Queries the LaunchCondition table andevaluates each conditional statement recordedthere.

Show string (extension) 0..*

Definition

<xs:element name="AdminUISequence"><xs:annotation><xs:appinfo><xse:msiRef table="AdminUISequence" href="http://msdn.microsoft.com/library/aa367544.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Custom" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Use to sequence a custom action.</xs:documentation>

</xs:annotation></xs:element>

33

Page 34: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="Show" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="CostInitialize"><xs:annotation><xs:documentation>Initiates the internal installation costing process.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="FileCost"><xs:annotation><xs:documentation>Initiates dynamic costing of standard installation actions.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CostFinalize"><xs:annotation><xs:documentation>Ends the internal installation costing process begun by the CostInitialize

action.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ExecuteAction"><xs:annotation><xs:documentation>Initiates the execution sequence.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="InstallValidate"><xs:annotation><xs:documentation>Verifies that all costed volumes have enough space for the

installation.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallInitialize"><xs:annotation><xs:documentation>Marks the beginning of a sequence of actions that change the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallAdminPackage"><xs:annotation><xs:documentation>Copies the product database to the administrative installation

point.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFiles"><xs:annotation><xs:documentation>Copies files specified in the File table from the source directory to the destination

directory.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFinalize"><xs:annotation><xs:documentation>Marks the end of a sequence of actions that change the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="LaunchConditions"><xs:annotation><xs:documentation>Queries the LaunchCondition table and evaluates each conditional statement

recorded there.</xs:documentation></xs:annotation>

</xs:element></xs:choice>

</xs:complexType></xs:element>

34

Page 35: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AdvertiseExecuteSequence

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

CostFinalize ActionSequenceType 1..1 Ends the internal installation costing processbegun by the CostInitialize action.

CostInitialize ActionSequenceType 1..1 Initiates the internal installation costingprocess.

CreateShortcuts ActionSequenceType 1..1 Manages the creation of shortcuts.

Custom string (extension) 0..* Use to sequence a custom action.

InstallFinalize ActionSequenceType 1..1 Marks the end of a sequence of actions thatchange the system.

InstallInitialize ActionSequenceType 1..1 Marks the beginning of a sequence of actionsthat change the system.

InstallValidate ActionSequenceType 1..1 Verifies that all costed volumes have enoughspace for the installation.

MsiPublishAssemblies

ActionSequenceType 1..1 Manages the advertisement of CLR and Win32assemblies.

PublishComponents ActionSequenceType 1..1 Manages the advertisement of the componentsfrom the PublishComponent table.

PublishFeatures ActionSequenceType 1..1 Writes each feature's state into the systemregistry.

PublishProduct ActionSequenceType 1..1 Manages the advertisement of the productinformation with the system.

RegisterClassInfo ActionSequenceType 1..1 Manages the registration of COM classinformation with the system.

RegisterExtensionInfo

ActionSequenceType 1..1 Manages the registration of extension relatedinformation with the system.

RegisterMIMEInfo ActionSequenceType 1..1 Registers MIME-related registry informationwith the system.

RegisterProgIdInfo ActionSequenceType 1..1 Manages the registration of OLE ProgIdinformation with the system.

Definition

<xs:element name="AdvertiseExecuteSequence"><xs:annotation><xs:appinfo><xse:msiRef table="AdvtExecuteSequence" href="http://msdn.microsoft.com/library/aa367551.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType>

35

Page 36: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="CostInitialize"><xs:annotation><xs:documentation>Initiates the internal installation costing process.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CostFinalize"><xs:annotation><xs:documentation>Ends the internal installation costing process begun by the CostInitialize

action.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="Custom" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Use to sequence a custom action. The only custom actions that are allowed in the

AdvtExecuteSequence are type 19 (0x013) type 35 (0x023) and type 51 (0x033).</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallValidate"><xs:annotation><xs:documentation>Verifies that all costed volumes have enough space for the

installation.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallInitialize"><xs:annotation><xs:documentation>Marks the beginning of a sequence of actions that change the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="CreateShortcuts"><xs:annotation><xs:documentation>Manages the creation of shortcuts.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RegisterClassInfo"><xs:annotation><xs:documentation>Manages the registration of COM class information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterExtensionInfo"><xs:annotation><xs:documentation>Manages the registration of extension related information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterMIMEInfo"><xs:annotation><xs:documentation>Registers MIME-related registry information with the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RegisterProgIdInfo"><xs:annotation><xs:documentation>Manages the registration of OLE ProgId information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="PublishComponents"><xs:annotation>

36

Page 37: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Manages the advertisement of the components from the PublishComponenttable.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="PublishFeatures"><xs:annotation><xs:documentation>Writes each feature's state into the system registry.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="PublishProduct"><xs:annotation><xs:documentation>Manages the advertisement of the product information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFinalize"><xs:annotation><xs:documentation>Marks the end of a sequence of actions that change the system.</xs:documentation>

</xs:annotation></xs:element><!-- Windows Installer 1.5 actions --><xs:element ref="MsiPublishAssemblies"><xs:annotation><xs:documentation>Manages the advertisement of CLR and Win32 assemblies.</xs:documentation>

</xs:annotation></xs:element>

</xs:choice></xs:complexType>

</xs:element>

37

Page 38: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AllocateRegistrySpace

Description

Ensures the needed amount of space exists in the registry.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="AllocateRegistrySpace" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="AllocateRegistrySpace" href="http://msdn.microsoft.com/library/aa367554.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Ensures the needed amount of space exists in the registry. The condition for this action

may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

38

Page 39: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AppData

Description

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

Derived By

Type string

Referenced By

● Element Category

Definition

<xs:element name="AppData" type="xs:string"><xs:annotation><xs:documentation>Optional way for defining AppData, generally used for complex

CDATA.</xs:documentation></xs:annotation>

</xs:element>

39

Page 40: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AppId

Description

Application ID containing DCOM information for the associated application GUID.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

ActivateAtStorage

YesNoType No Set this value to 'yes' to configure theclient to activate on the same systemas persistent storage.

Advertise YesNoType No Set this value to 'yes' in order tocreate a normal AppId table row. Setthis value to 'no' in order to generateRegistry rows that perform similarregistration (without the oftenproblematic Windows Installeradvertising behavior).

Description string No Set this value to the description ofthe AppId.

DllSurrogate string No Set this value to specify that theclass is a DLL that is to be activatedin a surrogate EXE process, and thesurrogate process to be used is thepath of a surrogate EXE file specifiedby the value.

Id Guid Yes Set this value to the AppID GUIDthat corresponds to the namedexecutable.

LocalService string No Set this value to the name of aservice to allow the object to beinstalled as a Win32 service.

RemoteServerName

string No Set this value to the name of theremote server to configure the clientto request the object be run at aparticular machine whenever anactivation function is called for whicha COSERVERINFO structure is notspecified.

RunAsInteractiveUser

YesNoType No Set this value to 'yes' to configure aclass to run under the identity of theuser currently logged on andconnected to the interactive desktopwhen activated by a remote clientwithout being written as a Win32service.

ServiceParameters

string No Set this value to the parameters tobe passed to a LocalService oninvocation.

40

Page 41: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

Class anyType (restriction) 1..1 COM Class registration for parent Component.

Referenced By

● Element Component

● Element File

● Element Fragment

● Element TypeLib

Remarks

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

Definition

<xs:element name="AppId"><xs:annotation><xs:documentation>

Application ID containing DCOM information for the associated application GUID.If this element is nested under a Fragment, Module, or Product element, it must beadvertised.

</xs:documentation><xs:appinfo><xse:msiRef table="AppId" href="http://msdn.microsoft.com/library/aa367566.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">

When being used in unadvertised mode, the attributes in the AppId element correspond to registrykeys

as follows (values that can be specified in authoring are in bold):<html:dl

xmlns:html="http://www.w3.org/1999/xhtml"><html:dt>Id</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br /></html:dd><html:dt>SpecificExample</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br/></html:dd></html:dl></html:dd><html:dt>ActivateAtStorage</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />ActivateAtStorage="<html:b>ActivateAtStorage</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />ActivateAtStorage="<html:b>Y</html:b>"

</html:dd></html:dl></html:dd><html:dt>Description</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />@="<html:b>Description</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

41

Page 42: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />@="<html:b>My AppId Description</html:b>"

</html:dd></html:dl></html:dd><html:dt>DllSurrogate</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />DllSurrogate="<html:b>DllSurrogate</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />DllSurrogate="<html:b>C:\surrogate.exe</html:b>"

</html:dd></html:dl></html:dd><html:dt>LocalService</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />LocalService="<html:b>LocalService</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />LocalService="<html:b>MyServiceName</html:b>"

</html:dd></html:dl></html:dd><html:dt>RemoteServerName</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />RemoteServerName="<html:b>RemoteServerName</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />RemoteServerName="<html:b>MyRemoteServer</html:b>"

</html:dd></html:dl></html:dd><html:dt>RunAsInteractiveUser</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />RunAs="<html:b>RunAsInteractiveUser</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />RunAs="<html:b>Interactive User</html:b>"

</html:dd></html:dl></html:dd><html:dt>ServiceParameters</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\AppID\{<html:b>Id</html:b>}]<html:br />ServiceParameters="<html:b>ServiceParameters</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />ServiceParameters="<html:b>-param</html:b>"

</html:dd></html:dl></html:dd></html:dl></xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Class" />

</xs:choice><xs:attribute name="ActivateAtStorage" type="YesNoType"><xs:annotation><xs:documentation>

Set this value to 'yes' to configure the client to activate on the same system as persistent storage.</xs:documentation>

42

Page 43: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Advertise" type="YesNoType"><xs:annotation><xs:documentation>

Set this value to 'yes' in order to create a normal AppId table row. Set this value to 'no' in order togenerate Registry rows that perform similar registration (without the often problematic Windows

Installeradvertising behavior).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>

Set this value to the description of the AppId. It can only be specified when the AppId is not beingadvertised.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DllSurrogate" type="xs:string"><xs:annotation><xs:documentation>

Set this value to specify that the class is a DLL that is to be activated in a surrogate EXEprocess, and the surrogate process to be used is the path of a surrogate EXE file specified by the

value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Id" type="Guid" use="required"><xs:annotation><xs:documentation>

Set this value to the AppID GUID that corresponds to the named executable.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LocalService" type="xs:string"><xs:annotation><xs:documentation>

Set this value to the name of a service to allow the object to be installed as a Win32 service.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="RemoteServerName" type="xs:string"><xs:annotation><xs:documentation>

Set this value to the name of the remote server to configure the client to request the objectbe run at a particular machine whenever an activation function is called for which a

COSERVERINFOstructure is not specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RunAsInteractiveUser" type="YesNoType"><xs:annotation><xs:documentation>

Set this value to 'yes' to configure a class to run under the identity of the user currentlylogged on and connected to the interactive desktop when activated by a remote client withoutbeing written as a Win32 service.

</xs:documentation>

43

Page 44: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="ServiceParameters" type="xs:string"><xs:annotation><xs:documentation>

Set this value to the parameters to be passed to a LocalService on invocation.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

44

Page 45: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AppSearch

Description

Uses file signatures to search for existing versions of products.

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

The AppSearch action may use this information to determine where upgrades are to be installed. TheAppSearch 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. Theinstaller prevents The AppSearch action from running in the InstallExecuteSequence sequence if the action hasalready run in InstallUISequence sequence. The AppSearch action searches for file signatures using theCompLocator 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.

Definition

<xs:element name="AppSearch" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="ComponentSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="FileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:seeAlso ref="IniFileSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="RegistrySearch"

45

Page 46: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="AppSearch" href="http://msdn.microsoft.com/library/aa367579.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="AppSearch" href="http://msdn.microsoft.com/library/aa367578.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Uses file signatures to search for existing versions of products. The AppSearch action

may use this information to determine where upgrades are to be installed. The AppSearch action can also beused to set a property to the existing value of an registry or .ini file entry. AppSearch should be authored intothe InstallUISequence table and InstallExecuteSequence table. The installer prevents The AppSearch actionfrom running in the InstallExecuteSequence sequence if the action has already run in InstallUISequencesequence. The AppSearch action searches for file signatures using the CompLocator table first, theRegLocator table next, then the IniLocator table, and finally the DrLocator table. The condition for this actionmay be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

46

Page 47: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: AssemblyName

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 Required? Default Description

Id string Yes Name of the attribute associated withthe value specified in the Valuecolumn.

Value string No Value associated with the namespecified in the Name column.

Content Model

Always empty.

Referenced By

● Element File

Remarks

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

Definition

<xs:element name="AssemblyName"><xs:annotation><xs:documentation>

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

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

</xs:documentation><xs:appinfo><xse:msiRef table="MsiAssemblyName" href="http://msdn.microsoft.com/library/aa370062.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Name of the attribute associated with the value specified in the Value

column.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>Value associated with the name specified in the Name column.</xs:documentation>

47

Page 48: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

48

Page 49: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Billboard

Description

Billboard to display during install of a Feature

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for the Billboard.

Feature string No Feature whose state determines ifthe Billboard is shown.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Control anyType (restriction) 0..* Contains the controls that appear on eachdialog.

Referenced By

● Element BillboardAction

Definition

<xs:element name="Billboard"><xs:annotation><xs:documentation>

Billboard to display during install of a Feature</xs:documentation>

<xs:appinfo><xse:msiRef table="Billboard" href="http://msdn.microsoft.com/library/aa367823.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="BBControl" href="http://msdn.microsoft.com/library/aa367818.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Control" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Only controls of static type such as: Text, Bitmap, Icon, or custom control can be

placed on a billboard.</xs:documentation></xs:annotation>

</xs:element></xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for the Billboard.</xs:documentation>

49

Page 50: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Feature" type="xs:string"><xs:annotation><xs:documentation>Feature whose state determines if the Billboard is shown.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

50

Page 51: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: BillboardAction

Description

Billboard action during which child Billboards are displayed

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Action name that determines whenthe Billboard should be shown.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Billboard anyType (restriction) 1..* Billboard to display during install of a Feature

Referenced By

● Element UI

Definition

<xs:element name="BillboardAction"><xs:annotation><xs:documentation>

Billboard action during which child Billboards are displayed</xs:documentation>

<xs:appinfo><xse:msiRef table="Billboard" href="http://msdn.microsoft.com/library/aa367823.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="BBControl" href="http://msdn.microsoft.com/library/aa367818.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Billboard" maxOccurs="unbounded"><xs:annotation><xs:documentation>Order of Billboard elements determines order of display</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Action name that determines when the Billboard should be

shown.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

51

Page 52: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:element>

52

Page 53: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Binary

Description

Binary data used for CustomAction elements and UI controls.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The Id cannot by longer than 55characters.

SourceFile string No Path to the binary file.

src string No

SuppressModularization

YesNoType No Use to suppress modularization ofthis Binary identifier in mergemodules.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Referenced By

● Element Control

● Element Fragment

● Element UI

Definition

<xs:element name="Binary"><xs:annotation><xs:documentation>

Binary data used for CustomAction elements and UI controls.</xs:documentation>

<xs:appinfo><xse:msiRef table="Binary" href="http://msdn.microsoft.com/library/aa367825.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additional

53

Page 54: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

elements at this point in the schema.</xs:documentation>

</xs:annotation></xs:any>

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The Id cannot by longer than 55 characters. In order to prevent errors in cases where

the Id is modularized, it should not be longer than 18 characters.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Path to the binary file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="SuppressModularization" type="YesNoType"><xs:annotation><xs:documentation>

Use to suppress modularization of this Binary identifier in merge modules.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

54

Page 55: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: BinaryRef

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the Binary elementto reference.

Content Model

Always empty.

Definition

<xs:element name="BinaryRef"><xs:annotation><xs:documentation>Used only for PatchFamilies to include only a binary table entry in a

patch.</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the Binary element to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

55

Page 56: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: BindImage

Description

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

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="BindImage" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef table="BindImage" href="http://msdn.microsoft.com/library/aa367828.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="BindImage" href="http://msdn.microsoft.com/library/aa367827.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Binds each executable or DLL that must be bound to the DLLs imported by it. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

56

Page 57: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Category

Description

Qualified published component for parent Component

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes A string GUID that represents thecategory of components beinggrouped together.

Qualifier string Yes A text string that qualifies the valuein the Id attribute.

AppData string No An optional localizable textdescribing the category.

Feature string No Feature that controls theadvertisement of the category.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

AppData string 1..1 Optional way for defining AppData, generallyused for complex CDATA.

Referenced By

● Element Component

Definition

<xs:element name="Category"><xs:annotation><xs:documentation>

Qualified published component for parent Component</xs:documentation>

<xs:appinfo><xse:msiRef table="PublishComponent" href="http://msdn.microsoft.com/library/aa370921.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence minOccurs="0" maxOccurs="unbounded"><xs:element ref="AppData" />

</xs:sequence><xs:attribute name="Id" use="required" type="Guid"><xs:annotation><xs:documentation>A string GUID that represents the category of components being grouped

57

Page 58: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

together.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Qualifier" use="required" type="xs:string"><xs:annotation><xs:documentation>A text string that qualifies the value in the Id attribute. A qualifier is used to distinguish

multiple forms of the same Component, such as a Component that is implemented in multiplelanguages.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="AppData" type="xs:string"><xs:annotation><xs:documentation>An optional localizable text describing the category. The string is commonly parsed

by the application and can be displayed to the user. It should describe the category.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Feature" type="xs:string"><xs:annotation><xs:documentation>Feature that controls the advertisement of the category. Defaults to the primary

Feature for the parent Component .</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

58

Page 59: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CCPSearch

Description

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

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

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 actionhas already run in InstallUISequence sequence. The CCPSearch action must come before the RMCCPSearchaction. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="CCPSearch" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="RMCCPSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="ComplianceCheck"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="CCPSearch" href="http://msdn.microsoft.com/library/aa367845.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Uses file signatures to validate that qualifying products are installed on a system before

an upgrade installation is performed. The CCPSearch action should be authored into the InstallUISequence

59

Page 60: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

table and InstallExecuteSequence table. The installer prevents the CCPSearch action from running in theInstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. TheCCPSearch action must come before the RMCCPSearch action. The condition for this action may be specifiedin the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

60

Page 61: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Class

Description

COM Class registration for parent Component.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes The Class identifier (CLSID) of aCOM server.

Context anySimpleType(list)

Yes The server context(s) for this server.

Description string No Localized description associated withthe Class ID and Program ID.

AppId Guid No This attribute is only allowed when aClass is advertised.

Icon string No The file providing the icon associatedwith this CLSID.

IconIndex integer No Icon index into the icon file.

Handler string No The default inproc handler.

Argument string No This column is optional only whenthe Context column is set to"LocalServer" or "LocalServer32"server context.

RelativePath YesNoType No When the value is "yes", the bare filename can be used for COM servers.

Advertise YesNoType No Set this value to "yes" in order tocreate a normal Class table row. Setthis value to "no" in order to generateRegistry rows that perform similarregistration (without the oftenproblematic Windows Installeradvertising behavior).

ThreadingModel NMTOKEN(restriction)

No Threading model for the CLSID.

Version string No Version for the CLSID.

Insertable YesNoType No Specifies the CLISD may beinsertable.

Programmable YesNoType No Specifies the CLSID may beprogrammable.

Server string No May only be specified if the value ofthe Advertise attribute is "no".

ShortPath YesNoType No Specifies whether or not to use theshort path for the COM server.

61

Page 62: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

SafeForScripting YesNoType No May only be specified if the value ofthe Advertise attribute is "no".

SafeForInitializing

YesNoType No May only be specified if the value ofthe Advertise attribute is "no".

Control YesNoType No Set this attribute's value to 'yes' toidentify an object as an ActiveXControl.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

FileTypeMask anyType (restriction) 1..1 FileType data for class Id registration.

Interface anyType (restriction) 1..1 COM Interface registration for parent Typelib.

ProgId anyType (restriction) 1..1 ProgId registration for parent Component.

Referenced By

● Element AppId

● Element Component

● Element File

● Element TypeLib

Definition

<xs:element name="Class"><xs:annotation><xs:documentation>COM Class registration for parent Component.</xs:documentation><xs:appinfo><xse:seeAlso ref="AppId" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Class" href="http://msdn.microsoft.com/library/aa367861.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ProgId" href="http://msdn.microsoft.com/library/aa370879.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="AppId" href="http://msdn.microsoft.com/library/aa367566.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">

When being used in unadvertised mode, the attributes in the Class element correspond to registrykeys

as follows (values that can be specified in authoring are in bold):<html:dl xmlns:html="http://www.w3.org/1999/xhtml"><html:dt>Id/Context/Server</html:dt><html:dd

><html:dl><html:dt>In General</html:dt><html:dd>[HKCR\CLSID\{<html:b>Id</html:b>}\<html:b>Context1</html:b>]<html:br />@="[!<html:b>Server</html:b>]"<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\<html:b>Context2</html:b>]<html:br />@="[!<html:b>Server</html:b>]"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

62

Page 63: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\<html:b>LocalServer</html:b>]<html:br />

@="[!<html:b>comserv.dll</html:b>]"<html:br />[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\<html:

b>LocalServer32</html:b>]<html:br />@="[!<html:b>comserv.dll</html:b>]"

</html:dd></html:dl></html:dd><html:dt>AppId</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\CLSID\{<html:b>Id</html:b>}]<html:br />AppId="{<html:b>AppId</html:b>}"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />AppId="{<html:b>00000000-89AB-0000-0123-000000000000</html:b>}"

</html:dd></html:dl></html:dd><html:dt>Argument</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\CLSID\{<html:b>Id</html:b>}\<html:b>Context</html:b>]<html:br />@="[!<html:b>Server</html:b>] <html:b>Argument</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\<html:

b>LocalServer32</html:b>]<html:br />@="[!<html:b>comserv.dll</html:b>] <html:b>/arg1 /arg2 /arg3</html:b>"<html:br

/></html:dd></html:dl></html:dd><html:dt>Control</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

Value "yes" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\Control]

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\Control]

</html:dd></html:dl></html:dd><html:dt>Description</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\CLSID\{<html:b>Id</html:b>}]<html:br />@="<html:b>Description</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br />@="<html:b>Description of Example COM Component</html:b>"

</html:dd></html:dl></html:dd><html:dt>Handler</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

Value "1" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\InprocHandler]<html:br />@="ole.dll"<html:br />Value "2" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\InprocHandler32]<html:br />@="ole32.dll"<html:br />Value "3" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\InprocHandler]<html:br />@="ole.dll"<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\InprocHandler32]<html:br />@="ole32.dll"<html:br />Other value specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\InprocHandler32]<html:br />@="<html:b>Handler</html:b>"

</html:dd><html:dt>Specific Example (for other value)</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\InprocHandler32]<html:br />@="<html:b>handler.dll</html:b>"

</html:dd></html:dl></html:dd><html:dt>Icon/IconIndex</html:dt><html:dd>This is notcurrently handled properly.</html:dd><html:dt>Insertable</html:dt><html:dd><html:dl><html:dt>In

63

Page 64: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

General</html:dt><html:dd>Value "no" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\NotInsertable]<html:br />Value "yes" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\Insertable]

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\Insertable]

</html:dd></html:dl></html:dd><html:dt>Programmable</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

Value "yes" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\Programmable]

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\Programmable]</html:dd></html:dl></html:dd><html:dt>RelativePath</html:dt><html:dd>Unsupported.

Please contribute this back to WiX if youknow.</html:dd><html:dt>SafeForInitializing</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

Value "yes" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\Implemented

Categories\{7DD95802-9882-11CF-9FA9-00AA006C42C4}]</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\ImplementedCategories\{7DD95802-9882-11CF-9FA9-00AA006C42C4}]

</html:dd></html:dl></html:dd><html:dt>SafeForScripting</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

Value "yes" specified:<html:br />[HKCR\CLSID\{<html:b>Id</html:b>}\Implemented

Categories\{7DD95801-9882-11CF-9FA9-00AA006C42C4}]</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\ImplementedCategories\{7DD95801-9882-11CF-9FA9-00AA006C42C4}]

</html:dd></html:dl></html:dd><html:dt>ThreadingModel</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\CLSID\{<html:b>Id</html:b>}\<html:b>Context</html:b>]<html:br />ThreadingModel="<html:b>ThreadingModel</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\<html:

b>LocalServer32</html:b>]<html:br />ThreadingModel="<html:b>Apartment</html:b>"

</html:dd></html:dl></html:dd><html:dt>TypeLibId (from parentTypeLib/@Id)</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd>

[HKCR\CLSID\{<html:b>Id</html:b>}\TypeLib]<html:br />@="{<html:b>TypeLibId</html:b>}"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\TypeLib]<html:br />@="{<html:b>11111111-89AB-1111-0123-111111111111</html:b>}"

</html:dd></html:dl></html:dd><html:dt>Version</html:dt><html:dd><html:dl><html:dt>InGeneral</html:dt><html:dd>

[HKCR\CLSID\{<html:b>Id</html:b>}\Version]<html:br />@="<html:b>Version</html:b>"

</html:dd><html:dt>Specific Example</html:dt><html:dd>

64

Page 65: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

[HKCR\CLSID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}\Version]<html:br />@="<html:b>1.0.0.0</html:b>"

</html:dd></html:dl></html:dd></html:dl></xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="ProgId"><xs:annotation><xs:documentation>A ProgId associated with Class must be a child element of the Class

element</xs:documentation></xs:annotation>

</xs:element><xs:element ref="FileTypeMask" /><xs:element ref="Interface"><xs:annotation><xs:documentation>These Interfaces will be registered with the parent Class and TypeLib (if

present).</xs:documentation></xs:annotation>

</xs:element></xs:choice><xs:attribute name="Id" type="Guid" use="required"><xs:annotation><xs:documentation>The Class identifier (CLSID) of a COM server.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Context" use="required"><xs:annotation><xs:documentation>The server context(s) for this server.</xs:documentation>

</xs:annotation><xs:simpleType><xs:list><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="LocalServer"><xs:annotation><xs:documentation>

A 16-bit local server application.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="LocalServer32"><xs:annotation><xs:documentation>

A 32-bit local server application.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="InprocServer"><xs:annotation><xs:documentation>

A 16-bit in-process server DLL.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="InprocServer32"><xs:annotation><xs:documentation>

A 32-bit in-process server DLL.</xs:documentation>

65

Page 66: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:list></xs:simpleType>

</xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>Localized description associated with the Class ID and Program

ID.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AppId" type="Guid"><xs:annotation><xs:documentation>

This attribute is only allowed when a Class is advertised. Using this attribute will reference anApplication ID

containing DCOM information for the associated application GUID. The value must correspond toan AppId/@Id of an

AppId element nested under a Fragment, Module, or Product element. To associate an AppId witha non-advertised

class, nest the class within a parent AppId element.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Icon" type="xs:string"><xs:annotation><xs:documentation>

The file providing the icon associated with this CLSID. Reference to an Icon element(should match the Id attribute of an Icon element). This is currently not supported if thevalue of the Advertise attribute is "no".

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IconIndex" type="xs:integer"><xs:annotation><xs:documentation>Icon index into the icon file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Handler" type="xs:string"><xs:annotation><xs:documentation>

The default inproc handler. May be optionally provided only for Context = LocalServer orLocalServer32. Value of "1" creates a 16-bit InprocHandler (appearing as the InprocHandlervalue). Value of "2" creates a 32-bit InprocHandler (appearing as the InprocHandler32 value).Value of "3" creates 16-bit as well as 32-bit InprocHandlers. A non-numeric value is treatedas a system file that serves as the 32-bit InprocHandler (appearing as the InprocHandler32 value).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Argument" type="xs:string"><xs:annotation><xs:documentation>

This column is optional only when the Context column is set to "LocalServer"or "LocalServer32" server context. The text is registered as the argument againstthe OLE server and is used by OLE for invoking the server. Note that the resolutionof properties in the Argument field is limited. A property formatted as [Property] inthis field can only be resolved if the property already has the intended value whenthe component owning the class is installed. For example, for the argument "[#MyDoc.doc]"

66

Page 67: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

to resolve to the correct value, the same process must be installing the file MyDoc.doc and thecomponent that owns the class.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RelativePath" type="YesNoType"><xs:annotation><xs:documentation>

When the value is "yes", the bare file name can be used for COM servers. The installerregisters the file name only instead of the complete path. This enables the server inthe current directory to take precedence and allows multiple copies of the same component.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Advertise" type="YesNoType"><xs:annotation><xs:documentation>

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 theoften problematic Windows Installer advertising behavior).

</xs:documentation></xs:annotation>

</xs:attribute><!-- Following attributes are not advertised, but add the appropriate rows to the Registry table --><xs:attribute name="ThreadingModel"><xs:annotation><xs:documentation>

Threading model for the CLSID.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="apartment" /><xs:enumeration value="free" /><xs:enumeration value="both" /><xs:enumeration value="neutral" /><xs:enumeration value="single" /><xs:enumeration value="rental" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Version" type="xs:string"><xs:annotation><xs:documentation>

Version for the CLSID.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Insertable" type="YesNoType"><xs:annotation><xs:documentation>

Specifies the CLISD may be insertable.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Programmable" type="YesNoType"><xs:annotation><xs:documentation>

Specifies the CLSID may be programmable.</xs:documentation>

67

Page 68: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Server" type="xs:string"><xs:annotation><xs:documentation>

May only be specified if the value of the Advertise attribute is "no". File Id of theCOM server file. If this element is nested under a File element, this value defaults tothe value of the parent File/@Id.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ShortPath" type="YesNoType"><xs:annotation><xs:documentation>

Specifies whether or not to use the short path for the COM server. This can only apply whenAdverstise is set to 'no'. The default is 'no' meaning that it will use the long file name for the COM server.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SafeForScripting" type="YesNoType"><xs:annotation><xs:documentation>

May only be specified if the value of the Advertise attribute is "no".</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SafeForInitializing" type="YesNoType"><xs:annotation><xs:documentation>

May only be specified if the value of the Advertise attribute is "no".</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Control" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute's value to 'yes' to identify an object as an ActiveX Control. The default value is'no'.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

68

Page 69: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Column

Description

Column definition for a Custom Table

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the column.

PrimaryKey YesNoType No Whether this column is a primarykey.

Type NMTOKEN(restriction)

Yes The type of this column.

Width integer No Width of this column.

Nullable YesNoType No Whether this column can be left null.

Localizable YesNoType No Whether this column can belocalized.

MinValue integer No Minimum value for a numeric value,date or version in this column.

MaxValue integer No Maximum value for a numeric value,date or version in this column.

KeyTable string No Table in which this column is anexternal key.

KeyColumn integer No Column in the table in KeyTableattribute.

Category NMTOKEN(restriction)

No Category of this column.

Set string No Semicolon delimited list ofpermissible values.

Description string No Description of this column.

Modularize NMTOKEN(restriction)

No How this column should bemodularized, if at all.

Content Model

Always empty.

Referenced By

● Element CustomTable

Definition

<xs:element name="Column"><xs:annotation><xs:documentation>Column definition for a Custom Table</xs:documentation>

69

Page 70: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the column.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="PrimaryKey" type="YesNoType"><xs:annotation><xs:documentation>Whether this column is a primary key.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Type" use="required"><xs:annotation><xs:documentation>The type of this column.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="binary"><xs:annotation><xs:documentation>

Column contains a path to a file that will be inserted into the column as a binary object.If this value is set, the Category attribute must also be set with a value of 'Binary' to pass

ICE validation.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="int"><xs:annotation><xs:documentation>

Column contains an integer or datetime value (the MinValue and MaxValue attributesshould also be set).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="string"><xs:annotation><xs:documentation>

Column contains a non-localizable string value.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Width" type="xs:integer"><xs:annotation><xs:documentation>Width of this column.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Nullable" type="YesNoType"><xs:annotation><xs:documentation>Whether this column can be left null.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Localizable" type="YesNoType"><xs:annotation><xs:documentation>Whether this column can be localized.</xs:documentation>

</xs:annotation></xs:attribute>

70

Page 71: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="MinValue" type="xs:integer"><xs:annotation><xs:documentation>Minimum value for a numeric value, date or version in this

column.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="MaxValue" type="xs:integer"><xs:annotation><xs:documentation>Maximum value for a numeric value, date or version in this

column.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="KeyTable" type="xs:string"><xs:annotation><xs:documentation>Table in which this column is an external key. Can be semicolon

delimited.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="KeyColumn" type="xs:integer"><xs:annotation><xs:documentation>Column in the table in KeyTable attribute.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Category"><xs:annotation><xs:documentation>

Category of this column.This attribute must be specified with a value of 'Binary' if the Type attribute's value is 'binary'.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="Text" /><xs:enumeration value="UpperCase" /><xs:enumeration value="LowerCase" /><xs:enumeration value="Integer" /><xs:enumeration value="DoubleInteger" /><xs:enumeration value="TimeDate" /><xs:enumeration value="Identifier" /><xs:enumeration value="Property" /><xs:enumeration value="Filename" /><xs:enumeration value="WildCardFilename" /><xs:enumeration value="Path" /><xs:enumeration value="Paths" /><xs:enumeration value="AnyPath" /><xs:enumeration value="DefaultDir" /><xs:enumeration value="RegPath" /><xs:enumeration value="Formatted" /><xs:enumeration value="Template" /><xs:enumeration value="Condition" /><xs:enumeration value="Guid" /><xs:enumeration value="Version" /><xs:enumeration value="Language" /><xs:enumeration value="Binary" /><xs:enumeration value="CustomSource" /><xs:enumeration value="Cabinet" /><xs:enumeration value="Shortcut" />

</xs:restriction></xs:simpleType>

</xs:attribute>

71

Page 72: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="Set" type="xs:string"><xs:annotation><xs:documentation>Semicolon delimited list of permissible values.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>Description of this column.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Modularize"><xs:annotation><xs:documentation>How this column should be modularized, if at all.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="None"><xs:annotation><xs:documentation>

Column should not be modularized. This is the default value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Column"><xs:annotation><xs:documentation>

Column should be modularized.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Condition"><xs:annotation><xs:documentation>

Column is a condition and should be modularized.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Icon"><xs:annotation><xs:documentation>

When the column is an primary or foreign key to the Icon table it should be modularizedspecial.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="Property"><xs:annotation><xs:documentation>

Any Properties in the column should be modularized.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="SemicolonDelimited"><xs:annotation><xs:documentation>

Semi-colon list of keys, all of which need to be modularized.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction>

72

Page 73: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:simpleType></xs:attribute>

</xs:complexType></xs:element>

73

Page 74: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComboBox

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Property string Yes Property tied to this group

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ListItem anyType (restriction) 0..* The value (and optional text) associated withan item in a ComboBox, ListBox, or ListView.

Referenced By

● Element Control

● Element UI

Definition

<xs:element name="ComboBox"><xs:annotation><xs:documentation>

Set of items for a particular ComboBox control tied to an install Property</xs:documentation>

<xs:appinfo><xse:msiRef table="ComboBox" href="http://msdn.microsoft.com/library/aa367872.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="ListItem" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>entry for ComboBox table</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Property" use="required" type="xs:string"><xs:annotation><xs:documentation>Property tied to this group</xs:documentation>

74

Page 75: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

75

Page 76: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComplianceCheck

Description

Adds a row to the CCPSearch table.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

1..1

ComplianceDrive anyType (restriction) 0..1 Sets the parent of a nested DirectorySearchelement to CCP_DRIVE.

ComponentSearch

anyType (restriction) 0..* Searches for file or directory and assigns tovalue of parent Property.

RegistrySearch anyType (restriction) 0..* Searches for file, directory or registry key andassigns to value of parent Property

IniFileSearch anyType (restriction) 0..* Searches for file, directory or registry key andassigns to value of parent Property

DirectorySearch anyType (restriction) 0..* Searches for directory and assigns to value ofparent Property.

Referenced By

● Element Fragment

Definition

<xs:element name="ComplianceCheck"><xs:annotation><xs:appinfo><xse:seeAlso ref="Property" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="CCPSearch" href="http://msdn.microsoft.com/library/aa367846.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Adds a row to the CCPSearch table.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:sequence><xs:element ref="ComplianceDrive" minOccurs="0"><xs:annotation><xs:documentation>Starts searches from the CCP_DRIVE.</xs:documentation>

</xs:annotation></xs:element>

76

Page 77: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="ComponentSearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="RegistrySearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="IniFileSearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="DirectorySearch" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

77

Page 78: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComplianceDrive

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 Occurs Description

1..1

DirectorySearch anyType (restriction) 1..1 Searches for directory and assigns to value ofparent Property.

DirectorySearchRef anyType (restriction) 1..1 References an existing DirectorySearchelement.

Definition

<xs:element name="ComplianceDrive"><xs:annotation><xs:documentation>Sets the parent of a nested DirectorySearch element to

CCP_DRIVE.</xs:documentation></xs:annotation><xs:complexType><xs:choice><xs:element ref="DirectorySearch" /><xs:element ref="DirectorySearchRef" />

</xs:choice></xs:complexType>

</xs:element>

78

Page 79: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Component

Description

Component for parent Directory

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Component identifier; this is theprimary key for identifyingcomponents.

ComPlusFlags integer No Set this attribute to create aComPlus entry.

DisableRegistryReflection

YesNoType No Set this attribute to 'yes' in order todisable registry reflection on allexisting and new registry keysaffected by this component.

Directory string No Sets the Directory of the Component.

DiskId integer No This attribute must be set either on aComponent element or all of itschildren File elements.

Feature string No Identifies a feature to which thiscomponent belongs, as a shorthandfor a child ComponentRef element ofthe Feature element.

Guid ComponentGuid Yes This value should be a guid thatuniquely identifies this component'scontents, language, platform, andversion.

KeyPath YesNoType No If this attribute's value is set to 'yes',then the Directory of this Componentis used as the KeyPath.

Location NMTOKEN(restriction)

No

NeverOverwrite YesNoType No If this attribute is set to 'yes', theinstaller does not install or reinstallthe component if a key path file or akey path registry entry for thecomponent already exists.

Permanent YesNoType No If this attribute is set to 'yes', theinstaller does not remove thecomponent during an uninstall.

Shared YesNoType No If this attribute's value is set to 'yes',enables advanced patchingsemantics for Components that areshared across multiple Products.

79

Page 80: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

SharedDllRefCount

YesNoType No If this attribute's value is set to 'yes',the installer increments the referencecount in the shared DLL registry ofthe component's key file.

Transitive YesNoType No If this attribute is set to 'yes', theinstaller reevaluates the value of thestatement in the Condition upon areinstall.

UninstallWhenSuperseded

YesNoType No If this attribute is set to 'yes', theinstaller will uninstall theComponent's files and registry keyswhen it is superseded by a patch.

Win64 YesNoType No Set this attribute to 'yes' to mark thisas a 64-bit component.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

AppId anyType (restriction) 1..1 Application ID containing DCOM information forthe associated application GUID.

Category anyType (restriction) 1..1 Qualified published component for parentComponent

Class anyType (restriction) 1..1 COM Class registration for parent Component.

Condition string (extension) 1..1 Conditions for components, controls, features,and products.

CopyFile anyType (restriction) 1..1 Copy or move an existing file on the targetmachine, or copy a file that is being installed, toanother destination.

CreateFolder anyType (restriction) 1..1 Create folder as part of parent Component.

Environment anyType (restriction) 1..1 Environment variables added or removed forthe parent component.

Extension anyType (restriction) 1..1 Extension for a Component

File anyType (restriction) 1..1 File specification for File table, must be childnode of Component.

IniFile anyType (restriction) 1..1 Adds or removes .ini file entries.

Interface anyType (restriction) 1..1 COM Interface registration for parent Typelib.

IsolateComponent anyType (restriction) 1..1 Shared Component to be privately replicated infolder of parent Component

ODBCDataSource anyType (restriction) 1..1 ODBCDataSource for a Component

ODBCDriver anyType (restriction) 1..1 ODBCDriver for a Component

80

Page 81: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

ODBCTranslator anyType (restriction) 1..1 ODBCTranslator for a Component

ProgId anyType (restriction) 1..1 ProgId registration for parent Component.

Registry anyType (restriction) 1..1

RegistryKey anyType (restriction) 1..1 Used for organization of child RegistryValueelements or to create a registry key (andoptionally remove it during uninstallation).

RegistryValue anyType (restriction) 1..1 Used to create a registry value. For multi-stringvalues, this can be used to prepend or appendvalues.

RemoveFile anyType (restriction) 1..1 Remove a file(s) if the parent component isselected for installation or removal.

RemoveFolder anyType (restriction) 1..1 Remove an empty folder if the parentcomponent is selected for installation orremoval.

RemoveRegistryKey anyType (restriction) 1..1 Used for removing registry keys and all childkeys either during install or uninstall.

RemoveRegistryValue

anyType (restriction) 1..1 Used to remove a registry value duringinstallation.

ReserveCost anyType (restriction) 1..1 Disk cost to reserve in a folder for runninglocally and/or from source.

ServiceControl anyType (restriction) 1..1 Starts, stops, and removes services for parentComponent.

ServiceInstall anyType (restriction) 1..1 Adds and removes services for parentComponent.

Shortcut anyType (restriction) 1..1 Shortcut, default target is parent File,CreateFolder, or Component's Directory

SymbolPath anyType (restriction) 1..1 A path to symbols.

TypeLib anyType (restriction) 1..1 Register a type library (TypeLib).

Referenced By

● Element ComponentGroup

● Element Directory

● Element DirectoryRef

● Element Feature

● Element FeatureGroup

● Element FeatureRef

● Element Fragment

Definition

<xs:element name="Component"><xs:annotation><xs:documentation>Component for parent Directory</xs:documentation><xs:appinfo><xse:seeAlso ref="ComponentRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

81

Page 82: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:seeAlso ref="Media" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Component" href="http://msdn.microsoft.com/library/aa368007.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Condition" href="http://msdn.microsoft.com/library/aa368014.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Directory" href="http://msdn.microsoft.com/library/aa368295.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="add_a_file.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to yourinstaller</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="AppId" /><xs:element ref="Category" /><xs:element ref="Class" /><xs:element ref="Condition" /><xs:element ref="CopyFile" /><xs:element ref="CreateFolder" /><xs:element ref="Environment" /><xs:element ref="Extension" /><xs:element ref="File" /><xs:element ref="IniFile" /><xs:element ref="Interface" /><xs:element ref="IsolateComponent" /><xs:element ref="ODBCDataSource" /><xs:element ref="ODBCDriver" /><xs:element ref="ODBCTranslator" /><xs:element ref="ProgId" /><xs:element ref="Registry" /><xs:element ref="RegistryKey" /><xs:element ref="RegistryValue" /><xs:element ref="RemoveFile" /><xs:element ref="RemoveFolder" /><xs:element ref="RemoveRegistryKey" /><xs:element ref="RemoveRegistryValue" /><xs:element ref="ReserveCost" /><xs:element ref="ServiceControl" /><xs:element ref="ServiceInstall" /><xs:element ref="Shortcut" /><xs:element ref="SymbolPath" /><xs:element ref="TypeLib" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Component identifier; this is the primary key for identifying

components.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ComPlusFlags" type="xs:integer"><xs:annotation>

82

Page 83: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Set this attribute to create a ComPlus entry. The value should be the export flags usedduring the generation of the .msi file. For more information see the COM+ documentationin the Platform SDK.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DisableRegistryReflection" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' in order to disable registry reflection on all existing andnew registry keys affected by this component.When set to 'yes', the Windows Installer calls the RegDisableReflectionKey on each keybeing accessed by the component.This bit is available with Windows Installer version 4.0 and is ignored on 32-bit systems.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>

Sets the Directory of the Component. If this element is nested under a Directory element,this value defaults to the value of the parent Directory/@Id.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DiskId" type="xs:integer"><xs:annotation><xs:documentation>

This attribute must be set either on a Component element or all of its children Fileelements. The value of this attribute should correspond to the Id attribute of aMedia element authored elsewhere. By creating this connection between a component (orparticular files), you set the packaging options to the values specified in the Mediaelement (values such as compression level, cab embedding, etc...).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Feature" type="xs:string"><xs:annotation><xs:documentation>

Identifies a feature to which this component belongs, as a shorthand for a childComponentRef element of the Feature element. The value of this attribute shouldcorrespond to the Id attribute of a Feature element authored elsewhere. Note thata single component can belong to multiple features but this attribute allows youto specify only a single feature.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Guid" type="ComponentGuid" use="required"><xs:annotation><xs:documentation>

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 repairedby Windows Installer (it is essentially an unpatchable, permanent component). Therefore, a guid

shouldalways be specified for any component which contains resources that may need to be patched in

the future.

83

Page 84: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="KeyPath" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute's value is set to 'yes', then the Directory of this Component is usedas the KeyPath. To set a Registry key or File as the KeyPath of a component, set theKeyPath attribute to 'yes' on one of those child elements.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Location"><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="local"><xs:annotation><xs:documentation>

Prevents the component from running from the source or the network (this is the defaultbehavior if this attribute is not set).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="source"><xs:annotation><xs:documentation>

Enforces that the component can only be run from the source (it cannot be run from theuser's computer).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="either"><xs:annotation><xs:documentation>

Allows the component to run from source or locally.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="NeverOverwrite" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute is set to 'yes', the installer does not install or reinstall thecomponent if a key path file or a key path registry entry for the component alreadyexists. The application does register itself as a client of the component. Use thisflag only for components that are being registered by the Registry table. Do not usethis flag for components registered by the AppId, Class, Extension, ProgId, MIME, andVerb tables.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Permanent" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute is set to 'yes', the installer does not remove the component duringan uninstall. The installer registers an extra system client for the component inthe Windows Installer registry settings (which basically just means that at least oneproduct is always referencing this component). Note that this option differs from the

84

Page 85: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

behavior of not setting a guid because although the component is permanent, it is stillpatchable (because Windows Installer still tracks it), it's just not uninstallable.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Shared" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute's value is set to 'yes', enables advanced patching semantics forComponents that are shared across multiple Products. Specifically, the Windows Installerwill cache the shared files to improve patch uninstall. This functionality is availablein Windows Installer 4.5 and later.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SharedDllRefCount" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute's value is set to 'yes', the installer increments the reference countin the shared DLL registry of the component's key file. If this bit is not set, theinstaller increments the reference count only if the reference count already exists.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Transitive" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute is set to 'yes', the installer reevaluates the value of the statementin the Condition upon a reinstall. If the value was previously False and has changed toTrue, the installer installs the component. If the value was previously True and haschanged to False, the installer removes the component even if the component has otherproducts as clients.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="UninstallWhenSuperseded" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute is set to 'yes', the installer will uninstall the Component's filesand registry keys when it is superseded by a patch. This functionality is available inWindows Installer 4.5 and later.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Win64" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' to mark this as a 64-bit component. This attribute facilitatesthe installation of packages that include both 32-bit and 64-bit components. If this bitis not set, the component is registered as a 32-bit component. If this is a 64-bitcomponent replacing a 32-bit component, set this bit and assign a new GUID in the Guid

attribute.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

85

Page 86: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

86

Page 87: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComponentGroup

Description

Groups together multiple components to be used in other locations.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the ComponentGroup.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroupRef

anyType (restriction) 1..1 Create a reference to a ComponentGroup inanother Fragment.

ComponentRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Referenced By

● Element Fragment

Definition

<xs:element name="ComponentGroup"><xs:annotation><xs:documentation>

Groups together multiple components to be used in other locations.</xs:documentation>

<xs:appinfo><xse:seeAlso ref="ComponentGroupRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Component" /><xs:element ref="ComponentGroupRef" /><xs:element ref="ComponentRef" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

87

Page 88: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the ComponentGroup.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

88

Page 89: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComponentGroupRef

Description

Create a reference to a ComponentGroup in another Fragment.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of theComponentGroup to reference.

Primary YesNoType No Set this attribute to 'yes' in order tomake the parent feature of thiscomponent the primary feature forthis component.

Content Model

Always empty.

Referenced By

● Element ComponentGroup

● Element Feature

● Element FeatureGroup

● Element FeatureRef

Definition

<xs:element name="ComponentGroupRef"><xs:annotation><xs:documentation>Create a reference to a ComponentGroup in another Fragment.</xs:documentation><xs:appinfo><xse:seeAlso ref="ComponentGroup"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the ComponentGroup to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Primary" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' in order to make the parent feature of this componentthe primary feature for this component. Components may belong to multiple features.By designating a feature as the primary feature of a component, you ensure thatwhenever a component is selected for install-on-demand (IOD), the primary featurewill be the one to install it. This attribute should only be set if a componentactually nests under multiple features. If a component nests under only one feature,

89

Page 90: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

that feature is the primary feature for the component. You cannot set more than onefeature as the primary feature of a given component.

</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

90

Page 91: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComponentRef

Description

Create a reference to a Feature element in another Fragment.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the Componentelement to reference.

Primary YesNoType No Set this attribute to 'yes' in order tomake the parent feature of thiscomponent the primary feature forthis component.

Content Model

Always empty.

Referenced By

● Element ComponentGroup

● Element Feature

● Element FeatureGroup

● Element FeatureRef

Definition

<xs:element name="ComponentRef"><xs:annotation><xs:documentation>Create a reference to a Feature element in another Fragment.</xs:documentation><xs:appinfo><xse:seeAlso ref="Component" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:howtoRef href="add_a_file.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to yourinstaller</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the Component element to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Primary" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' in order to make the parent feature of this componentthe primary feature for this component. Components may belong to multiple features.By designating a feature as the primary feature of a component, you ensure that

91

Page 92: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

whenever a component is selected for install-on-demand (IOD), the primary featurewill be the one to install it. This attribute should only be set if a componentactually nests under multiple features. If a component nests under only one feature,that feature is the primary feature for the component. You cannot set more than onefeature as the primary feature of a given component.

</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

92

Page 93: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ComponentSearch

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

Guid Guid No The component ID of the componentwhose key path is to be used for thesearch.

Type NMTOKEN(restriction)

No Must be file if last child is FileSearchelement and must be directory if lastchild is DirectorySearch element.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

DirectorySearch anyType (restriction) 1..1 Searches for directory and assigns to value ofparent Property.

DirectorySearchRef anyType (restriction) 1..1 References an existing DirectorySearchelement.

FileSearch anyType (restriction) 1..1 Searches for file and assigns to fullpath valueof parent Property

FileSearchRef anyType (restriction) 1..1 References an existing FileSearch element.

Definition

<xs:element name="ComponentSearch"><xs:annotation><xs:appinfo><xse:seeAlso ref="IniFileSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="RegistrySearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="CompLocator" href="http://msdn.microsoft.com/library/aa368001.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Searches for file or directory and assigns to value of parent

Property.</xs:documentation></xs:annotation><xs:complexType><xs:choice minOccurs="0">

93

Page 94: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="DirectorySearch" /><xs:element ref="DirectorySearchRef" /><xs:element ref="FileSearch" /><xs:element ref="FileSearchRef" />

</xs:choice><xs:attribute name="Id" use="required" type="xs:string" /><xs:attribute name="Guid" type="Guid"><xs:annotation><xs:documentation>The component ID of the component whose key path is to be used for the

search.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Type"><xs:annotation><xs:documentation>Must be file if last child is FileSearch element and must be directory if last child is

DirectorySearch element.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="directory"><xs:annotation><xs:documentation>

The key path of the component is a directory.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="file"><xs:annotation><xs:documentation>

The key path of the component is a file. This is the default value.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute></xs:complexType>

</xs:element>

94

Page 95: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Condition

Description

Conditions for components, controls, features, and products.

Derived By

Extending string

Attributes

Name Type Required? Default Description

Action NMTOKEN(restriction)

No Used only under Control elementsand is required. Allows specificactions to be applied to a controlbased on the result of this condition.

Level integer No Used only under Feature elementsand is required.

Message string No Used only under Fragment orProduct elements and is required.

Content Model

Contains text only.

Referenced By

● Element Component

● Element Feature

● Element Fragment

Remarks

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

Definition

<xs:element name="Condition"><xs:annotation><xs:documentation>

Conditions for components, controls, features, and products. The condition is specified in the innertext of the element.

</xs:documentation><xs:appinfo><xse:msiRef table="Component" href="http://msdn.microsoft.com/library/aa368007.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ControlCondition" href="http://msdn.microsoft.com/library/aa368035.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Condition" href="http://msdn.microsoft.com/library/aa368014.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="LaunchCondition" href="http://msdn.microsoft.com/library/aa369752.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="block_install_on_os.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Block installation basedon OS version</xse:howtoRef>

95

Page 96: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:howtoRef href="check_the_version_number.htm"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check the version numberof a file during installation</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>

Under a Component element, the condition becomes the condition of the component. Under aControl element,

the condition becomes a ControlCondition entry. Under a Feature element, the conditionbecomes a Condition

entry. Under a Fragment or Product element, the condition becomes a LaunchCondition entry.</xs:documentation>

</xs:annotation><xs:attribute name="Action"><xs:annotation><xs:documentation>

Used only under Control elements and is required. Allows specific actions to be applied to acontrol based

on the result of this condition.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="default"><xs:annotation><xs:documentation>

Set the Control as the default. Only used under Control elements.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="enable"><xs:annotation><xs:documentation>

Enable the Control. Only used under Control elements.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="disable"><xs:annotation><xs:documentation>

Disable the Control. Only used under Control elements.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="hide"><xs:annotation><xs:documentation>

Hide the Control. Only used under Control elements.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="show"><xs:annotation><xs:documentation>

Display the Control. Only used under Control elements.</xs:documentation>

96

Page 97: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Level" type="xs:integer"><xs:annotation><xs:documentation>

Used only under Feature elements and is required. Allows modifying the level of a Featurebased on the

result of this condition.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Message" type="xs:string"><xs:annotation><xs:documentation>

Used only under Fragment or Product elements and is required. Set the value to the text todisplay when the

condition fails and the installation must be terminated.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

97

Page 98: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Configuration

Description

Defines the configurable attributes of merge module.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Name string Yes Defines the name of the configurableitem.

Format string (restriction) Yes Specifies the format of the databeing changed.

Type string No Specifies the type of the data beingchanged.

ContextData string No Specifies a semantic context for therequested data.

DefaultValue string No Specifies a default value for the itemin this record if the merge tooldeclines to provide a value.

KeyNoOrphan YesNoType No Does not merge rule according torules in MSI SDK.

NonNullable YesNoType No If yes, null is not a valid entry.

DisplayName string No Display name for authoring.

Description string No Description for authoring.

HelpLocation string No Location of chm file for authoring.

HelpKeyword string No Keyword into chm file for authoring.

Content Model

Always empty.

Definition

<xs:element name="Configuration"><xs:annotation><xs:documentation>Defines the configurable attributes of merge module.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Defines the name of the configurable item.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Format" use="required"><xs:annotation><xs:documentation>Specifies the format of the data being changed.</xs:documentation>

</xs:annotation>

98

Page 99: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="Text" /><xs:enumeration value="Key" /><xs:enumeration value="Integer" /><xs:enumeration value="Bitfield" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Type" type="xs:string"><xs:annotation><xs:documentation>Specifies the type of the data being changed.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ContextData" type="xs:string"><xs:annotation><xs:documentation>Specifies a semantic context for the requested data.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DefaultValue" type="xs:string"><xs:annotation><xs:documentation>Specifies a default value for the item in this record if the merge tool declines to provide

a value.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="KeyNoOrphan" type="YesNoType"><xs:annotation><xs:documentation>Does not merge rule according to rules in MSI SDK.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="NonNullable" type="YesNoType"><xs:annotation><xs:documentation>If yes, null is not a valid entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DisplayName" type="xs:string"><xs:annotation><xs:documentation>Display name for authoring.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>Description for authoring.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="HelpLocation" type="xs:string"><xs:annotation><xs:documentation>Location of chm file for authoring.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="HelpKeyword" type="xs:string"><xs:annotation><xs:documentation>Keyword into chm file for authoring.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

99

Page 100: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ConfigurationData

Description

Data to use as input to a configurable merge module.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Name string Yes Key into the ModuleConfigurationtable.

Value string Yes Value to be passed to configurablemerge module.

Content Model

Always empty.

Referenced By

● Element Merge

Definition

<xs:element name="ConfigurationData"><xs:annotation><xs:documentation>Data to use as input to a configurable merge module.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Key into the ModuleConfiguration table.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>Value to be passed to configurable merge module.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

100

Page 101: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Control

Description

Contains the controls that appear on each dialog.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Combined with the Dialog Id to makeup the primary key of the Controltable.

Type string Yes The type of the control.

X LocalizableInteger

Yes Horizontal coordinate of theupper-left corner of the rectangularboundary of the control.

Y LocalizableInteger

Yes Vertical coordinate of the upper-leftcorner of the rectangular boundary ofthe control.

Width LocalizableInteger

Yes Width of the rectangular boundary ofthe control.

Height LocalizableInteger

Yes Height of the rectangular boundaryof the control.

Property string No The name of a defined property to belinked to this control.

Text string No A localizable string used to set theinitial text contained in a control.

Help string No This attribute is reserved for futureuse.

ToolTip string No The string used for the Tooltip.

CheckBoxValue string No This attribute is only valid forCheckBox Controls.

TabSkip YesNoType No Set this attribute to "yes" to causethis Control to be skipped in the tabsequence.

Default YesNoType No Set this attribute to "yes" to causethis Control to be invoked by thereturn key.

Cancel YesNoType No Set this attribute to "yes" to causethis Control to be invoked by theescape key.

Hidden YesNoType No Set this attribute to "yes" to causethe Control to be hidden.

Disabled YesNoType No Set this attribute to "yes" to causethe Control to be disabled.

101

Page 102: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

Sunken YesNoType No Set this attribute to "yes" to causethe Control to be sunken.

Indirect YesNoType No Specifies whether the valuedisplayed or changed by this controlis referenced indirectly.

Integer YesNoType No Set this attribute to "yes" to causethe linked Property value for theControl to be treated as an integer.Otherwise, the Property will betreated as a string.

RightToLeft YesNoType No Set this attribute to "yes" to causethe Control to display from right toleft.

RightAligned YesNoType No Set this attribute to "yes" to causethe Control to be right aligned.

LeftScroll YesNoType No Set this attribute to "yes" to causethe scroll bar to display on the leftside of the Control.

Transparent YesNoType No This attribute is only valid for TextControls.

NoPrefix YesNoType No This attribute is only valid for TextControls.

NoWrap YesNoType No This attribute is only valid for TextControls.

FormatSize YesNoType No This attribute is only valid for TextControls.

UserLanguage YesNoType No This attribute is only valid for TextControls.

Multiline YesNoType No This attribute is only valid for EditControls.

Password YesNoType No This attribute is only valid for EditControls.

ProgressBlocks YesNoType No This attribute is only valid forProgressBar Controls.

Removable YesNoType No This attribute is only valid for Volumeand Directory Controls.

Fixed YesNoType No This attribute is only valid for Volumeand Directory Controls.

Remote YesNoType No This attribute is only valid for Volumeand Directory Controls.

CDROM YesNoType No This attribute is only valid for Volumeand Directory Controls.

RAMDisk YesNoType No This attribute is only valid for Volumeand Directory Controls.

Floppy YesNoType No This attribute is only valid for Volumeand Directory Controls.

102

Page 103: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

ShowRollbackCost

YesNoType No This attribute is only valid forVolumeCostList Controls.

Sorted YesNoType No This attribute is only valid for Listbox,ListView, and ComboBox Controls.

ComboList YesNoType No This attribute is only valid forComboBox Controls.

Image YesNoType No This attribute is only valid forRadioButton, PushButton, and IconControls.

IconSize NMTOKEN(restriction)

No This attribute is only valid forRadioButton, PushButton, and IconControls.

FixedSize YesNoType No This attribute is only valid forRadioButton, PushButton, and IconControls.

Icon YesNoType No This attribute is only valid forRadioButton and PushButtonControls.

Bitmap YesNoType No This attribute is only valid forRadioButton and PushButtonControls.

PushLike YesNoType No This attribute is only valid forRadioButton and Checkbox Controls.

HasBorder YesNoType No This attribute is only valid forRadioButton Controls.

ElevationShield YesNoType No This attribute is only valid forPushButton controls.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Text string (extension) 0..1 An alternative to using the Text attribute whenthe value contains special XML characters like&lt;, &gt;, or &amp;.

ComboBox anyType (restriction) 0..1 Set of items for a particular ComboBox controltied to an install Property

ListBox anyType (restriction) 0..1 Set of items for a particular ListBox control tiedto an install Property

ListView anyType (restriction) 0..1 Set of items for a particular ListView controltied to an install Property

RadioButtonGroup anyType (restriction) 0..1 Set of radio buttons tied to the specifiedProperty

Property anyType (restriction) 0..1 Property value for a Product or Module.

103

Page 104: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

Binary anyType (restriction) 0..1 Binary data used for CustomAction elementsand UI controls.

0..*

Condition string (extension) 1..1 Conditions for components, controls, features,and products.

Publish string (extension) 1..1

Subscribe anyType (restriction) 1..1 Sets attributes for events in the EventMappingtable

Referenced By

● Element Billboard

● Element Dialog

Definition

<xs:element name="Control"><xs:annotation><xs:appinfo><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ComboBox" href="http://msdn.microsoft.com/library/aa367872.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListBox" href="http://msdn.microsoft.com/library/aa369762.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListView" href="http://msdn.microsoft.com/library/aa369764.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RadioButton" href="http://msdn.microsoft.com/library/aa370962.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Contains the controls that appear on each dialog.</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Text" minOccurs="0"><xs:annotation><xs:documentation>alternative to Text attribute when CDATA is needed to escape XML

delimiters</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ComboBox" minOccurs="0"><xs:annotation><xs:documentation>ComboBox table with ListItem children</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ListBox" minOccurs="0"><xs:annotation><xs:documentation>ListBox table with ListItem children</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ListView" minOccurs="0"><xs:annotation>

104

Page 105: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>ListView table with ListItem children</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RadioButtonGroup" minOccurs="0"><xs:annotation><xs:documentation>RadioButton table with RadioButton children</xs:documentation>

</xs:annotation></xs:element><xs:element ref="Property" minOccurs="0"><xs:annotation><xs:documentation>Property table entry for the Property table column associated with this

control</xs:documentation></xs:annotation>

</xs:element><xs:element ref="Binary" minOccurs="0"><xs:annotation><xs:documentation>Icon referenced in icon column of row</xs:documentation>

</xs:annotation></xs:element><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>child elements affecting operation of this control</xs:documentation>

</xs:annotation><xs:element ref="Condition"><xs:annotation><xs:documentation>Condition to specify actions for this control based on the outcome of the

condition.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="Publish" /><xs:element ref="Subscribe" />

</xs:choice></xs:sequence><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Combined with the Dialog Id to make up the primary key of the Control

table.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Type" use="required" type="xs:string"><xs:annotation><xs:documentation>The type of the control. Could be one of the following: Billboard, Bitmap, CheckBox,

ComboBox, DirectoryCombo, DirectoryList, Edit, GroupBox, Icon, Line, ListBox, ListView, MaskedEdit,PathEdit, ProgressBar, PushButton, RadioButtonGroup, ScrollableText, SelectionTree, Text, VolumeCostList,VolumeSelectCombo</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="X" use="required" type="LocalizableInteger"><xs:annotation><xs:documentation>Horizontal coordinate of the upper-left corner of the rectangular boundary of the

control. This must be a non-negative number.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Y" use="required" type="LocalizableInteger"><xs:annotation><xs:documentation>Vertical coordinate of the upper-left corner of the rectangular boundary of the control.

This must be a non-negative number.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Width" use="required" type="LocalizableInteger">

105

Page 106: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>Width of the rectangular boundary of the control. This must be a non-negative

number.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Height" use="required" type="LocalizableInteger"><xs:annotation><xs:documentation>Height of the rectangular boundary of the control. This must be a non-negative

number.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Property" type="xs:string"><xs:annotation><xs:documentation>The name of a defined property to be linked to this control. This column is required for

active controls.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Text" type="xs:string"><xs:annotation><xs:documentation>A localizable string used to set the initial text contained in a control. This attribute can

contain a formatted string that is processed at install time to insert the values of properties using[PropertyName] syntax. Also supported are environment variables, file installation paths, and componentinstallation directories; see <a href="http://msdn2.microsoft.com/library/aa368609.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">Formatted</a> for details.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Help" type="xs:string"><xs:annotation><xs:documentation>This attribute is reserved for future use. There is no need to use this until Windows

Installer uses it for something.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ToolTip" type="xs:string"><xs:annotation><xs:documentation>The string used for the Tooltip.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="CheckBoxValue" type="xs:string"><xs:annotation><xs:documentation>This attribute is only valid for CheckBox Controls. When set, the linked Property will

be set to this value when the check box is checked.</xs:documentation></xs:annotation>

</xs:attribute><!-- Control ordering - order of declaration in Dialog determines tab ordering --><xs:attribute name="TabSkip" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause this Control to be skipped in the tab

sequence.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Default" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause this Control to be invoked by the return

key.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Cancel" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause this Control to be invoked by the escape

key.</xs:documentation>

106

Page 107: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><!-- common Control attributes --><xs:attribute name="Hidden" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause the Control to be hidden.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Disabled" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause the Control to be disabled.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Sunken" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause the Control to be sunken.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Indirect" type="YesNoType"><xs:annotation><xs:documentation>Specifies whether the value displayed or changed by this control is referenced

indirectly. If this bit is set, the control displays or changes the value of the property that has the identifier listedin the Property column of the Control table.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Integer" type="YesNoType"><xs:annotation><xs:documentation>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.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RightToLeft" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause the Control to display from right to

left.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RightAligned" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause the Control to be right aligned.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LeftScroll" type="YesNoType"><xs:annotation><xs:documentation>Set this attribute to "yes" to cause the scroll bar to display on the left side of the

Control.</xs:documentation></xs:annotation>

</xs:attribute><!-- attributes applied to specific Controls --><xs:attribute name="Transparent" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Text Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="NoPrefix" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Text Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="NoWrap" type="YesNoType">

107

Page 108: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>This attribute is only valid for Text Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="FormatSize" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Text Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="UserLanguage" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Text Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Multiline" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Edit Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Password" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Edit Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ProgressBlocks" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for ProgressBar Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Removable" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Fixed" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Remote" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="CDROM" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="RAMDisk" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Floppy" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ShowRollbackCost" type="YesNoType">

108

Page 109: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>This attribute is only valid for VolumeCostList Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Sorted" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for Listbox, ListView, and ComboBox Controls. Set

the value of this attribute to "yes" to have entries appear in the order specified under the Control.If the attribute value is "no" or absent the entries in the control will appear in alphabetical order.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ComboList" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for ComboBox Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Image" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton, PushButton, and Icon

Controls.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IconSize"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton, PushButton, and Icon

Controls.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="16" /><xs:enumeration value="32" /><xs:enumeration value="48" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="FixedSize" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton, PushButton, and Icon

Controls.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Icon" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton and PushButton

Controls.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Bitmap" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton and PushButton

Controls.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="PushLike" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton and Checkbox

Controls.</xs:documentation></xs:annotation>

</xs:attribute>

109

Page 110: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="HasBorder" type="YesNoType"><xs:annotation><xs:documentation>This attribute is only valid for RadioButton Controls.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ElevationShield" type="YesNoType"><xs:annotation><xs:documentation>

This attribute is only valid for PushButton controls.Set this attribute to "yes" to add the User Account Control (UAC) elevation icon (shield icon) to

the PushButton control.If this attribute's value is "yes" and the installation is not yet running with elevated privileges,the pushbutton control is created using the User Account Control (UAC) elevation icon (shield

icon).If this attribute's value is "yes" and the installation is already running with elevated privileges,the pushbutton control is created using the other icon attributes.Otherwise, the pushbutton control is created using the other icon attributes.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

110

Page 111: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CopyFile

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 Required? Default Description

Id string Yes Primary key used to identify thisparticular entry.

FileId string No This attribute cannot be specified ifthe element is nested under a Fileelement.

SourceDirectory string No This attribute cannot be specified ifthe element is nested under a Fileelement or the FileId attribute isspecified.

SourceProperty string No This attribute cannot be specified ifthe element is nested under a Fileelement or the FileId attribute isspecified.

SourceName WildCardLongFileNameType

No This attribute cannot be specified ifthe element is nested under a Fileelement or the FileId attribute isspecified.

DestinationDirectory

string No Set this value to the destinationdirectory where an existing file onthe target machine should be movedor copied to.

DestinationProperty

string No Set this value to a property that willhave a value that resolves to the fullpath of the destination directory.

DestinationName LongFileNameType

No In prior versions of the WiX toolset,this attribute specified the short filename.

DestinationLongName

LongFileNameType

No

DestinationShortName

ShortFileNameType

No The short file name of the file in 8.3format.

Delete YesNoType No This attribute cannot be specified ifthe element is nested under a Fileelement or the FileId attribute isspecified.

Content Model

Always empty.

111

Page 112: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Element Component

● Element File

Remarks

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

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

Definition

<xs:element name="CopyFile"><xs:annotation><xs:appinfo><xse:seeAlso ref="RemoveFile" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:msiRef table="DuplicateFile" href="http://msdn.microsoft.com/library/aa368335.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="MoveFile" href="http://msdn.microsoft.com/library/aa370055.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

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

this element is nested under a File element, the parent file will be installed, then copied to thespecified destination

if the parent component of the file is selected for installation or removal. When this element is nestedunder

a Component element and no FileId attribute is specified, the file to copy or move must already be onthe target machine.

When this element is nested under a Component element and the FileId attribute is specified, thespecified 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 installationstate). If the

specified destination directory is the same as the directory containing the original file and the namefor the proposed source

file is the same as the original, then no action takes place.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Primary key used to identify this particular entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="FileId" type="xs:string"><xs:annotation><xs:documentation>

This attribute cannot be specified if the element is nested under a File element. Set this attribute'svalue to the identifier

112

Page 113: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

of a file from a different component to copy it based on the install state of the parent component.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SourceDirectory" type="xs:string"><xs:annotation><xs:documentation>

This attribute cannot be specified if the element is nested under a File element or the FileIdattribute is specified. Set

this value to the source directory from which to copy or move an existing file on the target machine.This Directory must

exist in the installer database at creation time. This attribute cannot be specified in conjunctionwith SourceProperty.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceProperty" type="xs:string"><xs:annotation><xs:documentation>

This attribute cannot be specified if the element is nested under a File element or the FileIdattribute is specified. Set

this value to a property that will have a value that resolves to the full path of the source directory (orfull path

including file name if SourceName is not specified). The property does not have to exist in theinstaller database at

creation time; it could be created at installation time by a custom action, on the command line, etc.This attribute

cannot be specified in conjunction with SourceDirectory.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SourceName" type="WildCardLongFileNameType"><xs:annotation><xs:documentation>

This attribute cannot be specified if the element is nested under a File element or the FileIdattribute is specified. Set

this value to the localizable name of the file(s) to be copied or moved. All of the files thatmatch the wild card will be removed from the specified directory. The value is a filename that may

alsocontain the wild card characters "?" for any single character or "*" for zero or more occurrences of

any character. If thisattribute is not specified (and this element is not nested under a File element or specify a FileId

attribute) then theSourceProperty attribute should be set to the name of a property that will resolve to the full path of

the source filename.If the value of this attribute contains a "*" wildcard and the DestinationName attribute is specified,

all moved or copiedfiles retain the file names from their sources.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DestinationDirectory" type="xs:string"><xs:annotation><xs:documentation>

Set this value to the destination directory where an existing file on the target machine should bemoved or copied to. This

Directory must exist in the installer database at creation time. This attribute cannot be specified inconjunction with

DestinationProperty.</xs:documentation>

113

Page 114: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="DestinationProperty" type="xs:string"><xs:annotation><xs:documentation>

Set this value to a property that will have a value that resolves to the full path of the destinationdirectory. The property

does not have to exist in the installer database at creation time; it could be created at installationtime by a custom

action, on the command line, etc. This attribute cannot be specified in conjunction withDestinationDirectory.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DestinationName" type="LongFileNameType"><xs:annotation><xs:documentation>

In prior versions of the WiX toolset, this attribute specified the short file name.Now set this value to the localizable name to be given to the original file after it is moved or copied.If this attribute is not specified, then the destination file is given the same name as the source file.If a short file name is specified, the DestinationShortName attribute may not be specified.If a long file name is specified, the DestinationLongName attribute may not be specified.Also, if this value is a long file name, the DestinationShortName attribute may be omitted toallow WiX to attempt to generate a unique short file name.However, if this name collides with another file or you wish to manually specifythe short file name, then the DestinationShortName attribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DestinationLongName" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="DestinationName"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="DestinationShortName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short file name of the file in 8.3 format.This attribute should only be set if there is a conflict between generated short file namesor you wish to manually specify the short file name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Delete" type="YesNoType"><xs:annotation><xs:documentation>

This attribute cannot be specified if the element is nested under a File element or the FileIdattribute is specified. In other

cases, if the attribute is not specified, the default value is "no" and the file is copied, not moved.Set the value to "yes"

in order to move the file (thus deleting the source file) instead of copying it.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

114

Page 115: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CostFinalize

Description

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

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

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

Definition

<xs:element name="CostFinalize" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="CostInitialize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:seeAlso ref="FileCost" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="CostFinalize" href="http://msdn.microsoft.com/library/aa368048.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Ends the internal installation costing process begun by the CostInitialize action. Any

standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call theFileCost action immediately following the CostInitialize action and then call the CostFinalize action to make allfinal cost calculations available to the installer through the Component table. The CostFinalize action must be

115

Page 116: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

executed before starting any user interface sequence which allows the user to view or modify Feature tableselections or directories. The CostFinalize action queries the Condition table to determine which features arescheduled to be installed. Costing is done for each component in the Component table. The CostFinalizeaction also verifies that all the target directories are writable before allowing the installation to continue. Thecondition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

116

Page 117: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CostInitialize

Description

Initiates the internal installation costing process.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Callthe FileCost action immediately following the CostInitialize action. Then call the CostFinalize action followingthe 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.

Definition

<xs:element name="CostInitialize" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="FileCost" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="CostFinalize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:msiRef action="CostInitialize" href="http://msdn.microsoft.com/library/aa368048.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Initiates the internal installation costing process. Any standard or custom actions that

affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediatelyfollowing the CostInitialize action. Then call the CostFinalize action following the CostInitialize action to makeall final cost calculations available to the installer through the Component table. The condition for this actionmay be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

117

Page 118: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CreateFolder

Description

Create folder as part of parent Component.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Directory string No Identifier of Directory to create.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Permission anyType (restriction) 0..* Sets ACLs on File, Registry, or CreateFolder.

Shortcut anyType (restriction) 0..* Shortcut, default target is parent File,CreateFolder, or Component's Directory

Referenced By

● Element Component

Definition

<xs:element name="CreateFolder"><xs:annotation><xs:appinfo><xse:seeAlso ref="RemoveFolder"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="CreateFolder" href="http://msdn.microsoft.com/library/aa368053.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Create folder as part of parent Component.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Shortcut" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Non-advertised shortcut to this folder, Shortcut Target is preset to the

folder</xs:documentation></xs:annotation>

</xs:element><xs:element ref="Permission" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>ACL permission</xs:documentation>

</xs:annotation></xs:element>

118

Page 119: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>Identifier of Directory to create. Defaults to Directory of parent

Component.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

119

Page 120: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CreateFolders

Description

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

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="CreateFolders" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="CreateFolders" href="http://msdn.microsoft.com/library/aa368052.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Creates empty folders for components that are set to be installed. The condition for this

action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

120

Page 121: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CreateShortcuts

Description

Manages the creation of shortcuts.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="CreateShortcuts" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="CreateShortcuts" href="http://msdn.microsoft.com/library/aa368054.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the creation of shortcuts. The condition for this action may be specified in the

element's inner text.</xs:documentation></xs:annotation>

</xs:element>

121

Page 122: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Custom

Description

Use to sequence a custom action.

Derived By

Extending string

Attributes

Name Type Required? Default Description

Action string Yes The action to which the Customelement applies.

OnExit NMTOKEN(restriction)

No Mutually exclusive with Before, After,and Sequence attributes

Before string No The name of the standard or customaction before which this actionshould be performed. Mutuallyexclusive with OnExit, After, andSequence attributes

After string No The name of the standard or customaction after which this action shouldbe performed.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No The sequence number for thisaction.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

● Element InstallUISequence

Definition

<xs:element name="Custom"><xs:annotation><xs:appinfo><xse:seeAlso ref="CustomAction"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Use to sequence a custom action.</xs:documentation>

</xs:annotation><xs:complexType>

122

Page 123: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>Text node specifies the condition of the action.</xs:documentation>

</xs:annotation><xs:attribute name="Action" type="xs:string" use="required"><xs:annotation><xs:documentation>The action to which the Custom element applies.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="OnExit"><xs:annotation><xs:documentation>Mutually exclusive with Before, After, and Sequence attributes</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="success" /><xs:enumeration value="cancel" /><xs:enumeration value="error" /><xs:enumeration value="suspend" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Before" type="xs:string"><xs:annotation><xs:documentation>The name of the standard or custom action before which this action should be

performed. Mutually exclusive with OnExit, After, and Sequence attributes</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="After" type="xs:string"><xs:annotation><xs:documentation>The name of the standard or custom action after which this action should be

performed. Mutually exclusive with Before, OnExit, and Sequence attributes</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Overridable" type="YesNoType"><xs:annotation><xs:documentation>

If "yes", the sequencing of this action may be overridden by sequencing elsewhere.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Sequence" type="xs:integer"><xs:annotation><xs:documentation>The sequence number for this action. Mutually exclusive with Before, After, and

OnExit attributes</xs:documentation></xs:annotation>

</xs:attribute></xs:extension>

</xs:simpleContent></xs:complexType>

</xs:element>

123

Page 124: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CustomAction

Description

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

Derived By

Extending string

Attributes

Name Type Required? Default Description

Id string No The identifier of the custom action.

BinaryKey string No This attribute is a reference to aBinary element with matching Idattribute.

FileKey string No This attribute specifies a reference toa File element with matching Idattribute that will execute the customaction code in the file after the file isinstalled.

Property string No This attribute specifies a reference toa Property element with matching Idattribute that specifies the Propertyto be used or updated on executionof this custom action.

Directory string No This attribute specifies a reference toa Directory element with matching Idattribute containing a directory path.

DllEntry string No This attribute specifies the name of afunction in a custom action toexecute.

ExeCommand string No This attribute specifies the commandline parameters to supply to anexternally run executable.

JScriptCall string No This attribute specifies the name ofthe JScript function to execute in ascript.

VBScriptCall string No This attribute specifies the name ofthe VBScript Subroutine to executein a script.

Script NMTOKEN(restriction)

No Creates a type 37 or 38 customaction.

SuppressModularization

YesNoType No Use to suppress modularization ofthis custom action name in mergemodules.

Value string No This attribute specifies a string valueto use in the custom action.

124

Page 125: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

Error string No This attribute specifies an index inthe MSI Error table to use as an errormessage for a type 19 custom actionthat displays the error message andaborts a product's installation.

Return NMTOKEN(restriction)

No Set this attribute to set the returnbehavior of the custom action.

Execute NMTOKEN(restriction)

No This attribute indicates thescheduling of the custom action.

Impersonate YesNoType No This attribute specifies whether theWindows Installer, which executesas LocalSystem, should impersonatethe user context of the installing userwhen executing this custom action.

PatchUninstall YesNoType No This attribute specifies that theWindows Installer, execute thecustom action only when a patch isbeing uninstalled.

Win64 YesNoType No Specifies that a script custom actiontargets a 64-bit platform.

TerminalServerAware

YesNoType No This attribute specifies controlswhether the custom action willimpersonate the installing userduring per-machine installs onTerminal Server machines.

HideTarget YesNoType No Ensures the installer does not log theCustomActionData for the deferredcustom action.

Content Model

Contains text only.

Referenced By

● Element Fragment

Remarks

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

Definition

<xs:element name="CustomAction"><xs:annotation><xs:appinfo><xse:seeAlso ref="Custom" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="CustomActionRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="CustomAction" href="http://msdn.microsoft.com/library/aa368062.aspx"

125

Page 126: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

Specifies a custom action to be added to the MSI CustomAction table. Various combinations of theattributes for this element

correspond to different custom action types. For more information about custom actions see the<html:a href="http://msdn.microsoft.com/library/aa372048.aspx" target="_blank"

xmlns:html="http://www.w3.org/1999/xhtml">Custom Action Types</html:a> topic on MSDN.

</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>

The text node is only valid if the Script attribute is specified. In that case, the text node containsthe script to embed.

</xs:documentation></xs:annotation><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

The identifier of the custom action.</xs:documentation>

</xs:annotation></xs:attribute><!-- CustomAction Source specification, sets source Attribute bits --><xs:attribute name="BinaryKey" type="xs:string"><xs:annotation><xs:documentation>

This attribute is a reference to a Binary element with matching Id attribute. That binarystream contains

the custom action for use during install. The custom action will not be installed into a targetdirectory. This attribute is

typically used with the DllEntry attribute to specify the custom action DLL to use for a type 1custom action, with the ExeCommand

attribute to specify a type 17 custom action that runs an embedded executable, or with theVBScriptCall or JScriptCall attributes

to specify a type 5 or 6 custom action.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="FileKey" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a reference to a File element with matching Id attribute thatwill execute the custom action code in the file after the file is installed. Thisattribute is typically used with the ExeCommand attribute to specify a type 18 custom actionthat runs an installed executable, with the DllEntry attribute to specify an installed customaction DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCallattributes to specify a type 21 or 22 custom action.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Property" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a reference to a Property element with matching Id attribute thatspecifies the Property

126

Page 127: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

to be used or updated on execution of this custom action. This attribute istypically used with the Value attribute to create a type 51 custom action that parsesthe text in Value and places it into the specified Property. This attribute is also used withthe ExeCommand attribute to create a type 50 custom action that uses the value of thegiven property to specify the path to the executable. Type 51 custom actions are often

useful topass values to a deferred custom action.See <html:a href="http://msdn.microsoft.com/library/aa370543.aspx" target="_blank"

xmlns:html="http://www.w3.org/1999/xhtml">http://msdn.microsoft.com/library/aa370543.aspx</html:a>for more information.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a reference to a Directory element with matching Id attributecontaining a directory path.

This attribute is typically used with the ExeCommand attribute to specify the sourceexecutable for a type 34

custom action, or with the Value attribute to specify a formatted string to place in thespecified Directory

table entry in a type 35 custom action.</xs:documentation>

</xs:annotation></xs:attribute><!-- CustomAction Target specification, sets target Attribute bits --><xs:attribute name="DllEntry" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies the name of a function in a custom action to execute.This attribute is used with the BinaryKey attribute to create a type 1 customaction, or with the FileKey attribute to create a type 17 custom action.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ExeCommand" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies the command line parameters to supply to an externallyrun executable. This attribute is typically used with the BinaryKey attribute for a type 2

custom action,the FileKey attribute for a type 18 custom action, the Property attribute for a type 50 custom

action,or the Directory attribute for a type 34 custom action that specify the executable to run.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="JScriptCall" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies the name of the JScript function to execute in a script. The script mustbe

provided in a Binary element identified by the BinaryKey attribute described above. In otherwords, this

attribute must be specified in conjunction with the BinaryKey attribute.</xs:documentation>

</xs:annotation></xs:attribute>

127

Page 128: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="VBScriptCall" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies the name of the VBScript Subroutine to execute in a script. The scriptmust be

provided in a Binary element identified by the BinaryKey attribute described above. In otherwords, this

attribute must be specified in conjunction with the BinaryKey attribute.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Script"><xs:annotation><xs:documentation>

Creates a type 37 or 38 custom action. The text of the element should contain the script to beembedded in the package.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="jscript" /><xs:enumeration value="vbscript" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="SuppressModularization" type="YesNoType"><xs:annotation><xs:documentation>

Use to suppress modularization of this custom action name in merge modules.This should only be necessary for table-driven custom actions because thetable name which they interact with cannot be modularized, so there can onlybe one instance of the table.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a string value to use in the custom action. This attributemust be used with the Property attribute to set the property as part of atype 51 custom action or with the Directory attribute to set a directory path in thattable in a type 35 custom action. The value can be a literal value or derived from aProperty element using the <html:a href="http://msdn.microsoft.com/library/aa368609.aspx"

target="_blank" xmlns:html="http://www.w3.org/1999/xhtml">Formatted</html:a>syntax.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Error" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies an index in the MSI Error table to use as an error message for atype 19 custom action that displays the error message and aborts a product's installation.

</xs:documentation></xs:annotation>

</xs:attribute><!-- Other CustomAction type attributes --><xs:attribute name="Return"><xs:annotation><xs:documentation>

128

Page 129: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

Set this attribute to set the return behavior of the custom action.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="asyncNoWait"><xs:annotation><xs:documentation>

Indicates that the custom action will run asyncronously and execution may continueafter the installer terminates.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="asyncWait"><xs:annotation><xs:documentation>

Indicates that the custom action will run asynchronously but the installer will wait forthe return code at sequence end.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="check"><xs:annotation><xs:documentation>

Indicates that the custom action will run synchronously and the return code will bechecked for success. This is the default.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="ignore"><xs:annotation><xs:documentation>

Indicates that the custom action will run synchronously and the return code will notbe checked.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Execute"><xs:annotation><xs:documentation>

This attribute indicates the scheduling of the custom action.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="commit"><xs:annotation><xs:documentation>

Indicates that the custom action will run after successful completion of theinstallation script (at the end of the installation).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="deferred"><xs:annotation><xs:documentation>

Indicates that the custom action runs in-script (possibly with elevated privileges).

129

Page 130: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="firstSequence"><xs:annotation><xs:documentation>

Indicates that the custom action will only run in the first sequence that runs it.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="immediate"><xs:annotation><xs:documentation>

Indicates that the custom action will run during normal processing time with userprivileges. This is the default.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="oncePerProcess"><xs:annotation><xs:documentation>

Indicates that the custom action will only run in the first sequence that runs it in thesame process.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="rollback"><xs:annotation><xs:documentation>

Indicates that a custom action will run in the rollback sequence when a failureoccurs during installation, usually to undo changes made by a deferred custom

action.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="secondSequence"><xs:annotation><xs:documentation>

Indicates that a custom action should be run a second time if it was previously runin an earlier sequence.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Impersonate" type="YesNoType"><xs:annotation><xs:documentation>

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.Typically the value should be 'yes', except when the custom action needs elevated

privilegesto apply changes to the machine.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="PatchUninstall" type="YesNoType"><xs:annotation>

130

Page 131: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>This attribute specifies that the Windows Installer, execute the custom action only whena patch is being uninstalled. These custom actions should also be conditioned using theMSIPATCHREMOVE property to ensure proper down level (less than Windows Installer

4.5)behavior.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Win64" type="YesNoType"><xs:annotation><xs:documentation>

Specifies that a script custom action targets a 64-bit platform. Valid only when used withthe Script, VBScriptCall, and JScriptCall attributes.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TerminalServerAware" type="YesNoType"><xs:annotation><xs:documentation>

This attribute specifies controls whether the custom action will impersonate theinstalling user during per-machine installs on Terminal Server machines.Deferred execution custom actions that do not specify this attribute, or explicitly set it 'no',will run with no user impersonation on Terminal Server machines duringper-machine installations. This attribute is only applicable when installing on theWindows Server 2003 family.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="HideTarget" type="YesNoType"><xs:annotation><xs:documentation>Ensures the installer does not log the CustomActionData for the deferred custom

action.</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:extension>

</xs:simpleContent></xs:complexType>

</xs:element>

131

Page 132: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CustomActionRef

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the CustomAction toreference.

Content Model

Always empty.

Referenced By

● Element Fragment

Definition

<xs:element name="CustomActionRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="CustomAction"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

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

</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the CustomAction to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

132

Page 133: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CustomProperty

Description

A custom property for the PatchMetadata table.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Company string Yes The name of the company.

Property string Yes The name of the metadata property.

Value string Yes Value of the metadata property.

Content Model

Always empty.

Definition

<xs:element name="CustomProperty"><xs:annotation><xs:documentation>A custom property for the PatchMetadata table.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Company" type="xs:string" use="required"><xs:annotation><xs:documentation>The name of the company.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Property" type="xs:string" use="required"><xs:annotation><xs:documentation>The name of the metadata property.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>Value of the metadata property.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

133

Page 134: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: CustomTable

Description

Defines a custom table for use from a custom action.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the custom table.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Column anyType (restriction) 0..* Column definition for a Custom Table

Row anyType (restriction) 0..* Row data for a Custom Table

Referenced By

● Element Fragment

Definition

<xs:element name="CustomTable"><xs:annotation><xs:documentation>Defines a custom table for use from a custom action.</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Column" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Column definition for the custom table.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="Row" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Row definition for the custom table.</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the custom table.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

134

Page 135: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Data

Description

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

Derived By

Extending string

Attributes

Name Type Required? Default Description

Column string Yes Specifies in which column to insertthis data.

Content Model

Contains text only.

Referenced By

● Element Row

Definition

<xs:element name="Data"><xs:annotation><xs:documentation>Used for a Custom Table. Specifies the data for the parent Row and specified

Column.</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>A data value</xs:documentation>

</xs:annotation><xs:attribute name="Column" use="required" type="xs:string"><xs:annotation><xs:documentation>Specifies in which column to insert this data.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

135

Page 136: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DeleteServices

Description

Stops a service and removes its registration from the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="DeleteServices" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="DeleteServices" href="http://msdn.microsoft.com/library/aa368270.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Stops a service and removes its registration from the system. The condition for this

action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

136

Page 137: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Dependency

Description

Declares a dependency on another merge module.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

RequiredId string Yes Identifier of the merge modulerequired by the merge module.

RequiredLanguage

integer Yes Numeric language ID of the mergemodule in RequiredID.

RequiredVersion string No Version of the merge module inRequiredID.

Content Model

Always empty.

Definition

<xs:element name="Dependency"><xs:annotation><xs:documentation>Declares a dependency on another merge module.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="RequiredId" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier of the merge module required by the merge module.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="RequiredLanguage" type="xs:integer" use="required"><xs:annotation><xs:documentation>Numeric language ID of the merge module in RequiredID.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="RequiredVersion" type="xs:string"><xs:annotation><xs:documentation>Version of the merge module in RequiredID.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

137

Page 138: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Dialog

Description

Defines a dialog box in the Dialog Table.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for the dialog.

X integer No Horizontal placement of the dialogbox as a percentage of screen width.

Y integer No Vertical placement of the dialog boxas a percentage of screen height.

Width integer Yes The width of the dialog box in dialogunits.

Height integer Yes The height of the dialog box in dialogunits.

Title string No The title of the dialog box.

Hidden YesNoType No Used to hide the dialog.

Modeless YesNoType No Used to set the dialog as modeless.

NoMinimize YesNoType No Used to specify if the dialog can beminimized.

SystemModal YesNoType No Used to set the dialog as systemmodal.

KeepModeless YesNoType No Keep modeless dialogs alive whenthis dialog is created throughDoAction.

TrackDiskSpace YesNoType No Have the dialog periodically call theinstaller to check if available diskspace has changed.

CustomPalette YesNoType No Used to specify if pictures in thedialog box are rendered with acustom palette.

RightToLeft YesNoType No Used to specify if the text in thedialog should be displayed in right toleft reading order.

RightAligned YesNoType No Align text on the right.

LeftScroll YesNoType No Used to align the scroll bar on theleft.

ErrorDialog YesNoType No Specifies this dialog as an errordialog.

Content Model

Contains elements as defined in the following table.

138

Page 139: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

1..1

Control anyType (restriction) 0..* Contains the controls that appear on eachdialog.

Referenced By

● Element UI

Definition

<xs:element name="Dialog"><xs:annotation><xs:appinfo><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ComboBox" href="http://msdn.microsoft.com/library/aa367872.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListBox" href="http://msdn.microsoft.com/library/aa369762.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListView" href="http://msdn.microsoft.com/library/aa369764.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RadioButton" href="http://msdn.microsoft.com/library/aa370962.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

Defines a dialog box in the Dialog Table.</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Control" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Control elements belonging to this dialog.</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for the dialog.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="X" type="xs:integer"><xs:annotation><xs:documentation>Horizontal placement of the dialog box as a percentage of screen width. The default

value is 50.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Y" type="xs:integer"><xs:annotation><xs:documentation>Vertical placement of the dialog box as a percentage of screen height. The default

value is 50.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Width" use="required" type="xs:integer"><xs:annotation>

139

Page 140: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>The width of the dialog box in dialog units.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Height" use="required" type="xs:integer"><xs:annotation><xs:documentation>The height of the dialog box in dialog units.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Title" type="xs:string"><xs:annotation><xs:documentation>The title of the dialog box.</xs:documentation>

</xs:annotation></xs:attribute><!-- 'Attributes' column integer value generated from XML attributes below --><xs:attribute name="Hidden" type="YesNoType"><xs:annotation><xs:documentation>Used to hide the dialog.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Modeless" type="YesNoType"><xs:annotation><xs:documentation>Used to set the dialog as modeless.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="NoMinimize" type="YesNoType"><xs:annotation><xs:documentation>Used to specify if the dialog can be minimized.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SystemModal" type="YesNoType"><xs:annotation><xs:documentation>Used to set the dialog as system modal.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="KeepModeless" type="YesNoType"><xs:annotation><xs:documentation>Keep modeless dialogs alive when this dialog is created through

DoAction.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TrackDiskSpace" type="YesNoType"><xs:annotation><xs:documentation>Have the dialog periodically call the installer to check if available disk space has

changed.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="CustomPalette" type="YesNoType"><xs:annotation><xs:documentation>Used to specify if pictures in the dialog box are rendered with a custom

palette.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RightToLeft" type="YesNoType"><xs:annotation><xs:documentation>Used to specify if the text in the dialog should be displayed in right to left reading

order.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RightAligned" type="YesNoType"><xs:annotation>

140

Page 141: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Align text on the right.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="LeftScroll" type="YesNoType"><xs:annotation><xs:documentation>Used to align the scroll bar on the left.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ErrorDialog" type="YesNoType"><xs:annotation><xs:documentation>Specifies this dialog as an error dialog.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

141

Page 142: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DialogRef

Description

Reference to a Dialog.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the Dialog toreference.

Content Model

Always empty.

Referenced By

● Element UI

Remarks

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

Definition

<xs:element name="DialogRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="Dialog" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo><xs:documentation>

Reference to a Dialog. This will cause the entire referenced section's contentsto be included in the installer database.

</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the Dialog to reference.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

142

Page 143: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DigitalCertificate

Description

Adds a digital certificate.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for a certificate file.

SourceFile string Yes The path to the certificate file.

Content Model

Always empty.

Referenced By

● Element DigitalSignature

● Element PatchCertificates

Definition

<xs:element name="DigitalCertificate"><xs:annotation><xs:documentation>

Adds a digital certificate.</xs:documentation>

<xs:appinfo><xse:msiRef table="MsiDigitalCertificate" href="http://msdn.microsoft.com/library/aa370086.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for a certificate file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SourceFile" type="xs:string" use="required"><xs:annotation><xs:documentation>The path to the certificate file.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

143

Page 144: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DigitalSignature

Description

Adds a digital signature.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

SourceFile string No The path to signature's optional hashfile.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

DigitalCertificate anyType (restriction) 1..1 Adds a digital certificate.

Definition

<xs:element name="DigitalSignature"><xs:annotation><xs:documentation>

Adds a digital signature.</xs:documentation>

<xs:appinfo><xse:msiRef table="MsiDigitalSignature" href="http://msdn.microsoft.com/library/aa370087.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice><xs:element ref="DigitalCertificate" />

</xs:choice><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>The path to signature's optional hash file.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

144

Page 145: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Directory

Description

Directory layout for the product.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes This value is the unique identifier ofthe directory entry.

ComponentGuidGenerationSeed

Guid No The Component Guid GenerationSeed is a guid that must be usedwhen a Component with thegenerate guid directive ("*") is notrooted in a standard WindowsInstaller directory (for example,ProgramFilesFolder orCommonFilesFolder, etc).

DiskId integer No Sets the default disk identifier for thefiles contained in this directory.

FileSource string No Used to set the file system source forthis directory's child elements.

LongName LongFileNameType

No

LongSource LongFileNameType

No

Name LongFileNameType

No The name of the directory.

ShortName ShortFileNameType

No The short name of the directory in8.3 format.

ShortSourceName

ShortFileNameType

No The short name of the directory onthe source media in 8.3 format.

SourceName LongFileNameType

No The name of the directory on thesource media.

src string No

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Component anyType (restriction) 1..1 Component for parent Directory

145

Page 146: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

Directory anyType (restriction) 1..1 Directory layout for the product.

Merge anyType (restriction) 1..1 Merge directive to bring in a merge module thatwill be redirected to the parent directory.

SymbolPath anyType (restriction) 1..1 A path to symbols.

Referenced By

● Element Directory

● Element DirectoryRef

● Element Fragment

Remarks

Also specifies the mappings between source and target directories.

Definition

<xs:element name="Directory"><xs:annotation><xs:documentation>Directory layout for the product. Also specifies the mappings between source and target

directories.</xs:documentation><xs:appinfo><xse:seeAlso ref="DirectoryRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:msiRef table="Directory" href="http://msdn.microsoft.com/library/aa368295.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="add_a_file.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to yourinstaller</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Component" /><xs:element ref="Directory" /><xs:element ref="Merge" /><xs:element ref="SymbolPath" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>This value is the unique identifier of the directory entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ComponentGuidGenerationSeed" type="Guid"><xs:annotation><xs:documentation>

The Component Guid Generation Seed is a guid that must be used when a Component with the

146

Page 147: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

generate guid directive ("*")is not rooted in a standard Windows Installer directory (for example, ProgramFilesFolder or

CommonFilesFolder, etc).It is recommended that this attribute be avoided and that developers install their Components

under standarddirectories with unique names instead (for example, "ProgramFilesFolder\Company Name

Product Name Version"). It isimportant to note that once a directory is assigned a Component Guid Generation Seed the

value must not change untilthe directory name changes.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DiskId" type="xs:integer"><xs:annotation><xs:documentation>

Sets the default disk identifier for the files contained in this directory.This attribute must be set on a Component, Directory, or DirectoryRef element or all of its

children Fileelements, else the default disk identifier of 1 is assumed. The value of this attribute should

correspond to the Id attribute of aMedia element authored elsewhere. By creating this connection between a component (orparticular files), you set the packaging options to the values specified in the Mediaelement (values such as compression level, cab embedding, etc...).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="FileSource" type="xs:string"><xs:annotation><xs:documentation>Used to set the file system source for this directory's child

elements.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="LongName" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="LongSource" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceName"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="LongFileNameType"><xs:annotation><xs:documentation>

The name of the directory.

Do not specify this attribute (or the LongName attribute) if this directory representsthe same directory as the parent (see the Windows Installer SDK's<html:a href="http://msdn2.microsoft.com/library/Aa368295.aspx" target="_blank"

xmlns:html="http://www.w3.org/1999/xhtml">Directory table</html:a>topic for more information about the "." operator).

147

Page 148: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

In prior versions of the WiX toolset, this attribute specified the short directory name.This attribute's value may now be either a short or long directory name.If a short directory name is specified, the ShortName attribute may not be specified.If a long directory name is specified, the LongName attribute may not be specified.Also, if this value is a long directory name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short directory name.However, if this name collides with another directory or you wish to manually specifythe short directory name, then the ShortName attribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ShortName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short name of the directory in 8.3 format.This attribute should only be set if there is a conflict between generated short directory namesor the user wants to manually specify the short directory name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ShortSourceName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short name of the directory on the source media in 8.3 format.This attribute should only be set if there is a conflict between generated short directory namesor the user wants to manually specify the short source directory name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceName" type="LongFileNameType"><xs:annotation><xs:documentation>

The name of the directory on the source media.If this attribute is note specified, the Windows Installer will default to the Name attribute.

In prior versions of the WiX toolset, this attribute specified the short source directory name.This attribute's value may now be either a short or long directory name.If a short directory name is specified, the ShortSourceName attribute may not be specified.If a long directory name is specified, the LongSource attribute may not be specified.Also, if this value is a long directory name, the ShortSourceName attribute may be omitted toallow WiX to attempt to generate a unique short directory name.However, if this name collides with another directory or you wish to manually specifythe short directory name, then the ShortSourceName attribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="FileSource"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

148

Page 149: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DirectoryRef

Description

Create a reference to a Directory element in another Fragment.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the Directoryelement to reference.

DiskId integer No Sets the default disk identifier for thefiles contained in this directory.

FileSource string No Used to set the file system source forthis directory ref's child elements.

src string No

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Component anyType (restriction) 1..1 Component for parent Directory

Directory anyType (restriction) 1..1 Directory layout for the product.

Merge anyType (restriction) 1..1 Merge directive to bring in a merge module thatwill be redirected to the parent directory.

Referenced By

● Element Fragment

Definition

<xs:element name="DirectoryRef"><xs:annotation><xs:documentation>Create a reference to a Directory element in another Fragment.</xs:documentation><xs:appinfo><xse:seeAlso ref="Directory" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="add_a_file.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to yourinstaller</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Component" />

149

Page 150: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="Directory" /><xs:element ref="Merge" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the Directory element to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DiskId" type="xs:integer"><xs:annotation><xs:documentation>

Sets the default disk identifier for the files contained in this directory.This attribute must be set on a Component, Directory, or DirectoryRef element or all of its

children Fileelements, else the default disk identifier of 1 is assumed. The value of this attribute should

correspond to the Id attribute of aMedia element authored elsewhere. By creating this connection between a component (orparticular files), you set the packaging options to the values specified in the Mediaelement (values such as compression level, cab embedding, etc...).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="FileSource" type="xs:string"><xs:annotation><xs:documentation>Used to set the file system source for this directory ref's child

elements.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="FileSource"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

150

Page 151: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DirectorySearch

Description

Searches for directory and assigns to value of parent Property.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for the directorysearch.

Path string No Path on the user's system. Eitherabsolute, or relative to containingdirectories.

Depth integer No Depth below the path that theinstaller searches for the file ordirectory specified by the search.

AssignToProperty

YesNoType No Set the result of this search to thevalue of the outer Property.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

DirectorySearch anyType (restriction) 1..1 Searches for directory and assigns to value ofparent Property.

DirectorySearchRef anyType (restriction) 1..1 References an existing DirectorySearchelement.

FileSearch anyType (restriction) 1..1 Searches for file and assigns to fullpath valueof parent Property

FileSearchRef anyType (restriction) 1..1 References an existing FileSearch element.

Referenced By

● Element ComplianceDrive

● Element ComponentSearch

● Element DirectorySearch

● Element DirectorySearchRef

● Element IniFileSearch

● Element RegistrySearch

Definition

<xs:element name="DirectorySearch"><xs:annotation>

151

Page 152: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:appinfo><xse:seeAlso ref="ComponentSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="IniFileSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="RegistrySearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="DrLocator" href="http://msdn.microsoft.com/library/aa368331.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="check_the_version_number.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check the version numberof a file during installation</xse:howtoRef>

</xs:appinfo><xs:documentation>Searches for directory and assigns to value of parent Property.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0"><xs:element ref="DirectorySearch" /><xs:element ref="DirectorySearchRef" /><xs:element ref="FileSearch" /><xs:element ref="FileSearchRef" />

</xs:choice><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Unique identifier for the directory search.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Path" type="xs:string"><xs:annotation><xs:documentation>Path on the user's system. Either absolute, or relative to containing

directories.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Depth" type="xs:integer"><xs:annotation><xs:documentation>

Depth below the path that the installer searches for the file or directory specified by the search.If this value is not specified, the depth is assumed to be 0.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AssignToProperty" type="YesNoType"><xs:annotation><xs:documentation>Set the result of this search to the value of the outer Property.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

152

Page 153: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DirectorySearchRef

Description

References an existing DirectorySearch element.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Id of the search being referred to.

Parent string No This attribute is the signature of theparent directory of the file ordirectory in the Signature_ column.

Path string No Path on the user's system. Eitherabsolute, or relative to containingdirectories.

AssignToProperty

YesNoType No Set the result of this search to thevalue of the outer Property.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

DirectorySearch anyType (restriction) 1..1 Searches for directory and assigns to value ofparent Property.

DirectorySearchRef anyType (restriction) 1..1 References an existing DirectorySearchelement.

FileSearch anyType (restriction) 1..1 Searches for file and assigns to fullpath valueof parent Property

FileSearchRef anyType (restriction) 1..1 References an existing FileSearch element.

Referenced By

● Element ComplianceDrive

● Element ComponentSearch

● Element DirectorySearch

● Element DirectorySearchRef

● Element IniFileSearch

● Element RegistrySearch

Definition

<xs:element name="DirectorySearchRef"><xs:annotation><xs:appinfo>

153

Page 154: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:seeAlso ref="ComponentSearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="IniFileSearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="RegistrySearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">If you intend to use a DirectorySearchRef to

reference a DirectorySearch but they have different parent elements, you must use a DirectorySearch insteadof a DirectorySearchRef. This is because the DrLocator table in an installer package is keyed on the Id, Parent,and Path. When a DirectorySearch and a DirectorySearchRef element are under different parent elements, theParent will automatically be different so a DirectorySearchRef will not have a DirectorySearch toreference.</html:p>

</xse:remarks></xs:appinfo><xs:documentation>References an existing DirectorySearch element.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0"><xs:element ref="DirectorySearch" /><xs:element ref="DirectorySearchRef" /><xs:element ref="FileSearch" /><xs:element ref="FileSearchRef" />

</xs:choice><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Id of the search being referred to.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Parent" type="xs:string"><xs:annotation><xs:documentation>This attribute is the signature of the parent directory of the file or directory in the

Signature_ column. If this field is null, and the Path column does not expand to a full path, then all the fixeddrives of the user's system are searched by using the Path. This field is a key into one of the following tables:the RegLocator, the IniLocator, the CompLocator, or the DrLocator tables.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Path" type="xs:string"><xs:annotation><xs:documentation>Path on the user's system. Either absolute, or relative to containing

directories.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AssignToProperty" type="YesNoType"><xs:annotation><xs:documentation>Set the result of this search to the value of the outer Property.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

154

Page 155: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DisableRollback

Description

Disables rollback for the remainder of the installation.

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="DisableRollback" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="DisableRollback" href="http://msdn.microsoft.com/library/aa368308.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Disables rollback for the remainder of the installation. 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 byusing the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywherebetween InstallInitialize and InstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

155

Page 156: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: DuplicateFiles

Description

Duplicates files installed by the InstallFiles action.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="DuplicateFiles" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="DuplicateFiles" href="http://msdn.microsoft.com/library/aa368334.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Duplicates files installed by the InstallFiles action. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

156

Page 157: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: EmbeddedChainer

Derived By

Extending string

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for embeddedchainer.

CommandLine string No Value to append to the transactionhandle and passed to the chainerexecutable.

BinarySource string No Reference to the Binary element thatcontains the chainer executeable.

FileSource string No Reference to the File element that isthe chainer executeable.

PropertySource string No Reference to a Property thatresolves to the full path to thechainer executeable.

Content Model

Contains text only.

Referenced By

● Element Fragment

Definition

<xs:element name="EmbeddedChainer"><xs:annotation><xs:appinfo><xse:msiRef table="MsiEmbeddedChainer " href="http://msdn.microsoft.com/library/bb736316.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="Binary" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="File" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="Property" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="EmbeddedChainerRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>

Element value is the condition. CDATA may be used to when a condition contains many XMLcharacters

that must be escaped. It is important to note that each EmbeddedChainer element must havea mutually exclusive condition

to ensure that only one embedded chainer will execute at a time. If the conditions are notmutually exclusive the chainer

that executes is undeterministic.</xs:documentation>

157

Page 158: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for embedded chainer.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="CommandLine" type="xs:string"><xs:annotation><xs:documentation>Value to append to the transaction handle and passed to the chainer

executable.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="BinarySource" type="xs:string"><xs:annotation><xs:documentation>

Reference to the Binary element that contains the chainer executeable. Mutually exclusivewith

the FileSource and PropertySource attributes.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="FileSource" type="xs:string"><xs:annotation><xs:documentation>

Reference to the File element that is the chainer executeable. Mutually exclusive withthe BinarySource and PropertySource attributes.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="PropertySource" type="xs:string"><xs:annotation><xs:documentation>

Reference to a Property that resolves to the full path to the chainer executeable. Mutuallyexclusive with

the BinarySource and FileSource attributes.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

158

Page 159: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: EmbeddedChainerRef

Description

Reference to an EmbeddedChainer element.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

Content Model

Always empty.

Referenced By

● Element Fragment

Remarks

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

Definition

<xs:element name="EmbeddedChainerRef"><xs:annotation><xs:documentation>

Reference to an EmbeddedChainer element. This will force the entire referenced Fragment'scontents

to be included in the installer database.</xs:documentation>

<xs:appinfo><xse:seeAlso ref="EmbeddedChainer"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required" /><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

159

Page 160: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: EmbeddedUI

Description

Element value is the condition.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for embedded UI.

IgnoreFatalExit YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_FATALEXITmessages.

IgnoreError YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_ERRORmessages.

IgnoreWarning YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_WARNINGmessages.

IgnoreUser YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_USERmessages.

IgnoreInfo YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_INFOmessages.

IgnoreFilesInUse YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_FILESINUSEmessages.

IgnoreResolveSource

YesNoType No Embedded UI will not recieve any INSTALLLOGMODE_RESOLVESOURCE messages.

IgnoreOutOfDiskSpace

YesNoType No Embedded UI will not recieve any INSTALLLOGMODE_OUTOFDISKSPACE messages.

IgnoreActionStart YesNoType No Embedded UI will not recieve any INSTALLLOGMODE_ACTIONSTARTmessages.

IgnoreActionData YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_ACTIONDATAmessages.

IgnoreProgress YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_PROGRESSmessages.

IgnoreCommonData

YesNoType No Embedded UI will not recieve any INSTALLLOGMODE_COMMONDATAmessages.

160

Page 161: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

IgnoreInitialize YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_INITIALIZEmessages.

IgnoreTerminate YesNoType No Embedded UI will not recieve anyINSTALLLOGMODE_TERMINATEmessages.

IgnoreShowDialog

YesNoType No Embedded UI will not recieve any INSTALLLOGMODE_SHOWDIALOGmessages.

IgnoreRMFilesInUse

YesNoType No Embedded UI will not recieve any INSTALLLOGMODE_RMFILESINUSEmessages.

Name LongFileNameType

No The name for the embedded UI DLLwhen it is extracted from the Productand executed. (Windows Installerdoes not support the typical shortfilename and long filenamecombination for embedded UI filesas it does for other kinds of files.)

SourceFile string Yes Path to the binary file that is theembedded UI.

SupportBasicUI YesNoType No Set yes to allow the WindowsInstaller to display the embedded UIduring basic UI level installation.

Content Model

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

Component Type Occurs Description

1..1

EmbeddedUIResource

anyType (restriction) 0..* Defines a resource for use by the embeddedUI.

Referenced By

● Element UI

Remarks

Use CDATA if message contains delimiter characters.

Definition

<xs:element name="EmbeddedUI"><xs:annotation><xs:appinfo><xse:msiRef table="MsiEmbeddedUI" href="http://msdn.microsoft.com/library/bb736317.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Element value is the condition. Use CDATA if message contains delimiter

161

Page 162: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

characters.</xs:documentation></xs:annotation><xs:complexType mixed="true"><xs:sequence><xs:element ref="EmbeddedUIResource" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Specifies extra files to be extracted for use by the embedded UI, such as language

resources.</xs:documentation></xs:annotation>

</xs:element></xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for embedded UI.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreFatalExit" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_FATALEXIT

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreError" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_ERROR

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreWarning" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_WARNING

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreUser" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_USER

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreInfo" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_INFO

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreFilesInUse" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_FILESINUSE

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreResolveSource" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_RESOLVESOURCE

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreOutOfDiskSpace" type="YesNoType"><xs:annotation>

162

Page 163: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_OUTOFDISKSPACEmessages.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreActionStart" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_ACTIONSTART

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreActionData" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_ACTIONDATA

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreProgress" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_PROGRESS

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreCommonData" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_COMMONDATA

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreInitialize" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_INITIALIZE

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreTerminate" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_TERMINATE

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreShowDialog" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_SHOWDIALOG

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreRMFilesInUse" type="YesNoType"><xs:annotation><xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_RMFILESINUSE

messages.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Name" type="LongFileNameType"><xs:annotation><xs:documentation>

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 filesas it

does for other kinds of files.) If this attribute is not specified the Id attribute will be used.

163

Page 164: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceFile" type="xs:string" use="required"><xs:annotation><xs:documentation>

Path to the binary file that is the embedded UI. This must be a DLL that exports the followingthree entry points: InitializeEmbeddedUI, EmbeddedUIHandler and ShutdownEmbeddedUI.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SupportBasicUI" type="YesNoType"><xs:annotation><xs:documentation>Set yes to allow the Windows Installer to display the embedded UI during basic UI

level installation.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

164

Page 165: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: EmbeddedUIResource

Description

Defines a resource for use by the embedded UI.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the embedded UIresource.

Name LongFileNameType

Yes The name for the resource when it isextracted from the Product for use bythe embedded UI DLL. (WindowsInstaller does not support the typicalshort filename and long filenamecombination for embedded UI filesas it does for other kinds of files.)

SourceFile string Yes Path to the binary file that is theembedded UI resource.

Content Model

Always empty.

Referenced By

● Element EmbeddedUI

Definition

<xs:element name="EmbeddedUIResource"><xs:annotation><xs:documentation>

Defines a resource for use by the embedded UI.</xs:documentation>

<xs:appinfo><xse:seeAlso ref="EmbeddedUI"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="MsiEmbeddedUI" href="http://msdn.microsoft.com/library/bb736317.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the embedded UI resource.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="LongFileNameType" use="required"><xs:annotation><xs:documentation>

The name for the resource when it is extracted from the Product for use by the embedded UI

165

Page 166: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

DLL. (WindowsInstaller does not support the typical short filename and long filename combination for

embedded UI filesas it does for other kinds of files.) If this attribute is not specified the Id attribute will be used.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceFile" type="xs:string" use="required"><xs:annotation><xs:documentation>Path to the binary file that is the embedded UI resource.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

166

Page 167: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: EnsureTable

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 Required? Default Description

Id string Yes The name of the table.

Content Model

Always empty.

Referenced By

● Element Fragment

Definition

<xs:element name="EnsureTable"><xs:annotation><xs:documentation>

Use this element to ensure that a table appears in the installer database, even if its empty.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">

This element is particularly useful for two problems that may occur while merging merge modules:<html:ol xmlns:html="http://www.w3.org/1999/xhtml"><html:li>

The first likely problem is that in order to properly merge you need to have certaintables present prior to merging. Using this element is one way to ensure those tablesare present prior to the merging.

</html:li><html:li>The other common problem is that a merge module has incorrect validation informationabout some tables. By ensuring these tables prior to merging, you can avoid thisproblem because the correct validation information will go into the installer databasebefore the merge module has a chance to set it incorrectly.

</html:li></html:ol></xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>The name of the table.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

167

Page 168: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Environment

Description

Environment variables added or removed for the parent component.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for environmententry.

Name string Yes Name of the environment variable.

Value string No The value to set into the environmentvariable.

Separator string No Optional attribute to change theseparator used between values.

Action NMTOKEN(restriction)

No Specfies whether the environmentalvariable should be created, set orremoved when the parentcomponent is installed.

Part NMTOKEN(restriction)

No

Permanent YesNoType No Specifies that the environmentvariable should not be removed onuninstall.

System YesNoType No Specifies that the environmentvariable should be added to thesystem environment space.

Content Model

Always empty.

Referenced By

● Element Component

Definition

<xs:element name="Environment"><xs:annotation><xs:documentation>

Environment variables added or removed for the parent component.</xs:documentation>

<xs:appinfo><xse:msiRef table="Environment" href="http://msdn.microsoft.com/library/aa368369.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType>

168

Page 169: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for environment entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Name of the environment variable.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

The value to set into the environment variable.If this attribute is not set, the environment variable is removed during installation if it exists on the

machine.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Separator" type="xs:string"><xs:annotation><xs:documentation>Optional attribute to change the separator used between values. By default a

semicolon is used.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Action"><xs:annotation><xs:documentation>Specfies whether the environmental variable should be created, set or removed when

the parent component is installed.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="create"><xs:annotation><xs:documentation>Creates the environment variable if it does not exist, then set it during installation.

This has no effect on the value of the environment variable if it already exists.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="set"><xs:annotation><xs:documentation>Creates the environment variable if it does not exist, and then set it during

installation. If the environment variable exists, set it during the installation.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="remove"><xs:annotation><xs:documentation>

Removes the environment variable during an installation.The installer only removes an environment variable during an installation if the name and

valueof the variable match the entries in the Name and Value attributes.If you want to remove an environment variable, regardless of its value, do not set the

Value attribute.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Part">

169

Page 170: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="all"><xs:annotation><xs:documentation>

This value is the entire environmental variable. This is the default.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="first"><xs:annotation><xs:documentation>

This value is prefixed.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="last"><xs:annotation><xs:documentation>

This value is appended.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Permanent" type="YesNoType"><xs:annotation><xs:documentation>Specifies that the environment variable should not be removed on

uninstall.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="System" type="YesNoType"><xs:annotation><xs:documentation>

Specifies that the environment variable should be added to the system environment space. Thedefault

is 'no' which indicates the environment variable is added to the user environment space.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

170

Page 171: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Error

Derived By

Extending string

Attributes

Name Type Required? Default Description

Id integer No Number of the error for which amessage is being provided.

Content Model

Contains text only.

Referenced By

● Element UI

Definition

<xs:element name="Error"><xs:annotation><xs:appinfo><xse:msiRef table="Error" href="http://msdn.microsoft.com/library/aa368554.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>Element value is Message, use CDATA if message contains delimiter

characters</xs:documentation></xs:annotation><xs:attribute name="Id" type="xs:integer"><xs:annotation><xs:documentation>Number of the error for which a message is being provided. See MSI SDK for error

definitions.</xs:documentation></xs:annotation>

</xs:attribute></xs:extension>

</xs:simpleContent></xs:complexType>

</xs:element>

171

Page 172: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Exclusion

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

ExcludedId string Yes Identifier of the merge module that isincompatible.

ExcludeExceptLanguage

integer No Numeric language ID of the mergemodule in ExcludedID.

ExcludeLanguage

integer No Numeric language ID of the mergemodule in ExcludedID.

ExcludedMinVersion

string No Minimum version excluded from arange.

ExcludedMaxVersion

string No Maximum version excluded from arange.

Content Model

Always empty.

Definition

<xs:element name="Exclusion"><xs:annotation><xs:documentation>Declares a merge module with which this merge module is

incompatible.</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="ExcludedId" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier of the merge module that is incompatible.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ExcludeExceptLanguage" type="xs:integer"><xs:annotation><xs:documentation>Numeric language ID of the merge module in ExcludedID. All except this language will

be excluded. Only one of ExcludeExceptLanguage and ExcludeLanguage may bespecified.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ExcludeLanguage" type="xs:integer"><xs:annotation><xs:documentation>Numeric language ID of the merge module in ExcludedID. The specified language will

be excluded. Only one of ExcludeExceptLanguage and ExcludeLanguage may bespecified.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ExcludedMinVersion" type="xs:string">

172

Page 173: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>Minimum version excluded from a range. If not set, all versions before max are

excluded. If neither max nor min, no exclusion based on version.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ExcludedMaxVersion" type="xs:string"><xs:annotation><xs:documentation>Maximum version excluded from a range. If not set, all versions after min are

excluded. If neither max nor min, no exclusion based on version.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

173

Page 174: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ExecuteAction

Description

Initiates the execution sequence.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminUISequence

● Element InstallUISequence

Remarks

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

Definition

<xs:element name="ExecuteAction" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="ExecuteAction" href="http://msdn.microsoft.com/library/aa368565.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Initiates the execution sequence. The condition for this action may be specified in the

element's inner text.</xs:documentation></xs:annotation>

</xs:element>

174

Page 175: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Extension

Description

Extension for a Component

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes This is simply the file extension, like"doc" or "xml". Do not include thepreceding period.

ContentType string No The MIME type that is to be written.

Advertise YesNoType No Whether this extension is to beadvertised. The default is "no".

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

MIME anyType (restriction) 1..1 MIME content-type for an Extension

Verb anyType (restriction) 1..1 Verb definition for an Extension.

Referenced By

● Element Component

● Element ProgId

Definition

<xs:element name="Extension"><xs:annotation><xs:documentation>

Extension for a Component</xs:documentation>

<xs:appinfo><xse:msiRef table="MIME" href="http://msdn.microsoft.com/library/aa370035.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Verb" href="http://msdn.microsoft.com/library/aa372487.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>MIME and Verbs can be associated with Extensions</xs:documentation>

</xs:annotation>

175

Page 176: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="MIME" /><xs:element ref="Verb" />

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>This is simply the file extension, like "doc" or "xml". Do not include the preceding

period.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ContentType" type="xs:string"><xs:annotation><xs:documentation>The MIME type that is to be written.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Advertise" type="YesNoType"><xs:annotation><xs:documentation>Whether this extension is to be advertised. The default is "no".</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

176

Page 177: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ExternalFile

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

File string Yes Foreign key into the File table.

Source string No Full path of the external file.

src string No

Order int Yes Specifies the order of the externalfiles to use when creating the patch.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ProtectRange anyType (restriction) 1..* Specifies part of a file that cannot beoverwritten during patching.

SymbolPath anyType (restriction) 1..* A path to symbols.

0..*

IgnoreRange anyType (restriction) 1..1 Specifies part of a file that is to be ignoredduring patching.

Definition

<xs:element name="ExternalFile"><xs:annotation><xs:documentation>Contains information about specific files that are not part of a regular target

image.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element ref="ProtectRange" maxOccurs="unbounded" /><xs:element ref="SymbolPath" maxOccurs="unbounded" /><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="IgnoreRange" />

</xs:choice></xs:sequence><xs:attribute name="File" type="xs:string" use="required"><xs:annotation><xs:documentation>Foreign key into the File table.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Source" type="xs:string">

177

Page 178: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>Full path of the external file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="Source" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="Order" type="xs:int" use="required"><xs:annotation><xs:documentation>Specifies the order of the external files to use when creating the

patch.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

178

Page 179: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Family

Description

Group of one or more upgraded images of a product.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

DiskId int No Entered into the DiskId field of thenew Media table record.

DiskPrompt string No Value to display in the "[1]" of theDiskPrompt Property.

MediaSrcProp string No Entered into the Source field of thenew Media table entry of theupgraded image.

Name string Yes Identifier for the family.

SequenceStart int No Sequence number for the startingfile.

VolumeLabel string No Entered into the VolumeLabel field ofthe new Media table record.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

UpgradeImage anyType (restriction) 1..* Contains information about the upgradedimages of the product.

0..*

ExternalFile anyType (restriction) 1..1 Contains information about specific files thatare not part of a regular target image.

ProtectFile anyType (restriction) 1..1 Specifies a file to be protected.

Referenced By

● Element PatchCreation

Definition

<xs:element name="Family"><xs:annotation><xs:documentation>Group of one or more upgraded images of a product.</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="UpgradeImage" maxOccurs="unbounded" />

179

Page 180: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="ExternalFile" /><xs:element ref="ProtectFile" />

</xs:choice></xs:sequence><xs:attribute name="DiskId" type="xs:int"><xs:annotation><xs:documentation>Entered into the DiskId field of the new Media table record.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DiskPrompt" type="xs:string"><xs:annotation><xs:documentation>Value to display in the "[1]" of the DiskPrompt Property. Using this attribute will

require you to define a DiskPrompt Property.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="MediaSrcProp" type="xs:string"><xs:annotation><xs:documentation>Entered into the Source field of the new Media table entry of the upgraded

image.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the family.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SequenceStart" type="xs:int"><xs:annotation><xs:documentation>Sequence number for the starting file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="VolumeLabel" type="xs:string"><xs:annotation><xs:documentation>Entered into the VolumeLabel field of the new Media table

record.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

180

Page 181: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Feature

Description

A feature for the Feature table.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier of the feature.

Absent NMTOKEN(restriction)

No This attribute determines if a user willhave the option to set a feature toabsent in the user interface.

AllowAdvertise NMTOKEN(restriction)

No This attribute determins the possibleadvertise states for this feature.

ConfigurableDirectory

string No Specify the Id of a Directory that canbe configured by the user atinstallation time.

Description string No Longer string of text describing thefeature.

Display string No Determines the initial display of thisfeature in the feature tree.

InstallDefault NMTOKEN(restriction)

No This attribute determines the defaultinstall/run location of a feature.

Level integer Yes Sets the install level of this feature.

Title string No Short string of text identifying thefeature.

TypicalDefault NMTOKEN(restriction)

No This attribute determines the defaultadvertise state of the feature.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroupRef

anyType (restriction) 1..1 Create a reference to a ComponentGroup inanother Fragment.

ComponentRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Condition string (extension) 1..1 Conditions for components, controls, features,and products.

181

Page 182: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

Feature anyType (restriction) 1..1 A feature for the Feature table.

FeatureGroupRef anyType (restriction) 1..1 Create a reference to a FeatureGroup inanother Fragment.

FeatureRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

MergeRef anyType (restriction) 1..1 Merge reference to connect a Merge Module toparent Feature

Referenced By

● Element Feature

● Element FeatureGroup

● Element FeatureRef

● Element Fragment

Remarks

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

Definition

<xs:element name="Feature"><xs:annotation><xs:documentation>

A feature for the Feature table. Features are the smallest installable unit. See msi.chm for moredetailed information on the myriad installation options for a feature.

</xs:documentation><xs:appinfo><xse:seeAlso ref="FeatureRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:msiRef table="Feature" href="http://msdn.microsoft.com/library/aa368585.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="add_a_file.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to yourinstaller</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Component" /><xs:element ref="ComponentGroupRef" /><xs:element ref="ComponentRef" /><xs:element ref="Condition" /><xs:element ref="Feature" /><xs:element ref="FeatureGroupRef" /><xs:element ref="FeatureRef" /><xs:element ref="MergeRef" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation>

182

Page 183: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:any>

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier of the feature.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Absent"><xs:annotation><xs:documentation>

This attribute determines if a user will have the option to set a feature to absent in the userinterface.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="allow"><xs:annotation><xs:documentation>

Allows the user interface to display an option to change the feature state to Absent.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="disallow"><xs:annotation><xs:documentation>

Prevents the user interface from displaying an option to change the feature stateto Absent by setting the msidbFeatureAttributesUIDisallowAbsent attribute. This will

force the featureto the installation state, whether or not the feature is visible in the UI.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="AllowAdvertise"><xs:annotation><xs:documentation>

This attribute determins the possible advertise states for this feature.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="no"><xs:annotation><xs:documentation>

Prevents this feature from being advertised by settting themsidbFeatureAttributesDisallowAdvertise attribute.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="system"><xs:annotation><xs:documentation>

Prevents advertising for this feature if the operating system shell does not supportWindows Installer

descriptors by setting the msidbFeatureAttributesNoUnsupportedAdvertise attribute.</xs:documentation>

183

Page 184: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:enumeration><xs:enumeration value="yes"><xs:annotation><xs:documentation>

Allows the feature to be advertised.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="ConfigurableDirectory" type="xs:string"><xs:annotation><xs:documentation>

Specify the Id of a Directory that can be configured by the user at installation time. This identifiermust be a public property and therefore completely uppercase.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>

Longer string of text describing the feature. This localizable string is displayed by theText Control of the Selection Dialog.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Display" type="xs:string"><xs:annotation><xs:documentation>

Determines the initial display of this feature in the feature tree.This attribute's value should be one of the following:<html:dl xmlns:html="http://www.w3.org/1999/xhtml"><html:dt

class="enumerationValue"><html:dfn>collapse</html:dfn></html:dt><html:dd>Initially shows the featurecollapsed. This is the default value.</html:dd><html:dtclass="enumerationValue"><html:dfn>expand</html:dfn></html:dt><html:dd>Initially shows the featureexpanded.</html:dd><html:dtclass="enumerationValue"><html:dfn>hidden</html:dfn></html:dt><html:dd>Prevents the feature fromdisplaying in the user interface.</html:dd><html:dt class="enumerationValue"><html:dfn>&lt;an explicit integervalue&gt;</html:dfn></html:dt><html:dd>

For advanced users only, it is possible to directly set the integer valueof the display value that will appear in the Feature row.

</html:dd></html:dl></xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="InstallDefault"><xs:annotation><xs:documentation>

This attribute determines the default install/run location of a feature. This attribute cannot bespecified

if the value of the FollowParent attribute is 'yes' since that would ask the installer to force thisfeature

to follow the parent installation state and simultaneously favor a particular installation state justfor this feature.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="followParent">

184

Page 185: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>

Forces the feature to follow the same installation state as its parent feature.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="local"><xs:annotation><xs:documentation>

Favors installing this feature locally by setting the msidbFeatureAttributesFavorLocalattribute.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="source"><xs:annotation><xs:documentation>

Favors running this feature from source by setting themsidbFeatureAttributesFavorSource attribute.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Level" type="xs:integer" use="required"><xs:annotation><xs:documentation>

Sets the install level of this feature. A value of 0 will disable the feature. Processing theCondition Table can modify the level value (this is set via the Condition child element).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Title" type="xs:string"><xs:annotation><xs:documentation>

Short string of text identifying the feature. This string is listed as an item by theSelectionTree control of the Selection Dialog.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TypicalDefault"><xs:annotation><xs:documentation>

This attribute determines the default advertise state of the feature.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="advertise"><xs:annotation><xs:documentation>

Sets the feature to be advertised by setting the msidbFeatureAttributesFavorAdvertiseattribute.

This value cannot be set if the value of the AllowAdvertise attribute is 'no' since thatwould ask the installer to

disallow the advertised state for this feature while at the same time favoring it.</xs:documentation>

</xs:annotation></xs:enumeration>

185

Page 186: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:enumeration value="install"><xs:annotation><xs:documentation>

Sets the feature to the default non-advertised installation option.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

186

Page 187: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FeatureGroup

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the FeatureGroup.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroupRef

anyType (restriction) 1..1 Create a reference to a ComponentGroup inanother Fragment.

ComponentRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Feature anyType (restriction) 1..1 A feature for the Feature table.

FeatureGroupRef anyType (restriction) 1..1 Create a reference to a FeatureGroup inanother Fragment.

FeatureRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

MergeRef anyType (restriction) 1..1 Merge reference to connect a Merge Module toparent Feature

Referenced By

● Element FeatureRef

● Element Fragment

Definition

<xs:element name="FeatureGroup"><xs:annotation><xs:documentation>

Groups together multiple components, features, and merges to be used in other locations.</xs:documentation>

<xs:appinfo><xse:seeAlso ref="FeatureGroupRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

187

Page 188: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Component" /><xs:element ref="ComponentGroupRef" /><xs:element ref="ComponentRef" /><xs:element ref="Feature" /><xs:element ref="FeatureGroupRef" /><xs:element ref="FeatureRef" /><xs:element ref="MergeRef" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the FeatureGroup.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

188

Page 189: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FeatureGroupRef

Description

Create a reference to a FeatureGroup in another Fragment.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the FeatureGroup toreference.

IgnoreParent YesNoType No Normally feature group referencesthat end up nested under a parentelement create a connection to thatparent.

Primary YesNoType No Set this attribute to 'yes' in order tomake the parent feature of this groupthe primary feature for anycomponents and merges containedin the group.

Content Model

Always empty.

Referenced By

● Element Feature

● Element FeatureGroup

● Element FeatureRef

Definition

<xs:element name="FeatureGroupRef"><xs:annotation><xs:documentation>Create a reference to a FeatureGroup in another Fragment.</xs:documentation><xs:appinfo><xse:seeAlso ref="FeatureGroup"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the FeatureGroup to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreParent" type="YesNoType"><xs:annotation><xs:documentation>

Normally feature group references that end up nested under a parent element create aconnection to that parent. This behavior is undesirable when trying to simply reference

189

Page 190: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

to a FeatureGroup in a different Fragment. Specify 'yes' to have this feature groupreference not create a connection to its parent. The default is 'no'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Primary" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' in order to make the parent feature of this groupthe primary feature for any components and merges contained in the group.Features may belong to multiple features. By designating a feature as theprimary feature of a component or merge, you ensure that whenever a component isselected for install-on-demand (IOD), the primary feature will be the one to installit. This attribute should only be set if a component actually nests under multiplefeatures. If a component nests under only one feature, that feature is the primaryfeature for the component. You cannot set more than one feature as the primaryfeature of a given component.

</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

190

Page 191: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FeatureRef

Description

Create a reference to a Feature element in another Fragment.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the Feature elementto reference.

IgnoreParent YesNoType No Normally feature references that arenested under a parent elementcreate a connection to that parent.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroupRef

anyType (restriction) 1..1 Create a reference to a ComponentGroup inanother Fragment.

ComponentRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Feature anyType (restriction) 1..1 A feature for the Feature table.

FeatureGroup anyType (restriction) 1..1 Groups together multiple components,features, and merges to be used in otherlocations.

FeatureGroupRef anyType (restriction) 1..1 Create a reference to a FeatureGroup inanother Fragment.

FeatureRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

MergeRef anyType (restriction) 1..1 Merge reference to connect a Merge Module toparent Feature

Referenced By

● Element Feature

● Element FeatureGroup

● Element FeatureRef

● Element Fragment

191

Page 192: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element name="FeatureRef"><xs:annotation><xs:documentation>Create a reference to a Feature element in another Fragment.</xs:documentation><xs:appinfo><xse:seeAlso ref="Feature" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Component" /><xs:element ref="ComponentGroupRef" /><xs:element ref="ComponentRef" /><xs:element ref="Feature" /><xs:element ref="FeatureRef" /><xs:element ref="FeatureGroup" /><xs:element ref="FeatureGroupRef" /><xs:element ref="MergeRef" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the Feature element to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreParent" type="YesNoType"><xs:annotation><xs:documentation>

Normally feature references that are nested under a parent element create a connection to thatparent. This behavior is undesirable when trying to simply reference a Feature in a differentFragment. Specify 'yes' to have this feature reference not create a connection to its parent.The default is 'no'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

192

Page 193: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: File

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No The unique identifier for this Fileelement.

CompanionFile string No Set this attribute to make this file acompanion child of another file.

Name LongFileNameType

No In prior versions of the WiX toolset,this attribute specified the short filename. This attribute's value may nowbe either a short or long file name.

LongName LongFileNameType

No

KeyPath YesNoType No Set to yes in order to force this file tobe the key path for the parentcomponent.

ShortName ShortFileNameType

No The short file name of the file in 8.3format.

ReadOnly YesNoType No Set to yes in order to have the file'sread-only attribute set when it isinstalled on the target machine.

Hidden YesNoType No Set to yes in order to have the file'shidden attribute set when it isinstalled on the target machine.

System YesNoType No Set to yes in order to have the file'ssystem attribute set when it isinstalled on the target machine.

Vital YesNoType No If a file is vital, then installationcannot proceed unless the file issuccessfully installed.

Checksum YesNoType No This attribute should be set to "yes"for every executable file in theinstallation that has a validchecksum stored in the PortableExecutable (PE) file header.

Compressed YesNoDefaultType

No Sets the file's source typecompression.

BindPath string No A list of paths, separated bysemicolons, that represent the pathsto be searched to find the importedDLLs.

193

Page 194: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

SelfRegCost integer No The cost of registering the file inbytes.

TrueType YesNoType No Causes an entry to be generated forthe file in the Font table with noFontTitle specified.

FontTitle string No Causes an entry to be generated forthe file in the Font table with thespecified FontTitle.

DefaultLanguage string No This is the default language of thisfile.

DefaultSize integer No This is the default size of this file.

DefaultVersion string No This is the default version of this file.

Assembly NMTOKEN(restriction)

No Specifies if this File is a Win32Assembly or .NET Assembly thatneeds to be installed into the GlobalAssembly Cache.

AssemblyManifest

string No Specifies the file identifier of themanifest file that describes thisassembly.

AssemblyApplication

string No Specifies the file identifier of theapplication file.

ProcessorArchitecture

NMTOKEN(restriction)

No Specifies the architecture for thisassembly.

DiskId integer No Specifies the Media this File shouldbe sourced on.

Source string No Specifies the path to the File in thebuild process.

src string No

PatchGroup integer No This attribute must be set forpatch-added files.

PatchIgnore YesNoType No Prevents the updating of the file thatis in fact changed in the upgradedimage relative to the target images.

PatchAllowIgnoreOnError

YesNoType No Set to indicate that the patch isnon-vital.

PatchWholeFile YesNoType No Set if the entire file should beinstalled rather than creating a binarypatch.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

194

Page 195: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

any 1..1 Allow any element from the ##othernamespace.

AppId anyType (restriction) 1..1 Application ID containing DCOM information forthe associated application GUID.

AssemblyName anyType (restriction) 1..1 The MsiAssemblyName table specifies theschema for the elements of a strong assemblycache name for a .NET Framework or Win32assembly.

Class anyType (restriction) 1..1 COM Class registration for parent Component.

CopyFile anyType (restriction) 1..1 Copy or move an existing file on the targetmachine, or copy a file that is being installed, toanother destination.

ODBCDriver anyType (restriction) 1..1 ODBCDriver for a Component

ODBCTranslator anyType (restriction) 1..1 ODBCTranslator for a Component

Permission anyType (restriction) 1..1 Sets ACLs on File, Registry, or CreateFolder.

Shortcut anyType (restriction) 1..1 Shortcut, default target is parent File,CreateFolder, or Component's Directory

SymbolPath anyType (restriction) 1..1 A path to symbols.

TypeLib anyType (restriction) 1..1 Register a type library (TypeLib).

Referenced By

● Element Component

Definition

<xs:element name="File"><xs:annotation><xs:documentation>

File specification for File table, must be child node of Component.</xs:documentation>

<xs:appinfo><xse:msiRef table="File" href="http://msdn.microsoft.com/library/aa368596.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="add_a_file.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to yourinstaller</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="AssemblyName" /><xs:element ref="Permission"><xs:annotation><xs:documentation>Used to configure the ACLs for this file.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CopyFile"><xs:annotation><xs:documentation>Used to create a duplicate of this file elsewhere.</xs:documentation>

</xs:annotation>

195

Page 196: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:element><xs:element ref="Shortcut"><xs:annotation><xs:documentation>Target of the shortcut will be set to this file.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ODBCDriver" /><xs:element ref="ODBCTranslator" /><xs:element ref="SymbolPath" /><xs:element ref="Class" /><xs:element ref="AppId" /><xs:element ref="TypeLib" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

The unique identifier for this File element. If you omit Id, it defaults to the file name portion of theSource attribute, if specified. May be referenced as a Property by specifying [#value].

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="CompanionFile" type="xs:string"><xs:annotation><xs:documentation>Set this attribute to make this file a companion child of another file. The installation

state of a companion file depends not on its own file versioning information, but on the versioningof its

companion parent. A file that is the key path for its component can not be a companion file (thatmeans

this attribute cannot be set if KeyPath="yes" for this file). The Version attribute cannot be set alongwith this attribute since companion files are not installed based on their own

version.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Name" type="LongFileNameType"><xs:annotation><xs:documentation>

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.If a short file name is specified, the ShortName attribute may not be specified.If a long file name is specified, the LongName attribute may not be specified.Also, if this value is a long file name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short file name.However, if this name collides with another file or you wish to manually specifythe short file name, then the ShortName attribute may be specified.Finally, if this attribute is omitted then its default value is the file name portionof the Source attribute, if one is specified, or the value of the Id attribute, ifthe Source attribute is omitted or doesn't contain a file name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="LongName" type="LongFileNameType"><xs:annotation>

196

Page 197: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="KeyPath" type="YesNoType"><xs:annotation><xs:documentation>Set to yes in order to force this file to be the key path for the parent

component.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ShortName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short file name of the file in 8.3 format.This attribute should only be set if there is a conflict between generated short file namesor the user wants to manually specify the short file name.

</xs:documentation></xs:annotation>

</xs:attribute><!-- 'Attributes' column integer value generated from XML attributes below --><xs:attribute name="ReadOnly" type="YesNoType"><xs:annotation><xs:documentation>Set to yes in order to have the file's read-only attribute set when it is installed on the

target machine.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Hidden" type="YesNoType"><xs:annotation><xs:documentation>Set to yes in order to have the file's hidden attribute set when it is installed on the

target machine.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="System" type="YesNoType"><xs:annotation><xs:documentation>Set to yes in order to have the file's system attribute set when it is installed on the

target machine.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Vital" type="YesNoType"><xs:annotation><xs:documentation>If a file is vital, then installation cannot proceed unless the file is successfully installed.

The user will have no option to ignore an error installing this file. If an error occurs, they can merely retry toinstall the file or abort the installation. The default is "yes," unless the -sfdvital switch (candle.exe) orSuppressFileDefaultVital property (.wixproj) is used.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Checksum" type="YesNoType"><xs:annotation><xs:documentation>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. Only those files that have this attribute setwill be verified for valid checksum during a reinstall.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Compressed" type="YesNoDefaultType"><xs:annotation><xs:documentation>Sets the file's source type compression. A setting of "yes" or "no" will override the

setting in the Word Count Summary Property.</xs:documentation></xs:annotation>

197

Page 198: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute><xs:attribute name="BindPath" type="xs:string"><xs:annotation><xs:documentation>A list of paths, separated by semicolons, that represent the paths to be searched to

find the imported DLLs. The list is usually a list of properties, with each property enclosed inside squarebrackets. The value may be set to an empty string. Including this attribute will cause an entry to be generatedfor the file in the BindImage table.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SelfRegCost" type="xs:integer"><xs:annotation><xs:documentation>The cost of registering the file in bytes. This must be a non-negative number.

Including this attribute will cause an entry to be generated for the file in the SelfReg table.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TrueType" type="YesNoType"><xs:annotation><xs:documentation>Causes an entry to be generated for the file in the Font table with no FontTitle

specified. This attribute is intended to be used to register the file as a TrueType font.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="FontTitle" type="xs:string"><xs:annotation><xs:documentation>Causes an entry to be generated for the file in the Font table with the specified

FontTitle. This attribute is intended to be used to register the file as a non-TrueType font.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DefaultLanguage" type="xs:string"><xs:annotation><xs:documentation>This is the default language of this file. The linker will replace this value from the

value in the file if the suppress files option is not used.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DefaultSize" type="xs:integer"><xs:annotation><xs:documentation>This is the default size of this file. The linker will replace this value from the value in

the file if the suppress files option is not used.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DefaultVersion" type="xs:string"><xs:annotation><xs:documentation>This is the default version of this file. The linker will replace this value from the value

in the file if the suppress files option is not used.</xs:documentation></xs:annotation>

</xs:attribute><!-- assembly information --><xs:attribute name="Assembly"><xs:annotation><xs:documentation>

Specifies if this File is a Win32 Assembly or .NET Assembly that needs to be installed into theGlobal Assembly Cache. If the value is '.net' or 'win32', this file must also be the key path of the

Component.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value=".net"><xs:annotation><xs:documentation>

The file is a .NET Framework assembly.

198

Page 199: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="no"><xs:annotation><xs:documentation>

The file is not a .NET Framework or Win32 assembly. This is the default value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="win32"><xs:annotation><xs:documentation>

The file is a Win32 assembly.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="AssemblyManifest" type="xs:string"><xs:annotation><xs:documentation>

Specifies the file identifier of the manifest file that describes this assembly.The manifest file should be in the same component as the assembly it describes.This attribute may only be specified if the Assembly attribute is set to '.net' or 'win32'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AssemblyApplication" type="xs:string"><xs:annotation><xs:documentation>

Specifies the file identifier of the application file. This assembly will be isolatedto the same directory as the application file.If this attribute is absent, the assembly will be installed to the Global Assembly Cache.This attribute may only be specified if the Assembly attribute is set to '.net' or 'win32'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ProcessorArchitecture"><xs:annotation><xs:documentation>Specifies the architecture for this assembly. This attribute should only be used on

.NET Framework 2.0 assemblies.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="msil"><xs:annotation><xs:documentation>

The file is a .NET Framework assembly that is processor-neutral.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="x86"><xs:annotation><xs:documentation>

The file is a .NET Framework assembly for the x86 processor.</xs:documentation>

</xs:annotation></xs:enumeration>

199

Page 200: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:enumeration value="x64"><xs:annotation><xs:documentation>

The file is a .NET Framework assembly for the x64 processor.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="ia64"><xs:annotation><xs:documentation>

The file is a .NET Framework assembly for the ia64 processor.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="DiskId" type="xs:integer"><xs:annotation><xs:documentation>Specifies the Media this File should be sourced on. This attribute overrides the

default DiskId attribute from the parent Component element. If no DiskId attribute is specifed, the default is"1".</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Source" type="xs:string"><xs:annotation><xs:documentation>Specifies the path to the File in the build process. This attribute must be set if no

source information can be gathered from parent directories.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="Source" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="PatchGroup" type="xs:integer"><xs:annotation><xs:documentation>

This attribute must be set for patch-added files. Each patch should be assigned a different patchgroup number. Patch groups

numbers must be greater 0 and should be assigned consecutively. For example, the first patchshould use PatchGroup='1', the

second patch will have PatchGroup='2', etc...</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="PatchIgnore" type="YesNoType"><xs:annotation><xs:documentation>Prevents the updating of the file that is in fact changed in the upgraded image relative

to the target images.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="PatchAllowIgnoreOnError" type="YesNoType"><xs:annotation><xs:documentation>Set to indicate that the patch is non-vital.</xs:documentation>

</xs:annotation></xs:attribute>

200

Page 201: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="PatchWholeFile" type="YesNoType"><xs:annotation><xs:documentation>Set if the entire file should be installed rather than creating a binary

patch.</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

201

Page 202: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FileCost

Description

Initiates dynamic costing of standard installation actions.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

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

Definition

<xs:element name="FileCost" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="CostInitialize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:seeAlso ref="CostFinalize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:msiRef action="FileCost" href="http://msdn.microsoft.com/library/aa368589.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Initiates dynamic costing of standard installation actions. Any standard or custom

202

Page 203: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

actions that affect costing should sequenced before the CostInitialize action. Call the FileCost actionimmediately following the CostInitialize action. Then call the CostFinalize action following the FileCost action tomake all final cost calculations available to the installer through the Component table. The CostInitialize actionmust be executed before the FileCost action. The installer then determines the disk-space cost of every file inthe File table, on a per-component basis, taking both volume clustering and the presence of existing files thatmay 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 tobe installed or not. If the existing file is of an equal or greater version number, the existing file is not overwrittenand no disk-space cost is incurred. In all cases, the installer uses the results of version number checking to setthe installation state of each file. The FileCost action initializes cost calculation with the installer. Actualdynamic costing does not occur until the CostFinalize action is executed. The condition for this action may bespecified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

203

Page 204: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FileSearch

Description

Searches for file and assigns to fullpath value of parent Property

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Unique identifier for the file searchand external key into the Signaturetable.

Name LongFileNameType

No In prior versions of the WiX toolset,this attribute specified the short filename. This attribute's value may nowbe either a short or long file name.

LongName LongFileNameType

No

ShortName ShortFileNameType

No The short file name of the file in 8.3format.

MinSize int No The minimum size of the file.

MaxSize int No The maximum size of the file.

MinVersion string No The minimum version of the file.

MaxVersion string No The maximum version of the file.

MinDate dateTime No The minimum modification date andtime of the file.

MaxDate dateTime No The maximum modification date andtime of the file.

Languages string No The languages supported by the file.

Content Model

Always empty.

Referenced By

● Element ComponentSearch

● Element DirectorySearch

● Element DirectorySearchRef

● Element IniFileSearch

● Element RegistrySearch

Definition

<xs:element name="FileSearch"><xs:annotation><xs:appinfo>

204

Page 205: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:seeAlso ref="ComponentSearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="DirectorySearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="DirectorySearchRef"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="FileSearchRef"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="IniFileSearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:seeAlso ref="RegistrySearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:msiRef table="DrLocator" href="http://msdn.microsoft.com/library/aa368331.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:howtoRef href="check_the_version_number.htm"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check the version numberof a file during installation</xse:howtoRef>

</xs:appinfo><xs:documentation>Searches for file and assigns to fullpath value of parent Property</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>Unique identifier for the file search and external key into the Signature table. This

attribute is required if FileSearch is nested under a DirectorySearch or DirectorySearchRefelement.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="LongFileNameType"><xs:annotation><xs:documentation>

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.If a short file name is specified, the ShortName attribute may not be specified.If a long file name is specified, the LongName attribute may not be specified.If you wish to manually specify the short file name, then the ShortNameattribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="LongName" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="ShortName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short file name of the file in 8.3 format.There is a Windows Installer bug which prevents the FileSearch functionality from workingif both a short and long file name are specified. Since the Name attribute allows eithera short or long name to be specified, it is the only attribute related to file names whichshould be specified.

</xs:documentation></xs:annotation>

205

Page 206: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute><xs:attribute name="MinSize" type="xs:int"><xs:annotation><xs:documentation>The minimum size of the file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MaxSize" type="xs:int"><xs:annotation><xs:documentation>The maximum size of the file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MinVersion" type="xs:string"><xs:annotation><xs:documentation>The minimum version of the file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MaxVersion" type="xs:string"><xs:annotation><xs:documentation>The maximum version of the file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MinDate" type="xs:dateTime"><xs:annotation><xs:documentation>The minimum modification date and time of the file. Formatted as

YYYY-MM-DDTHH:mm:ss, where YYYY is the year, MM is month, DD is day, 'T' is literal, HH is hour, mm isminute and ss is second.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MaxDate" type="xs:dateTime"><xs:annotation><xs:documentation>The maximum modification date and time of the file. Formatted as

YYYY-MM-DDTHH:mm:ss, where YYYY is the year, MM is month, DD is day, 'T' is literal, HH is hour, mm isminute and ss is second.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Languages" type="xs:string"><xs:annotation><xs:documentation>The languages supported by the file.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

206

Page 207: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FileSearchRef

Description

References an existing FileSearch element.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Specify the Id to the FileSearch toreference.

Content Model

Always empty.

Referenced By

● Element ComponentSearch

● Element DirectorySearch

● Element DirectorySearchRef

● Element IniFileSearch

● Element RegistrySearch

Definition

<xs:element name="FileSearchRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="FileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">If you intend to use a FileSearchRef to reference a

FileSearch but they have different parent elements, you must use a FileSearch instead of a FileSearchRef. Thisis because the DrLocator table in an installer package is keyed on the Id, Parent, and Path. A file is associatedwith its parent directory in the DrLocator table. When a FileSearch and a FileSearchRef element are underdifferent parent elements, the Parent will automatically be different so a FileSearchRef will not have aFileSearch to reference.</html:p>

</xse:remarks></xs:appinfo><xs:documentation>References an existing FileSearch element.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Specify the Id to the FileSearch to reference.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

207

Page 208: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FileTypeMask

Description

FileType data for class Id registration.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Offset integer Yes Offset into file. If positive, offset isfrom the beginning; if negative, offsetis from the end.

Mask HexType Yes Hex value that is AND'd against thebytes in the file at Offset.

Value HexType Yes If the result of the AND'ing of Maskwith the bytes in the file is Value, thefile is a match for this File Type.

Content Model

Always empty.

Referenced By

● Element Class

Definition

<xs:element name="FileTypeMask"><xs:annotation><xs:documentation>FileType data for class Id registration.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Offset" type="xs:integer" use="required"><xs:annotation><xs:documentation>Offset into file. If positive, offset is from the beginning; if negative, offset is from the

end.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Mask" type="HexType" use="required"><xs:annotation><xs:documentation>Hex value that is AND'd against the bytes in the file at Offset.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="HexType" use="required"><xs:annotation><xs:documentation>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.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

208

Page 209: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: FindRelatedProducts

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 Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

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

Definition

<xs:element name="FindRelatedProducts" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="Upgrade" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="FindRelatedProducts" href="http://msdn.microsoft.com/library/aa368600.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Runs through each record of the Upgrade table in sequence and compares the upgrade

209

Page 210: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

code, product version, and language in each row to products installed on the system. WhenFindRelatedProducts detects a correspondence between the upgrade information and an installed product, itappends the product code to the property specified in the ActionProperty column of the UpgradeTable. TheFindRelatedProducts action only runs the first time the product is installed. The FindRelatedProducts actiondoes not run during maintenance mode or uninstallation. FindRelatedProducts should be authored into theInstallUISequence table and InstallExecuteSequence tables. The installer prevents FindRelated Products fromrunning in InstallExecuteSequence if the action has already run in InstallUISequence. TheFindRelatedProducts action must come before the MigrateFeatureStates action and theRemoveExistingProducts action. The condition for this action may be specified in the element's innertext.</xs:documentation></xs:annotation>

</xs:element>

210

Page 211: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ForceReboot

Description

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

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="ForceReboot" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="ForceReboot" href="http://msdn.microsoft.com/library/aa368607.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Prompts the user for a restart of the system during the installation. Special actions don't

have a built-in sequence number and thus must appear relative to another action. The suggested way to dothis is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appearanywhere between InstallInitialize and InstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

211

Page 212: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Fragment

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Optional identifier for a Fragment.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

AppId anyType (restriction) 1..1 Application ID containing DCOM information forthe associated application GUID.

Binary anyType (restriction) 1..1 Binary data used for CustomAction elementsand UI controls.

ComplianceCheck anyType (restriction) 1..1 Adds a row to the CCPSearch table.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroup anyType (restriction) 1..1 Groups together multiple components to beused in other locations.

Condition string (extension) 1..1 Conditions for components, controls, features,and products.

CustomAction string (extension) 1..1 Specifies a custom action to be added to theMSI CustomAction table.

CustomActionRef anyType (restriction) 1..1 This will cause the entire contents of theFragment containing the referencedCustomAction to be included in the installerdatabase.

CustomTable anyType (restriction) 1..1 Defines a custom table for use from a customaction.

Directory anyType (restriction) 1..1 Directory layout for the product.

DirectoryRef anyType (restriction) 1..1 Create a reference to a Directory element inanother Fragment.

EmbeddedChainer string (extension) 1..1

EmbeddedChainerRef

anyType (restriction) 1..1 Reference to an EmbeddedChainer element.

EnsureTable anyType (restriction) 1..1 Use this element to ensure that a table appearsin the installer database, even if its empty.

212

Page 213: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

Feature anyType (restriction) 1..1 A feature for the Feature table.

FeatureGroup anyType (restriction) 1..1 Groups together multiple components,features, and merges to be used in otherlocations.

FeatureRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Icon anyType (restriction) 1..1 Icon used for Shortcut, ProgId, or Classelements (but not UI controls)

IgnoreModularization

anyType (restriction) 1..1 This element has been deprecated.

Media anyType (restriction) 1..1 Media element describes a disk that makes upthe source media for the installation.

PatchCertificates anyType (restriction) 1..1 Identifies the possible signer certificates usedto digitally sign patches.

PatchFamily anyType (restriction) 1..1 Collection of items that should be kept from thedifferences between two products.

Property anyType (restriction) 1..1 Property value for a Product or Module.

PropertyRef anyType (restriction) 1..1 Reference to a Property value.

1..1

InstallExecuteSequence

anyType (restriction) 0..1

InstallUISequence anyType (restriction) 0..1

AdminExecuteSequence

anyType (restriction) 0..1

AdminUISequence

anyType (restriction) 0..1

AdvertiseExecuteSequence

anyType (restriction) 0..1

SetDirectory string (extension) 1..1 Sets a Directory to a particular value.

SetProperty string (extension) 1..1 Sets a Property to a particular value.

SFPCatalog anyType (restriction) 1..1 Adds a system file protection update catalogfile

UI anyType (restriction) 1..1 Enclosing element to compartmentalize UIspecifications.

UIRef anyType (restriction) 1..1 Reference to a UI element. This will force theentire referenced Fragment's contents to beincluded in the installer database.

Upgrade anyType (restriction) 1..1 Upgrade info for a particular UpgradeCode

WixVariable anyType (restriction) 1..1 This element exposes advanced WiXfunctionality.

Remarks

Once defined, the Fragment becomes an immutable, atomic unit which can either be completely included orexcluded from a product. The contents of a Fragment element can be linked into a product by utilizing one of

213

Page 214: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Remarks

the many *Ref elements. When linking in a Fragment, it will be necessary to link in all of its individual units. Forinstance, if a given Fragment contains two Component elements, you must link both under features usingComponentRef for each linked Component. Otherwise, you will get a linker warning and have a floatingComponent that does not appear under any Feature.

Definition

<xs:element name="Fragment"><xs:annotation><xs:documentation>

The Fragment element is the building block of creating an installer database in WiX. Once defined,the Fragment becomes an immutable, atomic unit which can either be completely included or

excludedfrom a product. The contents of a Fragment element can be linked into a product by utilizing oneof the many *Ref elements. When linking in a Fragment, it will be necessary to link in all of itsindividual units. For instance, if a given Fragment contains two Component elements, you must linkboth under features using ComponentRef for each linked Component. Otherwise, you will get a linkerwarning and have a floating Component that does not appear under any Feature.

</xs:documentation></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="AppId" /><xs:element ref="Binary" /><xs:element ref="ComplianceCheck" /><xs:element ref="Component" /><xs:element ref="ComponentGroup" /><xs:element ref="Condition" /><xs:element ref="CustomAction" /><xs:element ref="CustomActionRef" /><xs:element ref="CustomTable" /><xs:element ref="Directory" /><xs:element ref="DirectoryRef" /><xs:element ref="EmbeddedChainer" /><xs:element ref="EmbeddedChainerRef" /><xs:element ref="EnsureTable" /><xs:element ref="Feature" /><xs:element ref="FeatureGroup" /><xs:element ref="FeatureRef" /><xs:element ref="Icon" /><xs:element ref="IgnoreModularization" /><xs:element ref="Media" /><xs:element ref="PatchCertificates" /><xs:element ref="PatchFamily" /><xs:element ref="Property" /><xs:element ref="PropertyRef" /><xs:element ref="SetDirectory" /><xs:element ref="SetProperty" /><xs:element ref="SFPCatalog" /><xs:element ref="UI" /><xs:element ref="UIRef" /><xs:element ref="Upgrade" /><xs:element ref="WixVariable" /><xs:sequence><xs:element ref="InstallExecuteSequence" minOccurs="0" /><xs:element ref="InstallUISequence" minOccurs="0" /><xs:element ref="AdminExecuteSequence" minOccurs="0" /><xs:element ref="AdminUISequence" minOccurs="0" /><xs:element ref="AdvertiseExecuteSequence" minOccurs="0" />

214

Page 215: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:sequence><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

Optional identifier for a Fragment. Should only be set by advanced users to tag sections.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

215

Page 216: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Icon

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The Id cannot by longer than 55characters.

SourceFile string No Path to the icon file.

src string No

Content Model

Always empty.

Referenced By

● Element Fragment

● Element Shortcut

Definition

<xs:element name="Icon"><xs:annotation><xs:documentation>

Icon used for Shortcut, ProgId, or Class elements (but not UI controls)</xs:documentation>

<xs:appinfo><xse:msiRef table="Icon" href="http://msdn.microsoft.com/library/aa369210.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="configure_arp_appearance.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Set your installer's icon inAdd/Remove Programs</xse:howtoRef>

<xse:howtoRef href="create_start_menu_shortcut.htm"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Create a shortcut on theStart Menu</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The Id cannot by longer than 55 characters. In order to prevent errors in cases where

the Id is modularized, it should not be longer than 18 characters.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Path to the icon file.</xs:documentation>

</xs:annotation></xs:attribute>

216

Page 217: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

217

Page 218: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IconRef

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the Icon element toreference.

Content Model

Always empty.

Definition

<xs:element name="IconRef"><xs:annotation><xs:documentation>Used only for PatchFamilies to include only a icon table entry in a

patch.</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the Icon element to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

218

Page 219: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IgnoreModularization

Description

This element has been deprecated.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Name string Yes The name of the item to ignoremodularization for.

Type NMTOKEN(restriction)

No The type of the item to ignoremodularization for.

Content Model

Always empty.

Referenced By

● Element Fragment

Remarks

Use the Binary/@SuppressModularization, CustomAction/@SuppressModularization, orProperty/@SuppressModularization attributes instead.

Definition

<xs:element name="IgnoreModularization"><xs:annotation><xs:documentation>

This element has been deprecated.Use the Binary/@SuppressModularization, CustomAction/@SuppressModularization, or

Property/@SuppressModularization attributes instead.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Name" use="required" type="xs:string"><xs:annotation><xs:documentation>

The name of the item to ignore modularization for.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Type"><xs:annotation><xs:documentation>

The type of the item to ignore modularization for.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN">

219

Page 220: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:enumeration value="Action" /><xs:enumeration value="Property" /><xs:enumeration value="Directory" />

</xs:restriction></xs:simpleType>

</xs:attribute></xs:complexType>

</xs:element>

220

Page 221: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IgnoreRange

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Offset int Yes Offset of the start of the range.

Length int Yes Length of the range.

Content Model

Always empty.

Definition

<xs:element name="IgnoreRange"><xs:annotation><xs:documentation>Specifies part of a file that is to be ignored during patching.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Offset" type="xs:int" use="required"><xs:annotation><xs:documentation>Offset of the start of the range.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Length" type="xs:int" use="required"><xs:annotation><xs:documentation>Length of the range.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

221

Page 222: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IgnoreTable

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The name of the table in the mergemodule that is not to be merged intothe .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 thereforecontain data that is unneeded after the merge. To minimize the size of the .msm file, it is recommended thatdevelopers remove unused tables from modules intended for redistribution rather than creating IgnoreTableelements for those tables.

Definition

<xs:element name="IgnoreTable"><xs:annotation><xs:documentation>

Specifies a table from the merge module that is not merged into an .msi file.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 removeunused tables from modules intended for redistribution rather than creatingIgnoreTable elements for those tables.

</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>

The name of the table in the merge module that is not to be merged into the .msi file.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

222

Page 223: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Include

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 Occurs Description

0..*

any 1..1 Allow any element from the ##any namespace.

Definition

<xs:element name="Include"><xs:annotation><xs:documentation>

This is the top-level container element for every wxi file.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:any namespace="##any" processContents="lax" />

</xs:choice></xs:complexType>

</xs:element>

223

Page 224: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IniFile

Description

Adds or removes .ini file entries.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for ini file.

Action NMTOKEN(restriction)

Yes The type of modification to be made.

Directory string No Name of a property, the value ofwhich is the full path of the foldercontaining the .ini file.

Key string Yes The localizable .ini file key within thesection.

LongName LongFileNameType

No

Name LongFileNameType

Yes In prior versions of the WiX toolset,this attribute specified the shortname. This attribute's value may nowbe either a short or long name.

Section string Yes The localizable .ini file section.

ShortName ShortFileNameType

No The short name of the in 8.3 format.

Value string No The localizable value to be written ordeleted. This attribute must be set ifthe Action attribute's value is"addLine", "addTag", or "createLine".

Content Model

Always empty.

Referenced By

● Element Component

Definition

<xs:element name="IniFile"><xs:annotation><xs:documentation>

Adds or removes .ini file entries.</xs:documentation>

<xs:appinfo><xse:msiRef table="IniFile" href="http://msdn.microsoft.com/library/aa369282.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RemoveIniFile" href="http://msdn.microsoft.com/library/aa371204.aspx"

224

Page 225: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Identifier for ini file.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Action" use="required"><xs:annotation><xs:documentation>The type of modification to be made.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="addLine"><xs:annotation><xs:documentation>Creates or updates an .ini entry.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="addTag"><xs:annotation><xs:documentation>Creates a new entry or appends a new comma-separated value to an existing

entry.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="createLine"><xs:annotation><xs:documentation>Creates an .ini entry only if the entry does no already exist.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="removeLine"><xs:annotation><xs:documentation>Removes an .ini entry.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="removeTag"><xs:annotation><xs:documentation>Removes a tag from an .ini entry.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>Name of a property, the value of which is the full path of the folder containing the .ini

file. Can be name of a directory in the Directory table, a property set by the AppSearch table, or any otherproperty representing a full path.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Key" use="required" type="xs:string"><xs:annotation><xs:documentation>The localizable .ini file key within the section.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LongName" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

225

Page 226: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="LongFileNameType" use="required"><xs:annotation><xs:documentation>

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.If a short name is specified, the ShortName attribute may not be specified.If a long name is specified, the LongName attribute may not be specified.Also, if this value is a long name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short name.However, if this name collides with another file or you wish to manually specifythe short name, then the ShortName attribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Section" use="required" type="xs:string"><xs:annotation><xs:documentation>The localizable .ini file section.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ShortName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short name of the in 8.3 format.This attribute should only be set if there is a conflict between generated short namesor the user wants to manually specify the short name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

The localizable value to be written or deleted. This attribute must be set ifthe Action attribute's value is "addLine", "addTag", or "createLine".

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

226

Page 227: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IniFileSearch

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes External key into the Signature table.

Field integer No The field in the .ini line. If field is Nullor 0, the entire line is read.

Key string Yes The key value within the section.

LongName LongFileNameType

No

Name LongFileNameType

Yes In prior versions of the WiX toolset,this attribute specified the shortname. This attribute's value may nowbe either a short or long name.

Section string Yes The localizable .ini file section.

ShortName ShortFileNameType

No The short name of the file in 8.3format.

Type NMTOKEN(restriction)

No Must be file if last child is FileSearchelement and must be directory if lastchild is DirectorySearch element.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

DirectorySearch anyType (restriction) 1..1 Searches for directory and assigns to value ofparent Property.

DirectorySearchRef anyType (restriction) 1..1 References an existing DirectorySearchelement.

FileSearch anyType (restriction) 1..1 Searches for file and assigns to fullpath valueof parent Property

FileSearchRef anyType (restriction) 1..1 References an existing FileSearch element.

Definition

<xs:element name="IniFileSearch"><xs:annotation><xs:appinfo><xse:seeAlso ref="ComponentSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

227

Page 228: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:seeAlso ref="RegistrySearch"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:msiRef table="IniLocator" href="http://msdn.microsoft.com/library/aa369283.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo><xs:documentation>Searches for file, directory or registry key and assigns to value of parent

Property</xs:documentation></xs:annotation><xs:complexType><xs:choice minOccurs="0"><xs:element ref="DirectorySearch" /><xs:element ref="DirectorySearchRef" /><xs:element ref="FileSearch" /><xs:element ref="FileSearchRef" />

</xs:choice><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>External key into the Signature table.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Field" type="xs:integer"><xs:annotation><xs:documentation>The field in the .ini line. If field is Null or 0, the entire line is read.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Key" use="required" type="xs:string"><xs:annotation><xs:documentation>The key value within the section.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LongName" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="LongFileNameType" use="required"><xs:annotation><xs:documentation>

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.If a short name is specified, the ShortName attribute may not be specified.If a long name is specified, the LongName attribute may not be specified.Also, if this value is a long name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short name.However, if you wish to manually specify the short name, then the ShortNameattribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Section" use="required" type="xs:string"><xs:annotation><xs:documentation>The localizable .ini file section.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ShortName" type="ShortFileNameType">

228

Page 229: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>

The short name of the file in 8.3 format.This attribute should only be set if the user wants to manually specify the short name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Type"><xs:annotation><xs:documentation>Must be file if last child is FileSearch element and must be directory if last child is

DirectorySearch element.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="directory"><xs:annotation><xs:documentation>A directory location.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="file"><xs:annotation><xs:documentation>A file location. This is the default value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="raw"><xs:annotation><xs:documentation>A raw .ini value.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute></xs:complexType>

</xs:element>

229

Page 230: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallAdminPackage

Description

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

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

Definition

<xs:element name="InstallAdminPackage" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallAdminPackage" href="http://msdn.microsoft.com/library/aa369287.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Copies the product database to the administrative installation point. The condition for

this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

230

Page 231: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallExecute

Description

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

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallExecute" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallExecute" href="http://msdn.microsoft.com/library/aa369502.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Runs a script containing all operations spooled since either the start of the installation or

the last InstallExecute action, or InstallExecuteAgain action. Special actions don't have a built-in sequencenumber and thus must appear relative to another action. The suggested way to do this is by using the Beforeor After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere betweenInstallInitialize and InstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

231

Page 232: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallExecuteAgain

Description

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

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

Should only be used after InstallExecute. Special actions don't have a built-in sequence number and thus mustappear 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 andInstallFinalize.

Definition

<xs:element name="InstallExecuteAgain" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallExecuteAgain" href="http://msdn.microsoft.com/library/aa369497.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Runs a script containing all operations spooled since either the start of the installation or

the last InstallExecute action, or InstallExecuteAgain action. Should only be used after InstallExecute. Specialactions don't have a built-in sequence number and thus must appear relative to another action. The suggestedway to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionallyappear anywhere between InstallInitialize and InstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

232

Page 233: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallExecuteSequence

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

AllocateRegistrySpace

ActionSequenceType 0..1 Ensures the needed amount of space exists inthe registry.

AppSearch ActionModuleSequenceType

0..1 Uses file signatures to search for existingversions of products.

BindImage ActionSequenceType 0..1 Binds each executable or DLL that must bebound to the DLLs imported by it.

CCPSearch ActionModuleSequenceType

1..1 Uses file signatures to validate that qualifyingproducts are installed on a system before anupgrade installation is performed.

CostFinalize ActionSequenceType 1..1 Ends the internal installation costing processbegun by the CostInitialize action.

CostInitialize ActionSequenceType 1..1 Initiates the internal installation costingprocess.

CreateFolders ActionSequenceType 0..1 Creates empty folders for components that areset to be installed.

CreateShortcuts ActionSequenceType 0..1 Manages the creation of shortcuts.

Custom string (extension) 0..* Use to sequence a custom action.

DeleteServices ActionSequenceType 1..1 Stops a service and removes its registrationfrom the system.

DisableRollback ActionModuleSequenceType

0..1 Disables rollback for the remainder of theinstallation.

DuplicateFiles ActionSequenceType 1..1 Duplicates files installed by the InstallFilesaction.

FileCost ActionSequenceType 1..1 Initiates dynamic costing of standardinstallation actions.

FindRelatedProducts

ActionModuleSequenceType

0..1 Runs through each record of the Upgrade tablein sequence and compares the upgrade code,product version, and language in each row toproducts installed on the system.

ForceReboot ActionModuleSequenceType

0..1 Prompts the user for a restart of the systemduring the installation.

InstallExecute ActionModuleSequenceType

0..1 Runs a script containing all operations spooledsince either the start of the installation or thelast InstallExecute action, orInstallExecuteAgain action.

233

Page 234: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

InstallExecuteAgain ActionModuleSequenceType

0..1 Runs a script containing all operations spooledsince either the start of the installation or thelast InstallExecute action, orInstallExecuteAgain action.

InstallFiles ActionSequenceType 0..1 Copies files specified in the File table from thesource directory to the destination directory.

InstallFinalize ActionSequenceType 1..1 Marks the end of a sequence of actions thatchange the system.

InstallInitialize ActionSequenceType 1..1 Marks the beginning of a sequence of actionsthat change the system.

InstallODBC ActionSequenceType 1..1 Installs the drivers, translators, and datasources in the ODBCDriver table,ODBCTranslator table, and ODBCDataSourcetable.

InstallServices ActionSequenceType 1..1 Registers a service for the system.

InstallValidate ActionSequenceType 1..1 Verifies that all costed volumes have enoughspace for the installation.

IsolateComponents ActionSequenceType 1..1 Installs a copy of a component (commonly ashared DLL) into a private location for use by aspecific application (typically an .exe).

LaunchConditions ActionModuleSequenceType

0..1 Queries the LaunchCondition table andevaluates each conditional statement recordedthere.

MigrateFeatureStates

ActionSequenceType 1..1 Used for upgrading or installing over anexisting application.

MoveFiles ActionSequenceType 1..1 Locates existing files on the system and movesor copies those files to a new location.

MsiPublishAssemblies

ActionSequenceType 1..1 Manages the advertisement of CLR and Win32assemblies.

MsiUnpublishAssemblies

ActionSequenceType 1..1 Manages the unadvertisement of CLR andWin32 assemblies that are being removed.

PatchFiles ActionSequenceType 1..1 Queries the Patch table to determine whichpatches are to be applied.

ProcessComponents

ActionSequenceType 1..1 Registers and unregisters components, theirkey paths, and the component clients.

PublishComponents ActionSequenceType 0..1 Manages the advertisement of the componentsfrom the PublishComponent table.

PublishFeatures ActionSequenceType 0..1 Writes each feature's state into the systemregistry.

PublishProduct ActionSequenceType 0..1 Manages the advertisement of the productinformation with the system.

RegisterClassInfo ActionSequenceType 0..1 Manages the registration of COM classinformation with the system.

RegisterComPlus ActionSequenceType 1..1 Registers COM+ applications.

RegisterExtensionInfo

ActionSequenceType 1..1 Manages the registration of extension relatedinformation with the system.

234

Page 235: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

RegisterFonts ActionSequenceType 1..1 Registers installed fonts with the system.

RegisterMIMEInfo ActionSequenceType 1..1 Registers MIME-related registry informationwith the system.

RegisterProduct ActionSequenceType 0..1 Registers the product information with theinstaller.

RegisterProgIdInfo ActionSequenceType 0..1 Manages the registration of OLE ProgIdinformation with the system.

RegisterTypeLibraries

ActionSequenceType 0..1 Registers type libraries with the system.

RegisterUser ActionSequenceType 0..1 Registers the user information with the installerto identify the user of a product.

RemoveDuplicateFiles

ActionSequenceType 1..1 Deletes files installed by the DuplicateFilesaction.

RemoveEnvironmentStrings

ActionSequenceType 1..1 Modifies the values of environment variables.

RemoveExistingProducts

ActionModuleSequenceType

1..1 Goes through the product codes listed in theActionProperty column of the Upgrade tableand removes the products in sequence.

RemoveFiles ActionSequenceType 0..1 Removes files previously installed by theInstallFiles action.

RemoveFolders ActionSequenceType 0..1 Removes any folders linked to components setto be removed or run from source.

RemoveIniValues ActionSequenceType 1..1 Removes .ini file information specified forremoval in the RemoveIniFile table if thecomponent is set to be installed locally or runfrom source.

RemoveODBC ActionSequenceType 1..1 Removes the data sources, translators, anddrivers listed for removal during the installation.

RemoveRegistryValues

ActionSequenceType 0..1 Removes a registry value that has beenauthored into the registry table if the associatedcomponent was installed locally or as run fromsource, and is now set to be uninstalled.

RemoveShortcuts ActionSequenceType 0..1 Manages the removal of an advertised shortcutwhose feature is selected for uninstallation or anonadvertised shortcut whose component isselected for uninstallation.

ResolveSource ActionModuleSequenceType

0..1 Determines the location of the source and setsthe SourceDir property if the source has notbeen resolved yet.

RMCCPSearch ActionModuleSequenceType

1..1 Uses file signatures to validate that qualifyingproducts are installed on a system before anupgrade installation is performed.

ScheduleReboot ActionModuleSequenceType

0..1 Prompts the user to restart the system at theend of installation.

SelfRegModules ActionSequenceType 0..1 Processes all modules listed in the SelfRegtable and registers all installed modules withthe system.

235

Page 236: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

SelfUnregModules ActionSequenceType 0..1 Unregisters all modules listed in the SelfRegtable that are scheduled to be uninstalled.

SetODBCFolders ActionSequenceType 1..1 Checks for existing ODBC drivers and sets thetarget directory for each new driver to thelocation of an existing driver.

StartServices ActionSequenceType 1..1 Starts system services.

StopServices ActionSequenceType 1..1 Stops system services.

UnpublishComponents

ActionSequenceType 0..1 Manages the unadvertisement of componentslisted in the PublishComponent table.

UnpublishFeatures ActionSequenceType 0..1 Removes selection-state andfeature-component mapping information fromthe registry.

UnregisterClassInfo ActionSequenceType 0..1 Manages the removal of COM classinformation from the system registry.

UnregisterComPlus ActionSequenceType 1..1 Removes COM+ applications from the registry.

UnregisterExtensionInfo

ActionSequenceType 1..1 Manages the removal of extension-relatedinformation from the system registry.

UnregisterFonts ActionSequenceType 1..1 Removes registration information aboutinstalled fonts from the system.

UnregisterMIMEInfo ActionSequenceType 1..1 Unregisters MIME-related registry informationfrom the system.

UnregisterProgIdInfo

ActionSequenceType 0..1 Manages the unregistration of OLE ProgIdinformation with the system.

UnregisterTypeLibraries

ActionSequenceType 0..1 Unregisters type libraries from the system.

ValidateProductID ActionSequenceType 1..1 Sets the ProductID property to the full productidentifier.

WriteEnvironmentStrings

ActionSequenceType 1..1 Modifies the values of environment variables.

WriteIniValues ActionSequenceType 1..1 Writes the .ini file information that theapplication needs written to its .ini files.

WriteRegistryValues ActionSequenceType 0..1 Sets up an application's registry information.

Definition

<xs:element name="InstallExecuteSequence"><xs:annotation><xs:appinfo><xse:msiRef table="InstallExecuteSequence" href="http://msdn.microsoft.com/library/aa369500.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><!-- used only to supply default op for child action elements --><xs:element ref="Custom" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Use to sequence a custom action.</xs:documentation>

236

Page 237: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:element><xs:element ref="ScheduleReboot" minOccurs="0"><xs:annotation><xs:documentation>Prompts the user to restart the system at the end of installation. Not fixed

sequence.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ForceReboot" minOccurs="0"><xs:annotation><xs:documentation>Prompts the user for a restart of the system during the installation. Not fixed

sequence.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ResolveSource" minOccurs="0"><xs:annotation><xs:documentation>Determines the location of the source and sets the SourceDir property if the source

has not been resolved yet. Not fixed sequence.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="LaunchConditions" minOccurs="0"><xs:annotation><xs:documentation>Queries the LaunchCondition table and evaluates each conditional statement

recorded there.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="FindRelatedProducts" minOccurs="0"><xs:annotation><xs:documentation>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 thesystem.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="AppSearch" minOccurs="0"><xs:annotation><xs:documentation>Uses file signatures to search for existing versions of products.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CCPSearch"><xs:annotation><xs:documentation>Uses file signatures to validate that qualifying products are installed on a system

before an upgrade installation is performed.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RMCCPSearch"><xs:annotation><xs:documentation>Uses file signatures to validate that qualifying products are installed on a system

before an upgrade installation is performed.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ValidateProductID"><xs:annotation><xs:documentation>Sets the ProductID property to the full product identifier.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CostInitialize"><xs:annotation><xs:documentation>Initiates the internal installation costing process.</xs:documentation>

</xs:annotation></xs:element>

237

Page 238: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="FileCost"><xs:annotation><xs:documentation>Initiates dynamic costing of standard installation actions.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="IsolateComponents"><xs:annotation><xs:documentation>Installs a copy of a component (commonly a shared DLL) into a private location for

use by a specific application (typically an .exe).</xs:documentation></xs:annotation>

</xs:element><xs:element ref="CostFinalize"><xs:annotation><xs:documentation>Ends the internal installation costing process begun by the CostInitialize

action.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="SetODBCFolders"><xs:annotation><xs:documentation>Checks for existing ODBC drivers and sets the target directory for each new driver to

the location of an existing driver.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="MigrateFeatureStates"><xs:annotation><xs:documentation>Used for upgrading or installing over an existing application.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="InstallValidate"><xs:annotation><xs:documentation>Verifies that all costed volumes have enough space for the

installation.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallInitialize"><xs:annotation><xs:documentation>Marks the beginning of a sequence of actions that change the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="AllocateRegistrySpace" minOccurs="0"><xs:annotation><xs:documentation>Ensures the needed amount of space exists in the registry.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ProcessComponents"><xs:annotation><xs:documentation>Registers and unregisters components, their key paths, and the component

clients.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="UnpublishComponents" minOccurs="0"><xs:annotation><xs:documentation>Manages the unadvertisement of components listed in the PublishComponent

table.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="UnpublishFeatures" minOccurs="0"><xs:annotation><xs:documentation>Removes selection-state and feature-component mapping information from the

238

Page 239: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

registry.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="StopServices"><xs:annotation><xs:documentation>Stops system services.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="DeleteServices"><xs:annotation><xs:documentation>Stops a service and removes its registration from the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="UnregisterComPlus"><xs:annotation><xs:documentation>Removes COM+ applications from the registry.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="SelfUnregModules" minOccurs="0"><xs:annotation><xs:documentation>Unregisters all modules listed in the SelfReg table that are scheduled to be

uninstalled.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="UnregisterTypeLibraries" minOccurs="0"><xs:annotation><xs:documentation>Unregisters type libraries from the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RemoveODBC"><xs:annotation><xs:documentation>Removes the data sources, translators, and drivers listed for removal during the

installation.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="UnregisterFonts"><xs:annotation><xs:documentation>Removes registration information about installed fonts from the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RemoveRegistryValues" minOccurs="0"><xs:annotation><xs:documentation>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 beuninstalled.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="UnregisterClassInfo" minOccurs="0"><xs:annotation><xs:documentation>Manages the removal of COM class information from the system

registry.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="UnregisterExtensionInfo"><xs:annotation><xs:documentation>Manages the removal of extension-related information from the system

registry.</xs:documentation></xs:annotation>

</xs:element>

239

Page 240: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="UnregisterProgIdInfo" minOccurs="0"><xs:annotation><xs:documentation>Manages the unregistration of OLE ProgId information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="UnregisterMIMEInfo"><xs:annotation><xs:documentation>Unregisters MIME-related registry information from the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RemoveIniValues"><xs:annotation><xs:documentation>Removes .ini file information specified for removal in the RemoveIniFile table if the

component is set to be installed locally or run from source.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RemoveShortcuts" minOccurs="0"><xs:annotation><xs:documentation>Manages the removal of an advertised shortcut whose feature is selected for

uninstallation or a nonadvertised shortcut whose component is selected for uninstallation.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RemoveEnvironmentStrings"><xs:annotation><xs:documentation>Modifies the values of environment variables.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RemoveDuplicateFiles"><xs:annotation><xs:documentation>Deletes files installed by the DuplicateFiles action.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RemoveFiles" minOccurs="0"><xs:annotation><xs:documentation>Removes files previously installed by the InstallFiles action.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RemoveFolders" minOccurs="0"><xs:annotation><xs:documentation>Removes any folders linked to components set to be removed or run from

source.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="CreateFolders" minOccurs="0"><xs:annotation><xs:documentation>Creates empty folders for components that are set to be

installed.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="MoveFiles"><xs:annotation><xs:documentation>Locates existing files on the system and moves or copies those files to a new

location.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFiles" minOccurs="0"><xs:annotation><xs:documentation>Copies files specified in the File table from the source directory to the destination

directory.</xs:documentation>

240

Page 241: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:element><xs:element ref="DuplicateFiles"><xs:annotation><xs:documentation>Duplicates files installed by the InstallFiles action.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="PatchFiles"><xs:annotation><xs:documentation>Queries the Patch table to determine which patches are to be

applied.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="BindImage" minOccurs="0"><xs:annotation><xs:documentation>Binds each executable or DLL that must be bound to the DLLs imported by

it.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="CreateShortcuts" minOccurs="0"><xs:annotation><xs:documentation>Manages the creation of shortcuts.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RegisterClassInfo" minOccurs="0"><xs:annotation><xs:documentation>Manages the registration of COM class information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterExtensionInfo"><xs:annotation><xs:documentation>Manages the registration of extension related information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterProgIdInfo" minOccurs="0"><xs:annotation><xs:documentation>Manages the registration of OLE ProgId information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterMIMEInfo"><xs:annotation><xs:documentation>Registers MIME-related registry information with the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="WriteRegistryValues" minOccurs="0"><xs:annotation><xs:documentation>Sets up an application's registry information.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="WriteIniValues"><xs:annotation><xs:documentation>Writes the .ini file information that the application needs written to its .ini

files.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="WriteEnvironmentStrings"><xs:annotation>

241

Page 242: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Modifies the values of environment variables.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterFonts"><xs:annotation><xs:documentation>Registers installed fonts with the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="InstallODBC"><xs:annotation><xs:documentation>Installs the drivers, translators, and data sources in the ODBCDriver table,

ODBCTranslator table, and ODBCDataSource table.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterTypeLibraries" minOccurs="0"><xs:annotation><xs:documentation>Registers type libraries with the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="SelfRegModules" minOccurs="0"><xs:annotation><xs:documentation>Processes all modules listed in the SelfReg table and registers all installed modules

with the system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterComPlus"><xs:annotation><xs:documentation>Registers COM+ applications.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="InstallServices"><xs:annotation><xs:documentation>Registers a service for the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="StartServices"><xs:annotation><xs:documentation>Starts system services.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RegisterUser" minOccurs="0"><xs:annotation><xs:documentation>Registers the user information with the installer to identify the user of a

product.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RegisterProduct" minOccurs="0"><xs:annotation><xs:documentation>Registers the product information with the installer.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="PublishComponents" minOccurs="0"><xs:annotation><xs:documentation>Manages the advertisement of the components from the PublishComponent

table.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="PublishFeatures" minOccurs="0"><xs:annotation><xs:documentation>Writes each feature's state into the system registry.</xs:documentation>

242

Page 243: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:element><xs:element ref="PublishProduct" minOccurs="0"><xs:annotation><xs:documentation>Manages the advertisement of the product information with the

system.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallFinalize"><xs:annotation><xs:documentation>Marks the end of a sequence of actions that change the system.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="RemoveExistingProducts"><xs:annotation><xs:documentation>Goes through the product codes listed in the ActionProperty column of the Upgrade

table and removes the products in sequence.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="DisableRollback" minOccurs="0"><xs:annotation><xs:documentation>Disables rollback for the remainder of the installation.</xs:documentation>

</xs:annotation></xs:element><!-- InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and

InstallFinalize --><xs:element ref="InstallExecute" minOccurs="0"><xs:annotation><xs:documentation>Runs a script containing all operations spooled since either the start of the

installation or the last InstallExecute action, or InstallExecuteAgain action.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="InstallExecuteAgain" minOccurs="0"><xs:annotation><xs:documentation>Runs a script containing all operations spooled since either the start of the

installation or the last InstallExecute action, or InstallExecuteAgain action.</xs:documentation></xs:annotation>

</xs:element><!-- Windows Installer 1.5 actions --><xs:element ref="MsiPublishAssemblies"><xs:annotation><xs:documentation>Manages the advertisement of CLR and Win32 assemblies.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="MsiUnpublishAssemblies"><xs:annotation><xs:documentation>Manages the unadvertisement of CLR and Win32 assemblies that are being

removed.</xs:documentation></xs:annotation>

</xs:element></xs:choice>

</xs:complexType></xs:element>

243

Page 244: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallFiles

Description

Copies files specified in the File table from the source directory to the destination directory.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallFiles" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallFiles" href="http://msdn.microsoft.com/library/aa369503.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Copies files specified in the File table from the source directory to the destination

directory. The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

244

Page 245: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallFinalize

Description

Marks the end of a sequence of actions that change the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallFinalize" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="InstallInitialize"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="InstallFinalize" href="http://msdn.microsoft.com/library/aa369505.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Marks the end of a sequence of actions that change the system. The condition for this

action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

245

Page 246: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallInitialize

Description

Marks the beginning of a sequence of actions that change the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallInitialize" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="InstallFinalize"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="InstallInitialize" href="http://msdn.microsoft.com/library/aa369535.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Marks the beginning of a sequence of actions that change the system. The condition for

this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

246

Page 247: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallODBC

Description

Installs the drivers, translators, and data sources in the ODBCDriver table, ODBCTranslator table, andODBCDataSource table.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallODBC" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallODBC" href="http://msdn.microsoft.com/library/aa369538.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Installs the drivers, translators, and data sources in the ODBCDriver table,

ODBCTranslator table, and ODBCDataSource table. The condition for this action may be specified in theelement's inner text.</xs:documentation></xs:annotation>

</xs:element>

247

Page 248: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallServices

Description

Registers a service for the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallServices" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallServices" href="http://msdn.microsoft.com/library/aa369540.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers a service for the system. The condition for this action may be specified in the

element's inner text.</xs:documentation></xs:annotation>

</xs:element>

248

Page 249: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallUISequence

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

AppSearch ActionModuleSequenceType

0..1 Uses file signatures to search for existingversions of products.

CCPSearch ActionModuleSequenceType

0..1 Uses file signatures to validate that qualifyingproducts are installed on a system before anupgrade installation is performed.

CostFinalize ActionSequenceType 1..1 Ends the internal installation costing processbegun by the CostInitialize action.

CostInitialize ActionSequenceType 1..1 Initiates the internal installation costingprocess.

Custom string (extension) 0..* Use to sequence a custom action.

ExecuteAction ActionSequenceType 0..1 Initiates the execution sequence.

FileCost ActionSequenceType 1..1 Initiates dynamic costing of standardinstallation actions.

FindRelatedProducts

ActionModuleSequenceType

0..1 Runs through each record of the Upgrade tablein sequence and compares the upgrade code,product version, and language in each row toproducts installed on the system.

IsolateComponents ActionSequenceType 1..1 Installs a copy of a component (commonly ashared DLL) into a private location for use by aspecific application (typically an .exe).

LaunchConditions ActionModuleSequenceType

0..1 Queries the LaunchCondition table andevaluates each conditional statement recordedthere.

MigrateFeatureStates

ActionSequenceType 1..1 Used for upgrading or installing over anexisting application.

ResolveSource ActionModuleSequenceType

0..1 Determines the location of the source and setsthe SourceDir property if the source has notbeen resolved yet.

RMCCPSearch ActionModuleSequenceType

0..1 Uses file signatures to validate that qualifyingproducts are installed on a system before anupgrade installation is performed.

ScheduleReboot ActionModuleSequenceType

0..1 Prompts the user to restart the system at theend of installation.

Show string (extension) 0..*

ValidateProductID ActionSequenceType 1..1 Sets the ProductID property to the full productidentifier.

249

Page 250: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element name="InstallUISequence"><xs:annotation><xs:appinfo><xse:msiRef table="InstallUISequence" href="http://msdn.microsoft.com/library/aa369543.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Custom" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Use to sequence a custom action.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="Show" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Displays a Dialog.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ScheduleReboot" minOccurs="0"><xs:annotation><xs:documentation>Prompts the user to restart the system at the end of installation. Not fixed

sequence.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="LaunchConditions" minOccurs="0"><xs:annotation><xs:documentation>Queries the LaunchCondition table and evaluates each conditional statement

recorded there.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="FindRelatedProducts" minOccurs="0"><xs:annotation><xs:documentation>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 thesystem.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="AppSearch" minOccurs="0"><xs:annotation><xs:documentation>Uses file signatures to search for existing versions of products.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="CCPSearch" minOccurs="0"><xs:annotation><xs:documentation>Uses file signatures to validate that qualifying products are installed on a system

before an upgrade installation is performed.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="RMCCPSearch" minOccurs="0"><xs:annotation><xs:documentation>Uses file signatures to validate that qualifying products are installed on a system

before an upgrade installation is performed.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ValidateProductID"><xs:annotation><xs:documentation>Sets the ProductID property to the full product identifier.</xs:documentation>

</xs:annotation></xs:element>

250

Page 251: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="CostInitialize"><xs:annotation><xs:documentation>Initiates the internal installation costing process.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="FileCost"><xs:annotation><xs:documentation>Initiates dynamic costing of standard installation actions.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="IsolateComponents"><xs:annotation><xs:documentation>Installs a copy of a component (commonly a shared DLL) into a private location for

use by a specific application (typically an .exe).</xs:documentation></xs:annotation>

</xs:element><xs:element ref="ResolveSource" minOccurs="0"><xs:annotation><xs:documentation>Determines the location of the source and sets the SourceDir property if the source

has not been resolved yet.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="CostFinalize"><xs:annotation><xs:documentation>Ends the internal installation costing process begun by the CostInitialize

action.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="MigrateFeatureStates"><xs:annotation><xs:documentation>Used for upgrading or installing over an existing application.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ExecuteAction" minOccurs="0"><xs:annotation><xs:documentation>Initiates the execution sequence.</xs:documentation>

</xs:annotation></xs:element>

</xs:choice></xs:complexType>

</xs:element>

251

Page 252: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstallValidate

Description

Verifies that all costed volumes have enough space for the installation.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="InstallValidate" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="InstallValidate" href="http://msdn.microsoft.com/library/aa369546.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Verifies that all costed volumes have enough space for the installation. The condition for

this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

252

Page 253: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Instance

Description

Defines an instance transform for your product.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identity of the instancetransform.

ProductCode string Yes The ProductCode for this instance.

ProductName string No The ProductName for this instance.

Content Model

Always empty.

Referenced By

● Element InstanceTransforms

Definition

<xs:element name="Instance"><xs:annotation><xs:documentation>

Defines an instance transform for your product.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>

The identity of the instance transform. This value will define the name by which the instanceshould be referred to on the command line. In addition, the value of the this attribute willdetermine what the value of the property specified in Property attribute on InstanceTransformswill change to for each instance.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ProductCode" type="xs:string" use="required"><xs:annotation><xs:documentation>The ProductCode for this instance.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ProductName" type="xs:string"><xs:annotation><xs:documentation>The ProductName for this instance.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

253

Page 254: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: InstanceTransforms

Description

Use this element to contain definitions for instance transforms.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Property string Yes The Id of the Property who's valueshould change for each instance.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

Instance anyType (restriction) 1..1 Defines an instance transform for your product.

Definition

<xs:element name="InstanceTransforms"><xs:annotation><xs:documentation>

Use this element to contain definitions for instance transforms.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Instance" />

</xs:choice><xs:attribute name="Property" type="xs:string" use="required"><xs:annotation><xs:documentation>The Id of the Property who's value should change for each

instance.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

254

Page 255: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Interface

Description

COM Interface registration for parent Typelib.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes GUID identifier for COM Interface.

Name string Yes Name for COM Interface.

ProxyStubClassId

Guid No GUID CLSID for proxy stub to COMInterface.

ProxyStubClassId32

Guid No GUID CLSID for 32-bit proxy stub toCOM Interface.

NumMethods integer No Number of methods implemented onCOM Interface.

Versioned YesNoType No Determines whether a Typelibversion entry should be created withthe other COM Interface registrykeys.

Content Model

Always empty.

Referenced By

● Element Class

● Element Component

● Element TypeLib

Definition

<xs:element name="Interface"><xs:annotation><xs:documentation>COM Interface registration for parent Typelib.</xs:documentation><xs:appinfo><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="Guid" use="required"><xs:annotation><xs:documentation>GUID identifier for COM Interface.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Name for COM Interface.</xs:documentation>

255

Page 256: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="ProxyStubClassId" type="Guid"><xs:annotation><xs:documentation>GUID CLSID for proxy stub to COM Interface.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ProxyStubClassId32" type="Guid"><xs:annotation><xs:documentation>GUID CLSID for 32-bit proxy stub to COM Interface.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="NumMethods" type="xs:integer"><xs:annotation><xs:documentation>Number of methods implemented on COM Interface.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Versioned" type="YesNoType"><xs:annotation><xs:documentation>Determines whether a Typelib version entry should be created with the other COM

Interface registry keys. Default is 'yes'.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

256

Page 257: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IsolateComponent

Description

Shared Component to be privately replicated in folder of parent Component

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Shared string Yes Shared Component for thisapplication Component.

Content Model

Always empty.

Referenced By

● Element Component

Definition

<xs:element name="IsolateComponent"><xs:annotation><xs:documentation>

Shared Component to be privately replicated in folder of parent Component</xs:documentation>

<xs:appinfo><xse:msiRef table="IsolateComponent" href="http://msdn.microsoft.com/library/aa369730.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Shared" type="xs:string" use="required"><xs:annotation><xs:documentation>Shared Component for this application Component.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

257

Page 258: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: IsolateComponents

Description

Installs a copy of a component (commonly a shared DLL) into a private location for use by a specific application(typically an .exe).

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

This isolates the application from other copies of the component that may be installed to a shared location onthe computer. The action refers to each record of the IsolatedComponent table and associates the files of thecomponent listed in the Component_Shared field with the component listed in the Component_Application field.The installer installs the files of Component_Shared into the same directory as Component_Application. Theinstaller generates a file in this directory, zero bytes in length, having the short filename name of the key file forComponent_Application (typically this is the same file name as the .exe) appended with .local. TheIsolatedComponent action does not affect the installation of Component_Application. UninstallingComponent_Application also removes the Component_Shared files and the .local file from the directory. TheIsolateComponents action can be used only in the InstallUISequence table and the InstallExecuteSequencetable. This action must come after the CostInitialize action and before the CostFinalize action. The condition forthis action may be specified in the element's inner text.

Definition

<xs:element name="IsolateComponents" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="IsolateComponent"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="IsolateComponents" href="http://msdn.microsoft.com/library/aa369561.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Installs a copy of a component (commonly a shared DLL) into a private location for use

by a specific application (typically an .exe). This isolates the application from other copies of the componentthat may be installed to a shared location on the computer. The action refers to each record of theIsolatedComponent table and associates the files of the component listed in the Component_Shared field withthe component listed in the Component_Application field. The installer installs the files of Component_Sharedinto the same directory as Component_Application. The installer generates a file in this directory, zero bytes in

258

Page 259: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

length, having the short filename name of the key file for Component_Application (typically this is the same filename as the .exe) appended with .local. The IsolatedComponent action does not affect the installation ofComponent_Application. Uninstalling Component_Application also removes the Component_Shared files andthe .local file from the directory. The IsolateComponents action can be used only in the InstallUISequence tableand the InstallExecuteSequence table. This action must come after the CostInitialize action and before theCostFinalize action. The condition for this action may be specified in the element's innertext.</xs:documentation></xs:annotation>

</xs:element>

259

Page 260: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: LaunchConditions

Description

Queries the LaunchCondition table and evaluates each conditional statement recorded there.

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element AdminUISequence

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

If any of these conditional statements fail, an error message is displayed to the user and the installation isterminated. The LaunchConditions action is optional. This action is normally the first in the sequence, but theAppSearch Action may be sequenced before the LaunchConditions action. If there are launch conditions thatdo not apply to all installation modes, the appropriate installation mode property should be used in a conditionalexpression in the appropriate sequence table. The condition for this action may be specified in the element'sinner text.

Definition

<xs:element name="LaunchConditions" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="Condition" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="LaunchConditions" href="http://msdn.microsoft.com/library/aa369751.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Queries the LaunchCondition table and evaluates each conditional statement recorded

260

Page 261: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

there. If any of these conditional statements fail, an error message is displayed to the user and the installationis terminated. The LaunchConditions action is optional. This action is normally the first in the sequence, butthe AppSearch Action may be sequenced before the LaunchConditions action. If there are launch conditionsthat do not apply to all installation modes, the appropriate installation mode property should be used in aconditional expression in the appropriate sequence table. The condition for this action may be specified in theelement's inner text.</xs:documentation></xs:annotation>

</xs:element>

261

Page 262: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ListBox

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Property string Yes Property tied to this group

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ListItem anyType (restriction) 0..* The value (and optional text) associated withan item in a ComboBox, ListBox, or ListView.

Referenced By

● Element Control

● Element UI

Definition

<xs:element name="ListBox"><xs:annotation><xs:documentation>

Set of items for a particular ListBox control tied to an install Property</xs:documentation>

<xs:appinfo><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListView" href="http://msdn.microsoft.com/library/aa369764.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="ListItem" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>entry for ListBox table</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Property" use="required" type="xs:string"><xs:annotation><xs:documentation>Property tied to this group</xs:documentation>

262

Page 263: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

263

Page 264: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ListItem

Description

The value (and optional text) associated with an item in a ComboBox, ListBox, or ListView.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Value string Yes The value assigned to theassociated ComboBox, ListBox, orListView property if this item isselected.

Text string No The localizable, visible text to beassigned to the item.

Icon string No The identifier of the Binary (not Icon)element containing the icon toassociate with this item.

Content Model

Always empty.

Referenced By

● Element ComboBox

● Element ListBox

● Element ListView

Definition

<xs:element name="ListItem"><xs:annotation><xs:documentation>

The value (and optional text) associated with an item in a ComboBox, ListBox, or ListView.</xs:documentation>

<xs:appinfo><xse:msiRef table="ComboBox" href="http://msdn.microsoft.com/library/aa367872.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListBox" href="http://msdn.microsoft.com/library/aa369762.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="ListView" href="http://msdn.microsoft.com/library/aa369764.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>

The value assigned to the associated ComboBox, ListBox, or ListView property if this item isselected.

</xs:documentation>

264

Page 265: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Text" type="xs:string"><xs:annotation><xs:documentation>

The localizable, visible text to be assigned to the item.If not specified, this will default to the value of the Value attribute.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Icon" type="xs:string"><xs:annotation><xs:documentation>

The identifier of the Binary (not Icon) element containing the icon to associate with this item.This value is only valid when nested under a ListView element.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

265

Page 266: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ListView

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Property string Yes Property tied to this group

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ListItem anyType (restriction) 0..* The value (and optional text) associated withan item in a ComboBox, ListBox, or ListView.

Referenced By

● Element Control

● Element UI

Definition

<xs:element name="ListView"><xs:annotation><xs:documentation>

Set of items for a particular ListView control tied to an install Property</xs:documentation>

<xs:appinfo><xse:msiRef table="ListView" href="http://msdn.microsoft.com/library/aa369764.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="ListItem" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>entry for ListView table</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Property" use="required" type="xs:string"><xs:annotation><xs:documentation>Property tied to this group</xs:documentation>

266

Page 267: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

267

Page 268: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Media

Description

Media element describes a disk that makes up the source media for the installation.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id integer Yes Disk identifier for Media table.

Cabinet string No The name of the cabinet if some orall of the files stored on the mediaare in a cabinet file.

CompressionLevel

NMTOKEN(restriction)

No Indicates the compression level forthe Media's cabinet.

DiskPrompt string No The disk name, which is usually thevisible text printed on the disk.

EmbedCab YesNoType No Instructs the binder to embed thecabinet in the product if 'yes'.

Layout string No This attribute specifies the rootdirectory for the uncompressed filesthat are a part of this Media element.

src string No

VolumeLabel string No The label attributed to the volume.

Source string No Optional property that identifies thesource of the embedded cabinet.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

0..*

DigitalSignature anyType (restriction) 0..1 Adds a digital signature.

PatchBaseline anyType (restriction) 0..* Identifies a set of product versions.

SymbolPath anyType (restriction) 1..1 A path to symbols.

Referenced By

● Element Fragment

Definition

<xs:element name="Media"><xs:annotation><xs:documentation>Media element describes a disk that makes up the source media for the

268

Page 269: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

installation.</xs:documentation><xs:appinfo><xse:msiRef table="Media" href="http://msdn.microsoft.com/library/aa369801.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="DigitalSignature" minOccurs="0" /><xs:element ref="PatchBaseline" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="SymbolPath" />

</xs:choice></xs:sequence><xs:attribute name="Id" type="xs:integer" use="required"><xs:annotation><xs:documentation>Disk identifier for Media table. This number must be equal to or greater than

1.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Cabinet" type="xs:string"><xs:annotation><xs:documentation>The name of the cabinet if some or all of the files stored on the media are in a cabinet

file. If no cabinets are used, this attribute must not be set.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="CompressionLevel"><xs:annotation><xs:documentation>

Indicates the compression level for the Media's cabinet. This attribute canonly be used in conjunction with the Cabinet attribute. The default is 'mszip'.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="high" /><xs:enumeration value="low" /><xs:enumeration value="medium" /><xs:enumeration value="mszip" /><xs:enumeration value="none" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="DiskPrompt" type="xs:string"><xs:annotation><xs:documentation>The disk name, which is usually the visible text printed on the disk. This localizable

text is used to prompt the user when this disk needs to be inserted. This value will be used in the "[1]" of theDiskPrompt Property. Using this attribute will require you to define a DiskPrompt Property.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="EmbedCab" type="YesNoType"><xs:annotation><xs:documentation>Instructs the binder to embed the cabinet in the product if 'yes'. This attribute can only

be specified in conjunction with the Cabinet attribute.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Layout" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies the root directory for the uncompressed files that

269

Page 270: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

are a part of this Media element. By default, the src will be the outputdirectory for the final image. The default value ensures the binder generatesan installable image. If a relative path is specified in the src attribute,the value will be appended to the image's output directory. If an absolutepath is provided, that path will be used without modification. The latter twooptions are provided to ease the layout of an image onto multiple medias (CDs/DVDs).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="Layout" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="VolumeLabel" type="xs:string"><xs:annotation><xs:documentation>

The label attributed to the volume. This is the volume label returnedby the GetVolumeInformation function. If the SourceDir property refersto a removable (floppy or CD-ROM) volume, then this volume label isused to verify that the proper disk is in the drive before attemptingto install files. The entry in this column must match the volume labelof the physical media.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Source" type="xs:string"><xs:annotation><xs:documentation>

Optional property that identifies the source of the embedded cabinet.If a cabinet is specified for a patch, this property should be definedand unique to each patch so that the embedded cabinet containing patchedand new files can be located in the patch package. If the cabinet is notembedded - this is not typical - the cabinet can be found in the directoryreferenced in this column. If empty, the external cabinet must be locatedin the SourceDir directory.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

270

Page 271: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Merge

Description

Merge directive to bring in a merge module that will be redirected to the parent directory.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The unique identifier for the Mergeelement in the source code.

DiskId string No The value of this attribute shouldcorrespond to the Id attribute of aMedia element authored elsewhere.

FileCompression YesNoType No Specifies if the files in the mergemodule should be compressed.

Language LocalizableInteger

Yes Specifies the decimal LCID orlocalization token for the language tomerge the Module in as.

SourceFile string No Path to the source location of themerge module.

src string No

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

ConfigurationData anyType (restriction) 1..1 Data to use as input to a configurable mergemodule.

Referenced By

● Element Directory

● Element DirectoryRef

Definition

<xs:element name="Merge"><xs:annotation><xs:appinfo><xse:seeAlso ref="MergeRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="install_vcredist.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Install the Visual C++Redistributable with your installer</xse:howtoRef>

</xs:appinfo><xs:documentation>Merge directive to bring in a merge module that will be redirected to the parent

directory.</xs:documentation>

271

Page 272: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="ConfigurationData"><xs:annotation><xs:documentation>Data to use as input to a configurable merge module.</xs:documentation>

</xs:annotation></xs:element>

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The unique identifier for the Merge element in the source code. Referenced by the

MergeRef/@Id.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DiskId" type="xs:string"><xs:annotation><xs:documentation>The value of this attribute should correspond to the Id attribute of a

Media element authored elsewhere. By creating this connection between the Merge Module andMedia

element, you set the packaging options to the values specified in the Mediaelement (values such as compression level, cab embedding, etc...).</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="FileCompression" type="YesNoType"><xs:annotation><xs:documentation>Specifies if the files in the merge module should be compressed.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Language" type="LocalizableInteger" use="required"><xs:annotation><xs:documentation>Specifies the decimal LCID or localization token for the language to merge the Module

in as.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Path to the source location of the merge module.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

272

Page 273: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MergeRef

Description

Merge reference to connect a Merge Module to parent Feature

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The unique identifier for the Mergeelement to be referenced.

Primary YesNoType No Specifies whether the featurecontaining this MergeRef is theprimary feature for advertising themerge module's components.

Content Model

Always empty.

Referenced By

● Element Feature

● Element FeatureGroup

● Element FeatureRef

Definition

<xs:element name="MergeRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="Merge" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="install_vcredist.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Install the Visual C++Redistributable with your installer</xse:howtoRef>

</xs:appinfo><xs:documentation>Merge reference to connect a Merge Module to parent Feature</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The unique identifier for the Merge element to be referenced.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Primary" type="YesNoType"><xs:annotation><xs:documentation>Specifies whether the feature containing this MergeRef is the primary feature for

advertising the merge module's components.</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

273

Page 274: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

274

Page 275: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MigrateFeatureStates

Description

Used for upgrading or installing over an existing application.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

Reads feature states from existing application and sets these feature states for the pending installation. Thecondition for this action may be specified in the element's inner text.

Definition

<xs:element name="MigrateFeatureStates" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="MigrateFeatureStates" href="http://msdn.microsoft.com/library/aa370034.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Used for upgrading or installing over an existing application. Reads feature states from

existing application and sets these feature states for the pending installation. The condition for this action maybe specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

275

Page 276: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MIME

Description

MIME content-type for an Extension

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Advertise YesNoType No Whether this MIME is to beadvertised.

ContentType string Yes This is the identifier for the MIMEcontent.

Class Guid No Class ID for the COM server that isto be associated with the MIMEcontent.

Default YesNoType No If 'yes', become the content type forthe parent Extension.

Content Model

Always empty.

Referenced By

● Element Extension

Definition

<xs:element name="MIME"><xs:annotation><xs:documentation>

MIME content-type for an Extension</xs:documentation>

<xs:appinfo><xse:msiRef table="MIME" href="http://msdn.microsoft.com/library/aa370035.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Advertise" type="YesNoType"><xs:annotation><xs:documentation>Whether this MIME is to be advertised. The default is to match whatever the parent

extension element uses. If the parent element is not advertised, then this element cannot be advertisedeither.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ContentType" type="xs:string" use="required"><xs:annotation><xs:documentation>This is the identifier for the MIME content. It is commonly written in the form of

type/format.</xs:documentation></xs:annotation>

</xs:attribute>

276

Page 277: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="Class" type="Guid"><xs:annotation><xs:documentation>Class ID for the COM server that is to be associated with the MIME

content.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Default" type="YesNoType"><xs:annotation><xs:documentation>If 'yes', become the content type for the parent Extension. The default value is

'no'.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

277

Page 278: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Module

Description

The Module element is analogous to the main function in a C program.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The name of the merge module (notthe file name).

Codepage string No The code page integer value or webname for the resulting MSM.

Guid Guid No This attribute is deprecated. Use thePackage/@Id instead.

Language LocalizableInteger

Yes The decimal language ID (LCID) ofthe merge module.

Version string Yes The major and minor versions of themerge module.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Package anyType (restriction) 1..1 Properties about the package to be placed inthe Summary Information Stream.

0..*

any 1..1 Allow any element from the ##othernamespace.

AppId anyType (restriction) 1..1 Application ID containing DCOM information forthe associated application GUID.

Binary anyType (restriction) 1..1 Binary data used for CustomAction elementsand UI controls.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroupRef

anyType (restriction) 1..1 Create a reference to a ComponentGroup inanother Fragment.

ComponentRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Configuration anyType (restriction) 1..1 Defines the configurable attributes of mergemodule.

CustomAction string (extension) 1..1 Specifies a custom action to be added to theMSI CustomAction table.

278

Page 279: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

CustomActionRef anyType (restriction) 1..1 This will cause the entire contents of theFragment containing the referencedCustomAction to be included in the installerdatabase.

CustomTable anyType (restriction) 1..1 Defines a custom table for use from a customaction.

Dependency anyType (restriction) 1..1 Declares a dependency on another mergemodule.

Directory anyType (restriction) 1..1 Directory layout for the product.

DirectoryRef anyType (restriction) 1..1 Create a reference to a Directory element inanother Fragment.

EmbeddedChainer

string (extension) 1..1

EmbeddedChainerRef

anyType (restriction) 1..1 Reference to an EmbeddedChainer element.

EnsureTable anyType (restriction) 1..1 Use this element to ensure that a table appearsin the installer database, even if its empty.

Exclusion anyType (restriction) 1..1 Declares a merge module with which thismerge module is incompatible.

Icon anyType (restriction) 1..1 Icon used for Shortcut, ProgId, or Classelements (but not UI controls)

IgnoreModularization

anyType (restriction) 1..1 This element has been deprecated.

IgnoreTable anyType (restriction) 1..1 Specifies a table from the merge module that isnot merged into an .msi file.

Property anyType (restriction) 1..1 Property value for a Product or Module.

PropertyRef anyType (restriction) 1..1 Reference to a Property value.

1..1

InstallExecuteSequence

anyType (restriction) 0..1

InstallUISequence

anyType (restriction) 0..1

AdminExecuteSequence

anyType (restriction) 0..1

AdminUISequence

anyType (restriction) 0..1

AdvertiseExecuteSequence

anyType (restriction) 0..1

SetDirectory string (extension) 1..1 Sets a Directory to a particular value.

SetProperty string (extension) 1..1 Sets a Property to a particular value.

SFPCatalog anyType (restriction) 1..1 Adds a system file protection update catalogfile

Substitution anyType (restriction) 1..1 Specifies the configurable fields of a moduledatabase and provides a template for theconfiguration of each field.

279

Page 280: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

UI anyType (restriction) 1..1 Enclosing element to compartmentalize UIspecifications.

UIRef anyType (restriction) 1..1 Reference to a UI element. This will force theentire referenced Fragment's contents to beincluded in the installer database.

WixVariable anyType (restriction) 1..1 This element exposes advanced WiXfunctionality.

Remarks

When linking, only one Module section can be given to the linker to produce a successful result. Using thiselement creates an msm file.

Definition

<xs:element name="Module"><xs:annotation><xs:documentation>

The Module element is analogous to the main function in a C program. When linking, onlyone Module section can be given to the linker to produce a successful result. Using thiselement creates an msm file.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by

integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm"xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p>

</xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Package" /><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="AppId" /><xs:element ref="Binary" /><xs:element ref="Component" /><xs:element ref="ComponentGroupRef" /><xs:element ref="ComponentRef" /><xs:element ref="Configuration" /><xs:element ref="CustomAction" /><xs:element ref="CustomActionRef" /><xs:element ref="CustomTable" /><xs:element ref="Dependency" /><xs:element ref="Directory" /><xs:element ref="DirectoryRef" /><xs:element ref="EmbeddedChainer" /><xs:element ref="EmbeddedChainerRef" /><xs:element ref="EnsureTable" /><xs:element ref="Exclusion" /><xs:element ref="Icon" /><xs:element ref="IgnoreModularization" /><xs:element ref="IgnoreTable" /><xs:element ref="Property" /><xs:element ref="PropertyRef" />

280

Page 281: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="SetDirectory" /><xs:element ref="SetProperty" /><xs:element ref="SFPCatalog" /><xs:element ref="Substitution" /><xs:element ref="UI" /><xs:element ref="UIRef" /><xs:element ref="WixVariable" /><xs:sequence><xs:element ref="InstallExecuteSequence" minOccurs="0" /><xs:element ref="InstallUISequence" minOccurs="0" /><xs:element ref="AdminExecuteSequence" minOccurs="0" /><xs:element ref="AdminUISequence" minOccurs="0" /><xs:element ref="AdvertiseExecuteSequence" minOccurs="0" />

</xs:sequence><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The name of the merge module (not the file name).</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Codepage" type="xs:string"><xs:annotation><xs:documentation>The code page integer value or web name for the resulting MSM. See remarks for

more information.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Guid" type="Guid"><xs:annotation><xs:documentation>This attribute is deprecated. Use the Package/@Id instead.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Language" type="LocalizableInteger" use="required"><xs:annotation><xs:documentation>The decimal language ID (LCID) of the merge module.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Version" type="xs:string" use="required"><xs:annotation><xs:documentation>The major and minor versions of the merge module.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

281

Page 282: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MoveFiles

Description

Locates existing files on the system and moves or copies those files to a new location.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="MoveFiles" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef table="MoveFile" href="http://msdn.microsoft.com/library/aa370055.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="MoveFiles" href="http://msdn.microsoft.com/library/aa370054.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Locates existing files on the system and moves or copies those files to a new location.

The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

282

Page 283: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MsiPublishAssemblies

Description

Manages the advertisement of CLR and Win32 assemblies.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="MsiPublishAssemblies" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="MsiPublishAssemblies" href="http://msdn.microsoft.com/library/aa370359.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the advertisement of CLR and Win32 assemblies. The condition for this action

may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

283

Page 284: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MsiUnpublishAssemblies

Description

Manages the unadvertisement of CLR and Win32 assemblies that are being removed.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="MsiUnpublishAssemblies" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="MsiUnpublishAssemblies" href="http://msdn.microsoft.com/library/aa370500.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the unadvertisement of CLR and Win32 assemblies that are being removed.

The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

284

Page 285: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: MultiStringValue

Description

Use several of these elements to specify each registry value in a multiString registry value.

Derived By

Type anyType

Content Model

Always empty.

Referenced By

● Element RegistryValue

Remarks

This element cannot be used if the Value attribute is specified unless the Type attribute is set to 'multiString'.The values should go in the text area of the MultiStringValue element.

Definition

<xs:element name="MultiStringValue"><xs:annotation><xs:documentation>

Use several of these elements to specify each registry value in a multiString registry value. Thiselement

cannot be used if the Value attribute is specified unless the Type attribute is set to 'multiString'. Thevalues should go in the text area of the MultiStringValue element.

</xs:documentation><xs:appinfo><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:element>

285

Page 286: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ODBCDataSource

Description

ODBCDataSource for a Component

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier of the data source.

Name string Yes Name for the data source.

DriverName string No Required if not found as child ofODBCDriver element

Registration NMTOKEN(restriction)

Yes Scope for which the data sourceshould be registered.

KeyPath YesNoType No Set 'yes' to force this file to be keypath for parent Component

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Property anyType (restriction) 0..* Property value for a Product or Module.

Referenced By

● Element Component

● Element ODBCDriver

Definition

<xs:element name="ODBCDataSource"><xs:annotation><xs:documentation>

ODBCDataSource for a Component</xs:documentation>

<xs:appinfo><xse:msiRef table="ODBCDataSource" href="http://msdn.microsoft.com/library/aa370546.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Property" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Translates into ODBCSourceAttributes</xs:documentation>

</xs:annotation></xs:element>

286

Page 287: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:sequence><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Identifier of the data source.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" use="required" type="xs:string"><xs:annotation><xs:documentation>Name for the data source.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DriverName" type="xs:string"><xs:annotation><xs:documentation>Required if not found as child of ODBCDriver element</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Registration" use="required"><xs:annotation><xs:documentation>Scope for which the data source should be registered.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="machine"><xs:annotation><xs:documentation>

Data source is registered per machine.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="user"><xs:annotation><xs:documentation>

Data source is registered per user.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="KeyPath" type="YesNoType"><xs:annotation><xs:documentation>Set 'yes' to force this file to be key path for parent Component</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

287

Page 288: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ODBCDriver

Description

ODBCDriver for a Component

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the driver.

Name string Yes Name for the driver.

File string No Required if not found as child of Fileelement

SetupFile string No Required if not found as child of Fileelement or different from Fileattribute above

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Property anyType (restriction) 0..* Property value for a Product or Module.

ODBCDataSource anyType (restriction) 0..* ODBCDataSource for a Component

Referenced By

● Element Component

● Element File

Definition

<xs:element name="ODBCDriver"><xs:annotation><xs:documentation>

ODBCDriver for a Component</xs:documentation>

<xs:appinfo><xse:msiRef table="ODBCDriver" href="http://msdn.microsoft.com/library/aa370547.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Property" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Translates into ODBCSourceAttributes</xs:documentation>

</xs:annotation></xs:element>

288

Page 289: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="ODBCDataSource" minOccurs="0" maxOccurs="unbounded" /></xs:sequence><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Identifier for the driver.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" use="required" type="xs:string"><xs:annotation><xs:documentation>Name for the driver.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="File" type="xs:string"><xs:annotation><xs:documentation>Required if not found as child of File element</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SetupFile" type="xs:string"><xs:annotation><xs:documentation>Required if not found as child of File element or different from File attribute

above</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

289

Page 290: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ODBCTranslator

Description

ODBCTranslator for a Component

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the translator.

Name string Yes Name for the translator.

File string No Required if not found as child of Fileelement

SetupFile string No Required if not found as child of Fileelement or different from Fileattribute above

Content Model

Always empty.

Referenced By

● Element Component

● Element File

Definition

<xs:element name="ODBCTranslator"><xs:annotation><xs:documentation>

ODBCTranslator for a Component</xs:documentation>

<xs:appinfo><xse:msiRef table="ODBCTranslator" href="http://msdn.microsoft.com/library/aa370549.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Identifier for the translator.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" use="required" type="xs:string"><xs:annotation><xs:documentation>Name for the translator.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="File" type="xs:string"><xs:annotation><xs:documentation>Required if not found as child of File element</xs:documentation>

290

Page 291: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="SetupFile" type="xs:string"><xs:annotation><xs:documentation>Required if not found as child of File element or different from File attribute

above</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

291

Page 292: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: OptimizeCustomActions

Description

Indicates whether custom actions can be skipped when applying the patch.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

SkipAssignment YesNoType No Skip property (type 51) and directory(type 35) assignment customactions.

SkipImmediate YesNoType No Skip immediate custom actions thatare not property or directoryassignment custom actions.

SkipDeferred YesNoType No Skip custom actions that run withinthe script.

Content Model

Always empty.

Definition

<xs:element name="OptimizeCustomActions"><xs:annotation><xs:documentation>Indicates whether custom actions can be skipped when applying the

patch.</xs:documentation><xs:appinfo><xse:msiRef table="MsiPatchMetadata" href="http://msdn.microsoft.com/library/aa370344.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="SkipAssignment" type="YesNoType"><xs:annotation><xs:documentation>Skip property (type 51) and directory (type 35) assignment custom

actions.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SkipImmediate" type="YesNoType"><xs:annotation><xs:documentation>Skip immediate custom actions that are not property or directory assignment custom

actions.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SkipDeferred" type="YesNoType"><xs:annotation><xs:documentation>Skip custom actions that run within the script.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

292

Page 293: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Package

Description

Properties about the package to be placed in the Summary Information Stream.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id AutogenGuid No The package code GUID for aproduct or merge module.

AdminImage YesNoType No Set to 'yes' if the source is an adminimage.

Comments string No Optional comments for browsing.

Compressed YesNoType No Set to 'yes' to have compressed filesin the source.

Description string No The product full name or description.

InstallPrivileges NMTOKEN(restriction)

No Use this attribute to specify thepriviliges required to install thepackage on Windows Vista andabove.

InstallScope NMTOKEN(restriction)

No Use this attribute to specify theinstallation scope of this package:per-machine or per-user.

InstallerVersion integer No The minimum version of theWindows Installer required to installthis package.

Keywords string No Optional keywords for browsing.

Languages string No The list of language IDs (LCIDs)supported in the package.

Manufacturer string No The vendor releasing the package.

Platforms string No

Platform NMTOKEN(restriction)

No The platform supported by thepackage.

ReadOnly YesNoDefaultType

No The value of this attribute conveyswhether the package should beopened as read-only.

ShortNames YesNoType No Set to 'yes' to have short filenames inthe source.

SummaryCodepage

string No The code page integer value or webname for summary info strings only.

Content Model

Always empty.

293

Page 294: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Element Module

● Element Product

Remarks

These are visible from COM through the IStream interface, and these properties can be seen on the package inExplorer.

Definition

<xs:element name="Package"><xs:annotation><xs:documentation>

Properties about the package to be placed in the Summary Information Stream. These arevisible from COM through the IStream interface, and these properties can be seen on the package in

Explorer.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by

integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm"xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p>

</xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="AutogenGuid"><xs:annotation><xs:documentation>

The package code GUID for a product or merge module.When compiling a product, this attribute should not be set in order to allow the packagecode to be generated for each build.When compiling a merge module, this attribute must be set to the modularization guid.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AdminImage" type="YesNoType"><xs:annotation><xs:documentation>Set to 'yes' if the source is an admin image.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Comments" type="xs:string"><xs:annotation><xs:documentation>Optional comments for browsing.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Compressed" type="YesNoType"><xs:annotation><xs:documentation>

Set to 'yes' to have compressed files in the source.This attribute cannot be set for merge modules.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>The product full name or description.</xs:documentation>

</xs:annotation></xs:attribute>

294

Page 295: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="InstallPrivileges"><xs:annotation><xs:documentation>Use this attribute to specify the priviliges required to install the package on Windows

Vista and above.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="limited"><xs:annotation><xs:documentation>

Set this value to declare that the package does not require elevated privileges to install.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="elevated"><xs:annotation><xs:documentation>

Set this value to declare that the package requires elevated privileges to install.This is the default value.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="InstallScope"><xs:annotation><xs:documentation>Use this attribute to specify the installation scope of this package: per-machine or

per-user.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="perMachine"><xs:annotation><xs:documentation>

Set this value to declare that the package is a per-machine installation and requireselevated privileges to install.

Sets the ALLUSERS property to 1.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="perUser"><xs:annotation><xs:documentation>

Set this value to declare that the package is a per-user installation and does not requireelevated privileges to install.

Sets the package's InstallPrivileges attribute to "limited."</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="InstallerVersion" type="xs:integer"><xs:annotation><xs:documentation>

The minimum version of the Windows Installer required to install this package. Take the majorversion of the required Windows Installer

and multiply by a 100 then add the minor version of the Windows Installer. For example, "200"would represent Windows Installer 2.0 and

295

Page 296: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

"405" would represent Windows Installer 4.5.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Keywords" type="xs:string"><xs:annotation><xs:documentation>Optional keywords for browsing.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Languages" type="xs:string"><xs:annotation><xs:documentation>The list of language IDs (LCIDs) supported in the package.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Manufacturer" type="xs:string"><xs:annotation><xs:documentation>The vendor releasing the package.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Platforms" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="Platform"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="Platform"><xs:annotation><xs:documentation>The platform supported by the package.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="x86"><xs:annotation><xs:documentation>

Set this value to declare that the package is an x86 package.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="ia64"><xs:annotation><xs:documentation>

Set this value to declare that the package is an ia64 package.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="x64"><xs:annotation><xs:documentation>

Set this value to declare that the package is an x64 package.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="intel"><xs:annotation><xs:documentation>

Deprecated. Use "x86" instead.</xs:documentation>

</xs:annotation>

296

Page 297: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:enumeration><xs:enumeration value="intel64"><xs:annotation><xs:documentation>

Deprecated. Use "ia64" instead.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="ReadOnly" type="YesNoDefaultType"><xs:annotation><xs:documentation>

The value of this attribute conveys whether the package should be opened as read-only.A database editing tool should not modify a read-only enforced database and shouldissue a warning at attempts to modify a read-only recommended database.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ShortNames" type="YesNoType"><xs:annotation><xs:documentation>Set to 'yes' to have short filenames in the source.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SummaryCodepage" type="xs:string"><xs:annotation><xs:documentation>The code page integer value or web name for summary info strings only. See

remarks for more information.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

297

Page 298: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Patch

Description

The Patch element is analogous to the main function in a C program.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id AutogenGuid No Patch code for this patch.

Codepage string No The code page integer value or webname for the resulting MSP.

AllowRemoval YesNoType No Whether this is an uninstallablepatch.

Classification PatchClassificationType

Yes Category of updates.

ClientPatchId string No An easily referenced identity uniqueto a patch that can be used inproduct authoring.

ApiPatchingSymbolNoImagehlpFlag

YesNoType No Flag used when creating a binary filepatch.

ApiPatchingSymbolNoFailuresFlag

YesNoType No Flag used when creating a binary filepatch.

ApiPatchingSymbolUndecoratedTooFlag

YesNoType No Flag used when creating a binary filepatch.

Description string Yes Description of the patch.

DisplayName string Yes A title for the patch that is suitable forpublic display.

Manufacturer string No Vendor releasing the package

MinorUpdateTargetRTM

YesNoType No Indicates that the patch targets theRTM version of the product or themost recent major upgrade patch.

MoreInfoURL string No A URL that provides informationspecific to this patch.

OptimizedInstallMode

YesNoType No If this attribute is set to 'yes' in all thepatches to be applied in atransaction, the application of thepatch is optimized if possible.

TargetProductName

string No Name of the application or targetproduct suite.

OptimizePatchSizeForLargeFiles

YesNoType No When this attribute is set, patches forfiles greater than approximately 4MB in size may be made smaller.

298

Page 299: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

0..*

any 1..1 Allow any element from the ##othernamespace.

Media anyType (restriction) 1..* Media element describes a disk that makes upthe source media for the installation.

OptimizeCustomActions

anyType (restriction) 0..1 Indicates whether custom actions can beskipped when applying the patch.

PatchFamily anyType (restriction) 1..* Collection of items that should be kept from thedifferences between two products.

PatchFamilyRef anyType (restriction) 0..* This will cause the entire contents of theFragment containing the referencedPatchFamily to be used in the process ofcreating a patch.

PatchProperty anyType (restriction) 1..1 A property for this patch database.

Remarks

When linking, only one Patch section can be given to the linker to produce a successful result. Using thiselement creates an MSP file.

Definition

<xs:element name="Patch"><xs:annotation><xs:documentation>

The Patch element is analogous to the main function in a C program. When linking, only one Patchsection

can be given to the linker to produce a successful result. Using this element creates an MSP file.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by

integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm"xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p>

<html:p xmlns:html="http://www.w3.org/1999/xhtml">The ClientPatchId attribute allows you to specify aneasily referenced identity that you can use in product authoring. This identity prefixes properties added by WiXto a patch transform, such as <html:i>ClientPatchId</html:i>.PatchCode and<html:i>ClientPatchId</html:i>.AllowRemoval. If the patch code GUID is auto-generated you could notreference any properties using this auto-generated prefix.</html:p>

<html:p xmlns:html="http://www.w3.org/1999/xhtml">For example, if you were planning to ship a patchreferred to as "QFE1" and needed to write your own registry values for Add/Remove Programs in productauthoring such as the UninstallString for this patch, you could author a RegistryValue with the nameUninstallString and the value <html:code><html:nobr>[SystemFolder]msiexec.exe</html:nobr> /package[ProductCode] /uninstall [QFE1.PatchCode]</html:code>. In your patch authoring you would then setClientPatchId to "QFE1" and WiX will add the QFE1.PatchCode property to the patch transform when the patchis created. If the Id attribute specified the patch code to be generated automatically, you could not reference the<html:i>prefix</html:i>.PatchCode property as shown above.</html:p>

</xse:remarks></xs:appinfo>

</xs:annotation>

299

Page 300: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:complexType><xs:sequence><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Media" minOccurs="1" maxOccurs="unbounded" /><xs:element ref="OptimizeCustomActions" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Indicates whether custom actions can be skipped when applying the

patch.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="PatchFamily" minOccurs="1" maxOccurs="unbounded" /><xs:element ref="PatchFamilyRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="PatchProperty" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice>

</xs:sequence><xs:attribute name="Id" type="AutogenGuid"><xs:annotation><xs:documentation>Patch code for this patch.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Codepage" type="xs:string"><xs:annotation><xs:documentation>The code page integer value or web name for the resulting MSP. See remarks for

more information.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AllowRemoval" type="YesNoType"><xs:annotation><xs:documentation>Whether this is an uninstallable patch.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Classification" type="PatchClassificationType" use="required"><xs:annotation><xs:documentation>Category of updates.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ClientPatchId" type="xs:string"><xs:annotation><xs:documentation>An easily referenced identity unique to a patch that can be used in product authoring.

See remarks for more information.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ApiPatchingSymbolNoImagehlpFlag" type="YesNoType"><xs:annotation><xs:documentation>Flag used when creating a binary file patch. Default is "no". Don't use

imagehlp.dll.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ApiPatchingSymbolNoFailuresFlag" type="YesNoType"><xs:annotation><xs:documentation>Flag used when creating a binary file patch. Default is "no". Don't fail patch due to

imagehlp failures.</xs:documentation>

300

Page 301: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="ApiPatchingSymbolUndecoratedTooFlag" type="YesNoType"><xs:annotation><xs:documentation>Flag used when creating a binary file patch. Default is "no". After matching decorated

symbols, try to match remaining by undecorated names.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string" use="required"><xs:annotation><xs:documentation>Description of the patch.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DisplayName" type="xs:string" use="required"><xs:annotation><xs:documentation>A title for the patch that is suitable for public display. In Add/Remove Programs from

XP SP2 on.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Manufacturer" type="xs:string"><xs:annotation><xs:documentation>Vendor releasing the package</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MinorUpdateTargetRTM" type="YesNoType"><xs:annotation><xs:documentation>

Indicates that the patch targets the RTM version of the product or the most recent majorupgrade patch. Author this optional property in minor update patches that contain sequencinginformation to indicate that the patch removes all patches up to the RTM version of theproduct, or up to the most recent major upgrade patch. This property is available beginningwith Windows Installer 3.1.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="MoreInfoURL" type="xs:string"><xs:annotation><xs:documentation>A URL that provides information specific to this patch. In Add/Remove Programs from

XP SP2 on.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="OptimizedInstallMode" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute is set to 'yes' in all the patches to be applied in a transaction, theapplication of the patch is optimized if possible. Available beginning with Windows Installer 3.1.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TargetProductName" type="xs:string"><xs:annotation><xs:documentation>Name of the application or target product suite.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="OptimizePatchSizeForLargeFiles" type="YesNoType"><xs:annotation><xs:documentation>When this attribute is set, patches for files greater than approximately 4 MB in size

may be made smaller.</xs:documentation></xs:annotation>

</xs:attribute>

301

Page 302: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:complexType></xs:element>

302

Page 303: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchBaseline

Description

Identifies a set of product versions.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for a set of productversions.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

Validate anyType (restriction) 0..1 Sets information on the patch transform thatdetermines to which product the transformapplies and what errors should be ignoredwhen applying the patch transform.

Definition

<xs:element name="PatchBaseline"><xs:annotation><xs:documentation>Identifies a set of product versions.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0"><xs:element ref="Validate" minOccurs="0" />

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for a set of product versions.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

303

Page 304: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchCertificates

Description

Identifies the possible signer certificates used to digitally sign patches.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..*

DigitalCertificate anyType (restriction) 1..1 Adds a digital certificate.

Referenced By

● Element Fragment

Definition

<xs:element name="PatchCertificates"><xs:annotation><xs:documentation>

Identifies the possible signer certificates used to digitally sign patches.</xs:documentation>

<xs:appinfo><xse:msiRef table="MsiPatchCertificate" href="http://msdn.microsoft.com/library/aa370342.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice maxOccurs="unbounded"><xs:element ref="DigitalCertificate" />

</xs:choice></xs:complexType>

</xs:element>

304

Page 305: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchCreation

Description

The PatchCreation element is analogous to the main function in a C program.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes PatchCreation identifier; this is theprimary key for identifying patches.

AllowMajorVersionMismatches

YesNoType No Use this to set whether the majorversions between the upgrade andtarget images match.

AllowProductCodeMismatches

YesNoType No Use this to set whether the productcode between the upgrade andtarget images match.

CleanWorkingFolder

YesNoType No Use this to set whether Patchwizshould clean the temp folder whenfinished.

Codepage string No The code page integer value or webname for the resulting PCP.

OutputPath string No The full path, including file name, ofthe patch package file that is to begenerated.

SourceList string No Used to locate the .msp file for thepatch if the cached copy isunavailable.

SymbolFlags int No An 8-digit hex integer representingthe combination of patch symbolusage flags to use when creating abinary file patch.

WholeFilesOnly YesNoType No Use this to set whether changingfiles should be included in theirentirety.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

PatchInformation anyType (restriction) 1..1 Properties about the patch to be placed in theSummary Information Stream.

PatchMetadata anyType (restriction) 0..1 Properties about the patch to be placed in thePatchMetadata table.

305

Page 306: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

Family anyType (restriction) 1..* Group of one or more upgraded images of aproduct.

0..*

PatchProperty anyType (restriction) 1..1 A property for this patch database.

PatchSequence anyType (restriction) 1..1 Sequence information for this patch database.

ReplacePatch anyType (restriction) 1..1 A patch that is deprecated by this patch.

TargetProductCode

anyType (restriction) 1..1 A product code for a product that may receivethis patch (or '*' for all products).

Referenced By

● Element Wix

Remarks

When linking, only one PatchCreation section can be given to the linker to produce a successful result. Usingthis element creates a pcp file.

Definition

<xs:element name="PatchCreation"><xs:annotation><xs:documentation>

The PatchCreation element is analogous to the main function in a C program. When linking, only onePatchCreation section

can be given to the linker to produce a successful result. Using this element creates a pcp file.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by

integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm"xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p>

</xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="PatchInformation" /><xs:element ref="PatchMetadata" minOccurs="0" /><xs:element ref="Family" maxOccurs="unbounded" /><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="PatchProperty" /><xs:element ref="PatchSequence" /><xs:element ref="ReplacePatch" /><xs:element ref="TargetProductCode" />

</xs:choice></xs:sequence><xs:attribute name="Id" type="Guid" use="required"><xs:annotation><xs:documentation>PatchCreation identifier; this is the primary key for identifying

patches.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AllowMajorVersionMismatches" type="YesNoType">

306

Page 307: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>Use this to set whether the major versions between the upgrade and target images

match. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">AllowProductVersionMajorMismatches</a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="AllowProductCodeMismatches" type="YesNoType"><xs:annotation><xs:documentation>Use this to set whether the product code between the upgrade and target images

match. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">AllowProductCodeMismatches</a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="CleanWorkingFolder" type="YesNoType"><xs:annotation><xs:documentation>Use this to set whether Patchwiz should clean the temp folder when finished. See <a

href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">DontRemoveTempFolderWhenFinished</a> for moreinformation. </xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Codepage" type="xs:string"><xs:annotation><xs:documentation>The code page integer value or web name for the resulting PCP. See remarks for

more information.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="OutputPath" type="xs:string"><xs:annotation><xs:documentation>The full path, including file name, of the patch package file that is to be generated.

See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">PatchOutputPath</a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SourceList" type="xs:string"><xs:annotation><xs:documentation>Used to locate the .msp file for the patch if the cached copy is unavailable. See <a

href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">PatchSourceList</a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SymbolFlags" type="xs:int"><xs:annotation><xs:documentation>An 8-digit hex integer representing the combination of patch symbol usage flags to

use when creating a binary file patch. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx"target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">ApiPatchingSymbolFlags</a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="WholeFilesOnly" type="YesNoType"><xs:annotation><xs:documentation>Use this to set whether changing files should be included in their entirety. See <a

href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">IncludeWholeFilesOnly</a> for moreinformation.</xs:documentation>

</xs:annotation>

307

Page 308: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute></xs:complexType>

</xs:element>

308

Page 309: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchFamily

Description

Collection of items that should be kept from the differences between two products.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier which indicates a sequencefamily to which this patch belongs.

ProductCode Guid No Specifies the ProductCode of theproduct that this family applies to.

Version string Yes Used to populate the sequencecolumn of the MsiPatchSequencetable in the final MSP file.

Supersede YesNoType No Set this value to 'yes' to indicate thatthis patch will supersede all previouspatches in this patch family.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

0..*

any 1..1 Allow any element from the ##othernamespace.

BinaryRef anyType (restriction) 0..* Used only for PatchFamilies to include only abinary table entry in a patch.

ComponentRef anyType (restriction) 0..* Create a reference to a Feature element inanother Fragment.

CustomActionRef anyType (restriction) 0..* This will cause the entire contents of theFragment containing the referencedCustomAction to be included in the installerdatabase.

DirectoryRef anyType (restriction) 0..* Create a reference to a Directory element inanother Fragment.

FeatureRef anyType (restriction) 0..* Create a reference to a Feature element inanother Fragment.

IconRef anyType (restriction) 0..* Used only for PatchFamilies to include only aicon table entry in a patch.

PropertyRef anyType (restriction) 0..* Reference to a Property value.

309

Page 310: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

UIRef anyType (restriction) 0..* Reference to a UI element. This will force theentire referenced Fragment's contents to beincluded in the installer database.

Referenced By

● Element Fragment

Definition

<xs:element name="PatchFamily"><xs:annotation><xs:documentation>Collection of items that should be kept from the differences between two

products.</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="BinaryRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="ComponentRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="CustomActionRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="FeatureRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="IconRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="PropertyRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="DirectoryRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="UIRef" minOccurs="0" maxOccurs="unbounded" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier which indicates a sequence family to which this patch

belongs.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ProductCode" type="Guid"><xs:annotation><xs:documentation>

Specifies the ProductCode of the product that this family applies to.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Version" type="xs:string" use="required"><xs:annotation><xs:documentation>Used to populate the sequence column of the MsiPatchSequence table in the final

MSP file. Specified in x.x.x.x format. See documentation for Sequence column of MsiPatchSequence table inMSI SDK.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Supersede" type="YesNoType">

310

Page 311: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>

Set this value to 'yes' to indicate that this patch will supersede all previous patches in this patchfamily.

The default value is 'no'.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

311

Page 312: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchFamilyRef

Description

This will cause the entire contents of the Fragment containing the referenced PatchFamily to be used in theprocess of creating a patch.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The identifier of the CustomAction toreference.

Content Model

Always empty.

Definition

<xs:element name="PatchFamilyRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="PatchFamily" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo><xs:documentation>

This will cause the entire contents of the Fragment containing the referenced PatchFamily to beused in the process of creating a patch.

</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The identifier of the CustomAction to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

312

Page 313: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchFiles

Description

Queries the Patch table to determine which patches are to be applied.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="PatchFiles" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="PatchFiles" href="http://msdn.microsoft.com/library/aa370577.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Queries the Patch table to determine which patches are to be applied. The condition for

this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

313

Page 314: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchInformation

Description

Properties about the patch to be placed in the Summary Information Stream.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Description string No Product full name or description

Platforms string No List of platforms supported inpackage

Languages string No List of language IDs supported inpackage

Manufacturer string No Vendor releasing the package

Keywords string No Optional keywords for browsing

Comments string No Optional comments for browsing

ReadOnly YesNoDefaultType

No The value of this attribute conveyswhether the package should beopened as read-only.

SummaryCodepage

string No The code page integer value or webname for summary info strings only.

ShortNames YesNoType No Short filenames on source

Compressed YesNoType No Compressed files on source

AdminImage YesNoType No Source is an admin image

Content Model

Always empty.

Referenced By

● Element PatchCreation

Remarks

These are visible from COM through the IStream interface, and these properties can be seen on the package inExplorer.

Definition

<xs:element name="PatchInformation"><xs:annotation><xs:documentation>Properties about the patch to be placed in the Summary Information Stream. These are

visible from COM through the IStream interface, and these properties can be seen on the package inExplorer.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">

314

Page 315: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by byinteger like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm"xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p>

</xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>Product full name or description</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Platforms" type="xs:string"><xs:annotation><xs:documentation>List of platforms supported in package</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Languages" type="xs:string"><xs:annotation><xs:documentation>List of language IDs supported in package</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Manufacturer" type="xs:string"><xs:annotation><xs:documentation>Vendor releasing the package</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Keywords" type="xs:string"><xs:annotation><xs:documentation>Optional keywords for browsing</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Comments" type="xs:string"><xs:annotation><xs:documentation>Optional comments for browsing</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="ReadOnly" type="YesNoDefaultType"><xs:annotation><xs:documentation>

The value of this attribute conveys whether the package should be opened as read-only.A database editing tool should not modify a read-only enforced database and shouldissue a warning at attempts to modify a read-only recommended database.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="SummaryCodepage" type="xs:string"><xs:annotation><xs:documentation>The code page integer value or web name for summary info strings only. See

remarks for more information.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ShortNames" type="YesNoType"><xs:annotation><xs:documentation>Short filenames on source</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Compressed" type="YesNoType"><xs:annotation><xs:documentation>Compressed files on source</xs:documentation>

315

Page 316: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="AdminImage" type="YesNoType"><xs:annotation><xs:documentation>Source is an admin image</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

316

Page 317: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchMetadata

Description

Properties about the patch to be placed in the PatchMetadata table.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

AllowRemoval YesNoType Yes Whether this is an uninstallablepatch.

Classification PatchClassificationType

Yes Category of update.

CreationTimeUTC

string No Creation time of the .msp file in theform mm-dd-yy HH:MM(month-day-year hour:minute).

Description string Yes Description of the patch.

DisplayName string Yes A title for the patch that is suitable forpublic display.

ManufacturerName

string Yes Name of the manufacturer.

MinorUpdateTargetRTM

string No Indicates that the patch targets theRTM version of the product or themost recent major upgrade patch.

MoreInfoURL string No A URL that provides informationspecific to this patch.

OptimizedInstallMode

YesNoType No If this attribute is set to 'yes' in all thepatches to be applied in atransaction, the application of thepatch is optimized if possible.

TargetProductName

string Yes Name of the application or targetproduct suite.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

0..*

CustomProperty anyType (restriction) 0..1 A custom property for the PatchMetadata table.

OptimizeCustomActions

anyType (restriction) 0..1 Indicates whether custom actions can beskipped when applying the patch.

Referenced By

● Element PatchCreation

317

Page 318: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element name="PatchMetadata"><xs:annotation><xs:documentation>Properties about the patch to be placed in the PatchMetadata table.</xs:documentation><xs:appinfo><xse:msiRef table="MsiPatchMetadata" href="http://msdn.microsoft.com/library/aa370344.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="CustomProperty" minOccurs="0"><xs:annotation><xs:documentation>A custom property that extends the standard set.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="OptimizeCustomActions" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Indicates whether custom actions can be skipped when applying the

patch.</xs:documentation></xs:annotation>

</xs:element></xs:choice>

</xs:sequence><xs:attribute name="AllowRemoval" type="YesNoType" use="required"><xs:annotation><xs:documentation>Whether this is an uninstallable patch.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Classification" type="PatchClassificationType" use="required"><xs:annotation><xs:documentation>Category of update.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="CreationTimeUTC" type="xs:string"><xs:annotation><xs:documentation>Creation time of the .msp file in the form mm-dd-yy HH:MM (month-day-year

hour:minute).</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string" use="required"><xs:annotation><xs:documentation>Description of the patch.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DisplayName" type="xs:string" use="required"><xs:annotation><xs:documentation>A title for the patch that is suitable for public display. In Add/Remove Programs from

XP SP2 on.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ManufacturerName" type="xs:string" use="required"><xs:annotation><xs:documentation>Name of the manufacturer.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MinorUpdateTargetRTM" type="xs:string"><xs:annotation><xs:documentation>

Indicates that the patch targets the RTM version of the product or the most recent major

318

Page 319: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

upgrade patch. Author this optional property in minor update patches that contain sequencinginformation to indicate that the patch removes all patches up to the RTM version of theproduct, or up to the most recent major upgrade patch. This property is available beginningwith Windows Installer 3.1.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="MoreInfoURL" type="xs:string"><xs:annotation><xs:documentation>A URL that provides information specific to this patch. In Add/Remove Programs from

XP SP2 on.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="OptimizedInstallMode" type="YesNoType"><xs:annotation><xs:documentation>

If this attribute is set to 'yes' in all the patches to be applied in a transaction, theapplication of the patch is optimized if possible. Available beginning with Windows Installer 3.1.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TargetProductName" type="xs:string" use="required"><xs:annotation><xs:documentation>Name of the application or target product suite.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

319

Page 320: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchProperty

Description

A property for this patch database.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Company string No Name of the company for a custommetadata property.

Name string Yes Name of the patch property.

Value string Yes Value of the patch property.

Content Model

Always empty.

Definition

<xs:element name="PatchProperty"><xs:annotation><xs:documentation>A property for this patch database.</xs:documentation><xs:appinfo><xse:msiRef table="MsiPatchMetadata" href="http://msdn.microsoft.com/library/aa370344.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">When authored under the Patch element, the

PatchProperty defines entries in the MsiPatchMetadata table.</html:p></xse:remarks>

</xs:appinfo></xs:annotation><xs:complexType><xs:attribute name="Company" type="xs:string"><xs:annotation><xs:documentation>Name of the company for a custom metadata property.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Name of the patch property.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>Value of the patch property.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

320

Page 321: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PatchSequence

Description

Sequence information for this patch database.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

PatchFamily string Yes Identifier which indicates a sequencefamily to which this patch belongs.

ProductCode Guid No Specifies the ProductCode of theproduct that this family applies to.

Sequence string No Used to populate the sequencecolumn of the MsiPatchSequencetable in the final MSP file.

Supersede YesNoType No Set this value to 'yes' to indicate thatthis patch will supersede all previouspatches in this patch family.

Target string No

TargetImage string No Specifies the TargetImage that thisfamily applies to.

Content Model

Always empty.

Remarks

Sequence information is generated automatically in most cases, and rarely needs to be set explicitly.

Definition

<xs:element name="PatchSequence"><xs:annotation><xs:documentation>Sequence information for this patch database. Sequence information is generated

automatically in most cases, and rarely needs to be set explicitly.</xs:documentation><xs:appinfo><xse:msiRef table="MsiPatchSequence" href="http://msdn.microsoft.com/library/aa370350.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="PatchFamily" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier which indicates a sequence family to which this patch

belongs.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ProductCode" type="Guid"><xs:annotation>

321

Page 322: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Specifies the ProductCode of the product that this family applies to.This attribute cannot the specified if the TargetImage attribute is specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Sequence" type="xs:string"><xs:annotation><xs:documentation>Used to populate the sequence column of the MsiPatchSequence table in the final

MSP file. Specified in x.x.x.x format. See documentation for Sequence column of MsiPatchSequence table inMSI SDK.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Supersede" type="YesNoType"><xs:annotation><xs:documentation>

Set this value to 'yes' to indicate that this patch will supersede all previous patches in this patchfamily.

The default value is 'no'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Target" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="TargetImage"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="TargetImage" type="xs:string"><xs:annotation><xs:documentation>

Specifies the TargetImage that this family applies to.This attribute cannot the specified if the ProductCode attribute is specified.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

322

Page 323: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Permission

Description

Sets ACLs on File, Registry, or CreateFolder.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Domain string No

User string Yes

Read YesNoType No

Delete YesNoType No

ReadPermission YesNoType No

ChangePermission

YesNoType No

TakeOwnership YesNoType No

ReadAttributes YesNoType No

WriteAttributes YesNoType No

ReadExtendedAttributes

YesNoType No

WriteExtendedAttributes

YesNoType No

Synchronize YesNoType No

CreateFile YesNoType No For a directory, the right to create afile in the directory.

CreateChild YesNoType No For a directory, the right to create asubdirectory.

DeleteChild YesNoType No For a directory, the right to delete adirectory and all the files it contains,including read-only files.

Traverse YesNoType No For a directory, the right to traversethe directory.

Append YesNoType No

Execute YesNoType No

Write YesNoType No

CreateSubkeys YesNoType No

EnumerateSubkeys

YesNoType No

Notify YesNoType No

CreateLink YesNoType No

GenericAll YesNoType No

323

Page 324: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

GenericExecute YesNoType No

GenericWrite YesNoType No

GenericRead YesNoType No specifying this will fail to grant readaccess

Content Model

Always empty.

Referenced By

● Element CreateFolder

● Element File

● Element Registry

● Element RegistryKey

● Element RegistryValue

Remarks

When under a Registry element, this cannot be used if the Action attribute's value is remove orremoveKeyOnInstall. This element has no Id attribute. The table and key are taken from the parent element.

Definition

<xs:element name="Permission"><xs:annotation><xs:documentation>

Sets ACLs on File, Registry, or CreateFolder. When under a Registry element, this cannot be usedif the Action attribute's value is remove or removeKeyOnInstall. This element has no Id attribute.The table and key are taken from the parent element.

</xs:documentation><xs:appinfo><xse:msiRef table="LockPermissions" href="http://msdn.microsoft.com/library/aa369774.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Domain" type="xs:string"></xs:attribute><xs:attribute name="User" use="required" type="xs:string"></xs:attribute><!-- Common ACLs --><xs:attribute name="Read" type="YesNoType"></xs:attribute><xs:attribute name="Delete" type="YesNoType"></xs:attribute><xs:attribute name="ReadPermission" type="YesNoType"></xs:attribute><xs:attribute name="ChangePermission" type="YesNoType"></xs:attribute><xs:attribute name="TakeOwnership" type="YesNoType"></xs:attribute><!-- Folder and File ACLs -->

324

Page 325: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="ReadAttributes" type="YesNoType"></xs:attribute><xs:attribute name="WriteAttributes" type="YesNoType"></xs:attribute><xs:attribute name="ReadExtendedAttributes" type="YesNoType"></xs:attribute><xs:attribute name="WriteExtendedAttributes" type="YesNoType"></xs:attribute><xs:attribute name="Synchronize" type="YesNoType"></xs:attribute><!-- Folder only ACLs --><xs:attribute name="CreateFile" type="YesNoType"><xs:annotation><xs:documentation>For a directory, the right to create a file in the directory. Only valid under a

'CreateFolder' parent.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="CreateChild" type="YesNoType"><xs:annotation><xs:documentation>For a directory, the right to create a subdirectory. Only valid under a 'CreateFolder'

parent.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DeleteChild" type="YesNoType"><xs:annotation><xs:documentation>For a directory, the right to delete a directory and all the files it contains, including

read-only files. Only valid under a 'CreateFolder' parent.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Traverse" type="YesNoType"><xs:annotation><xs:documentation>For a directory, the right to traverse the directory. By default, users are assigned the

BYPASS_TRAVERSE_CHECKING privilege, which ignores the FILE_TRAVERSE access right. Only validunder a 'CreateFolder' parent.</xs:documentation>

</xs:annotation></xs:attribute><!-- File only ACLs --><xs:attribute name="Append" type="YesNoType"></xs:attribute><xs:attribute name="Execute" type="YesNoType"></xs:attribute><!-- File and Registry ACLs --><xs:attribute name="Write" type="YesNoType"></xs:attribute><!-- Registry only ACLs --><xs:attribute name="CreateSubkeys" type="YesNoType"></xs:attribute><xs:attribute name="EnumerateSubkeys" type="YesNoType"></xs:attribute><xs:attribute name="Notify" type="YesNoType"></xs:attribute><xs:attribute name="CreateLink" type="YesNoType"></xs:attribute><!-- Generic ACLs, mapped by system to appropriate permissions --><xs:attribute name="GenericAll" type="YesNoType"></xs:attribute><xs:attribute name="GenericExecute" type="YesNoType"></xs:attribute><xs:attribute name="GenericWrite" type="YesNoType"></xs:attribute>

325

Page 326: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="GenericRead" type="YesNoType"><xs:annotation><xs:documentation>specifying this will fail to grant read access</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

326

Page 327: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ProcessComponents

Description

Registers and unregisters components, their key paths, and the component clients.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="ProcessComponents" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="ProcessComponents" href="http://msdn.microsoft.com/library/aa370853.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers and unregisters components, their key paths, and the component clients. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

327

Page 328: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Product

Description

The Product element is analogous to the main function in a C program.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id AutogenGuid Yes The product code GUID for theproduct.

Codepage string No The code page integer value or webname for the resulting MSI. Seeremarks for more information.

Language LocalizableInteger

Yes The decimal language ID (LCID) forthe product.

Manufacturer string Yes The manufacturer of the product.

Name string Yes The descriptive name of the product.

UpgradeCode Guid No The upgrade code GUID for theproduct.

Version string Yes The product's version string.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Package anyType (restriction) 1..1 Properties about the package to be placed inthe Summary Information Stream.

0..*

any 1..1 Allow any element from the ##othernamespace.

AppId anyType (restriction) 1..1 Application ID containing DCOM information forthe associated application GUID.

Binary anyType (restriction) 1..1 Binary data used for CustomAction elementsand UI controls.

ComplianceCheck anyType (restriction) 1..1 Adds a row to the CCPSearch table.

Component anyType (restriction) 1..1 Component for parent Directory

ComponentGroup anyType (restriction) 1..1 Groups together multiple components to beused in other locations.

Condition string (extension) 1..1 Conditions for components, controls, features,and products.

CustomAction string (extension) 1..1 Specifies a custom action to be added to theMSI CustomAction table.

328

Page 329: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

CustomActionRef anyType (restriction) 1..1 This will cause the entire contents of theFragment containing the referencedCustomAction to be included in the installerdatabase.

CustomTable anyType (restriction) 1..1 Defines a custom table for use from a customaction.

Directory anyType (restriction) 1..1 Directory layout for the product.

DirectoryRef anyType (restriction) 1..1 Create a reference to a Directory element inanother Fragment.

EmbeddedChainer

string (extension) 1..1

EmbeddedChainerRef

anyType (restriction) 1..1 Reference to an EmbeddedChainer element.

EnsureTable anyType (restriction) 1..1 Use this element to ensure that a table appearsin the installer database, even if its empty.

Feature anyType (restriction) 1..1 A feature for the Feature table.

FeatureGroupRef anyType (restriction) 1..1 Create a reference to a FeatureGroup inanother Fragment.

FeatureRef anyType (restriction) 1..1 Create a reference to a Feature element inanother Fragment.

Icon anyType (restriction) 1..1 Icon used for Shortcut, ProgId, or Classelements (but not UI controls)

InstanceTransforms

anyType (restriction) 1..1 Use this element to contain definitions forinstance transforms.

Media anyType (restriction) 1..1 Media element describes a disk that makes upthe source media for the installation.

PatchCertificates anyType (restriction) 1..1 Identifies the possible signer certificates usedto digitally sign patches.

Property anyType (restriction) 1..1 Property value for a Product or Module.

PropertyRef anyType (restriction) 1..1 Reference to a Property value.

1..1

InstallExecuteSequence

anyType (restriction) 0..1

InstallUISequence

anyType (restriction) 0..1

AdminExecuteSequence

anyType (restriction) 0..1

AdminUISequence

anyType (restriction) 0..1

AdvertiseExecuteSequence

anyType (restriction) 0..1

SetDirectory string (extension) 1..1 Sets a Directory to a particular value.

SetProperty string (extension) 1..1 Sets a Property to a particular value.

329

Page 330: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

SFPCatalog anyType (restriction) 1..1 Adds a system file protection update catalogfile

SymbolPath anyType (restriction) 1..1 A path to symbols.

UI anyType (restriction) 1..1 Enclosing element to compartmentalize UIspecifications.

UIRef anyType (restriction) 1..1 Reference to a UI element. This will force theentire referenced Fragment's contents to beincluded in the installer database.

Upgrade anyType (restriction) 1..1 Upgrade info for a particular UpgradeCode

WixVariable anyType (restriction) 1..1 This element exposes advanced WiXfunctionality.

Remarks

When linking, only one Product section can be given to the linker to produce a successful result. Using thiselement creates an msi file.

Definition

<xs:element name="Product"><xs:annotation><xs:documentation>

The Product element is analogous to the main function in a C program. When linking, only oneProduct section

can be given to the linker to produce a successful result. Using this element creates an msi file.</xs:documentation>

<xs:appinfo><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"><html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by integer

like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm"xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p>

</xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Package" /><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="AppId" /><xs:element ref="Binary" /><xs:element ref="ComplianceCheck" /><xs:element ref="Component" /><xs:element ref="ComponentGroup" /><xs:element ref="Condition" /><xs:element ref="CustomAction" /><xs:element ref="CustomActionRef" /><xs:element ref="CustomTable" /><xs:element ref="Directory" /><xs:element ref="DirectoryRef" /><xs:element ref="EmbeddedChainer" /><xs:element ref="EmbeddedChainerRef" /><xs:element ref="EnsureTable" /><xs:element ref="Feature" /><xs:element ref="FeatureRef" />

330

Page 331: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="FeatureGroupRef" /><xs:element ref="Icon" /><xs:element ref="InstanceTransforms" /><xs:element ref="Media" /><xs:element ref="PatchCertificates" /><xs:element ref="Property" /><xs:element ref="PropertyRef" /><xs:element ref="SetDirectory" /><xs:element ref="SetProperty" /><xs:element ref="SFPCatalog" /><xs:element ref="SymbolPath" /><xs:element ref="UI" /><xs:element ref="UIRef" /><xs:element ref="Upgrade" /><xs:element ref="WixVariable" /><xs:sequence><xs:element ref="InstallExecuteSequence" minOccurs="0" /><xs:element ref="InstallUISequence" minOccurs="0" /><xs:element ref="AdminExecuteSequence" minOccurs="0" /><xs:element ref="AdminUISequence" minOccurs="0" /><xs:element ref="AdvertiseExecuteSequence" minOccurs="0" />

</xs:sequence><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice>

</xs:sequence><xs:attribute name="Id" type="AutogenGuid" use="required"><xs:annotation><xs:documentation>The product code GUID for the product.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Codepage" type="xs:string"><xs:annotation><xs:documentation>The code page integer value or web name for the resulting MSI. See remarks for more

information.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Language" type="LocalizableInteger" use="required"><xs:annotation><xs:documentation>The decimal language ID (LCID) for the product.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Manufacturer" type="xs:string" use="required"><xs:annotation><xs:documentation>The manufacturer of the product.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>The descriptive name of the product.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="UpgradeCode" type="Guid"><xs:annotation>

331

Page 332: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>The upgrade code GUID for the product.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Version" type="xs:string" use="required"><xs:annotation><xs:documentation>The product's version string.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

332

Page 333: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ProgId

Description

ProgId registration for parent Component.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

Description string No

Icon string No For an advertised ProgId, the Id ofan Icon element.

IconIndex integer No

Advertise YesNoType No

NoOpen string No Specifies that the associated ProgIdshould not be opened by users.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ProgId anyType (restriction) 0..1 ProgId registration for parent Component.

Extension anyType (restriction) 0..* Extension for a Component

Referenced By

● Element Class

● Element Component

● Element ProgId

Remarks

If ProgId has an associated Class, it must be a child of that element.

Definition

<xs:element name="ProgId"><xs:annotation><xs:documentation>

ProgId registration for parent Component. If ProgId has an associated Class, it must be a child ofthat element.

</xs:documentation><xs:appinfo><xse:msiRef table="ProgId" href="http://msdn.microsoft.com/library/aa370879.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

333

Page 334: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:msiRef table="Class" href="http://msdn.microsoft.com/library/aa367861.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:msiRef table="Icon" href="http://msdn.microsoft.com/library/aa369210.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo></xs:annotation><xs:complexType><xs:sequence><xs:element ref="ProgId" minOccurs="0"><xs:annotation><xs:documentation>Version-independent ProgId must be child element of actual ProgId. Nesting further

ProgId elements within the Version-independent ProgId is disallowed.</xs:documentation></xs:annotation>

</xs:element><xs:element ref="Extension" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Extensions that refer to this ProgId</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required" /><xs:attribute name="Description" type="xs:string" /><xs:attribute name="Icon" type="xs:string"><xs:annotation><xs:documentation>For an advertised ProgId, the Id of an Icon element. For a non-advertised ProgId, this

is the Id of a file containing an icon resource.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IconIndex" type="xs:integer" /><xs:attribute name="Advertise" type="YesNoType" /><xs:attribute name="NoOpen" type="xs:string"><xs:annotation><xs:documentation>Specifies that the associated ProgId should not be opened by users. The value is

presented as a warning to users. An empty string is also valid for this attribute.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

334

Page 335: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ProgressText

Derived By

Extending string

Attributes

Name Type Required? Default Description

Action string Yes

Template string No used to format ActionData messagesfrom action processing

Content Model

Contains text only.

Referenced By

● Element UI

Definition

<xs:element name="ProgressText"><xs:annotation><xs:appinfo><xse:msiRef table="ActionText" href="http://msdn.microsoft.com/library/aa367516.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>Element value is progress message text for action</xs:documentation>

</xs:annotation><xs:attribute name="Action" type="xs:string" use="required" /><xs:attribute name="Template" type="xs:string"><xs:annotation><xs:documentation>used to format ActionData messages from action processing</xs:documentation>

</xs:annotation></xs:attribute>

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

335

Page 336: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Property

Description

Property value for a Product or Module.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for Property.

Value string No Sets a default value for the property.The value will be overwritten if theProperty is used for a search.

ComplianceCheck

YesNoType No Adds a row to the CCPSearch table.This attribute is only valid when thisProperty contains a search element.

Admin YesNoType No Denotes that the Property is savedduring

Secure YesNoType No Denotes that the Property can bepassed to the server side whendoing a managed installation withelevated privileges.

Hidden YesNoType No Denotes that the Property is notlogged during installation.

SuppressModularization

YesNoType No Use to suppress modularization ofthis property identifier in mergemodules.

Content Model

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

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

1..1

ComplianceDrive anyType (restriction) 0..1 Sets the parent of a nested DirectorySearchelement to CCP_DRIVE.

ComponentSearch

anyType (restriction) 0..* Searches for file or directory and assigns tovalue of parent Property.

RegistrySearch anyType (restriction) 0..* Searches for file, directory or registry key andassigns to value of parent Property

RegistrySearchRef

anyType (restriction) 0..* References an existing RegistrySearchelement.

336

Page 337: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

IniFileSearch anyType (restriction) 0..* Searches for file, directory or registry key andassigns to value of parent Property

DirectorySearch anyType (restriction) 0..* Searches for directory and assigns to value ofparent Property.

DirectorySearchRef

anyType (restriction) 0..* References an existing DirectorySearchelement.

Referenced By

● Element Control

● Element Fragment

● Element ODBCDataSource

● Element ODBCDriver

● Element UI

● Element Upgrade

Definition

<xs:element name="Property"><xs:annotation><xs:appinfo><xse:seeAlso ref="PropertyRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:msiRef table="Property" href="http://msdn.microsoft.com/library/aa370908.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="check_the_version_number.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check the version numberof a file during installation</xse:howtoRef>

</xs:appinfo><xs:documentation>Property value for a Product or Module.</xs:documentation>

</xs:annotation><xs:complexType mixed="true"><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:sequence><xs:element ref="ComplianceDrive" minOccurs="0"><xs:annotation><xs:documentation>Starts searches from the CCP_DRIVE.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ComponentSearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="RegistrySearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="RegistrySearchRef" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="IniFileSearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="DirectorySearch" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="DirectorySearchRef" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any>

337

Page 338: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for Property.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>Sets a default value for the property. The value will be overwritten if the Property is

used for a search.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ComplianceCheck" type="YesNoType"><xs:annotation><xs:documentation>Adds a row to the CCPSearch table. This attribute is only valid when this Property

contains a search element.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Admin" type="YesNoType"><xs:annotation><xs:documentation>Denotes that the Property is saved during <html:a

href="http://msdn.microsoft.com/library/aa367541.aspx" target="_blank"xmlns:html="http://www.w3.org/1999/xhtml">admininistrative installation</html:a>. See the <html:ahref="http://msdn.microsoft.com/library/aa367542.aspx" target="_blank"xmlns:html="http://www.w3.org/1999/xhtml">AdminProperties Property</html:a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Secure" type="YesNoType"><xs:annotation><xs:documentation>Denotes that the Property can be passed to the server side when doing a managed

installation with elevated privileges. See the <html:a href="http://msdn.microsoft.com/library/aa371571.aspx"target="_blank" xmlns:html="http://www.w3.org/1999/xhtml">SecureCustomProperties Property</html:a> formore information.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Hidden" type="YesNoType"><xs:annotation><xs:documentation>Denotes that the Property is not logged during installation. See the <html:a

href="http://msdn.microsoft.com/library/aa370308.aspx" target="_blank"xmlns:html="http://www.w3.org/1999/xhtml">MsiHiddenProperties Property</html:a> for moreinformation.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SuppressModularization" type="YesNoType"><xs:annotation><xs:documentation>

Use to suppress modularization of this property identifier in merge modules.Using this functionality is strongly discouraged; it should only benecessary as a workaround of last resort in rare scenarios.

</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

338

Page 339: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:anyAttribute></xs:complexType>

</xs:element>

339

Page 340: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PropertyRef

Description

Reference to a Property value.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier of Property to reference.

Content Model

Always empty.

Referenced By

● Element Fragment

● Element UI

Definition

<xs:element name="PropertyRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="Property" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="check_for_dotnet.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check for .NETFramework versions</xse:howtoRef>

</xs:appinfo><xs:documentation>Reference to a Property value.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier of Property to reference.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

340

Page 341: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ProtectFile

Description

Specifies a file to be protected.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

File string Yes Foreign key into the File table.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..*

ProtectRange anyType (restriction) 1..1 Specifies part of a file that cannot beoverwritten during patching.

Definition

<xs:element name="ProtectFile"><xs:annotation><xs:documentation>Specifies a file to be protected.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice maxOccurs="unbounded"><xs:element ref="ProtectRange" />

</xs:choice><xs:attribute name="File" type="xs:string" use="required"><xs:annotation><xs:documentation>Foreign key into the File table.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

341

Page 342: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ProtectRange

Description

Specifies part of a file that cannot be overwritten during patching.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Offset int Yes Offset of the start of the range.

Length int Yes Length of the range.

Content Model

Always empty.

Referenced By

● Element ExternalFile

● Element ProtectFile

Definition

<xs:element name="ProtectRange"><xs:annotation><xs:documentation>Specifies part of a file that cannot be overwritten during patching.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Offset" type="xs:int" use="required"><xs:annotation><xs:documentation>Offset of the start of the range.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Length" type="xs:int" use="required"><xs:annotation><xs:documentation>Length of the range.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

342

Page 343: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Publish

Derived By

Extending string

Attributes

Name Type Required? Default Description

Control string No The parent Control for this Publishelement, should only be specifiedwhen this element is a child of the UIelement.

Dialog string No The parent Dialog for this Publishelement, should only be specifiedwhen this element is a child of the UIelement.

Event string No Set this attribute's value to one of thestandard control events to triggerthat event.

Order string No This attribute should only need to beset if this element is nested under aUI element in order to control theorder in which this publish event willbe started.

Property string No Set this attribute's value to a propertyname to set that property.

Value string No If the Property attribute is specified,set the value of this attribute to thenew value for the property.

Content Model

Contains text only.

Referenced By

● Element UI

Definition

<xs:element name="Publish"><xs:annotation><xs:appinfo><xse:msiRef table="ControlEvent" href="http://msdn.microsoft.com/library/aa368037.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>The element value is the optional Condition expression.</xs:documentation>

</xs:annotation><xs:attribute name="Control" type="xs:string"><xs:annotation>

343

Page 344: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>The parent Control for this Publish element, should only be specified when this element is a

child of the UI element.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Dialog" type="xs:string"><xs:annotation><xs:documentation>

The parent Dialog for this Publish element, should only be specified when this element is achild of the UI element.

This attribute will create a reference to the specified Dialog, so an additional DialogRef isnot necessary.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Event" type="xs:string"><xs:annotation><xs:documentation>

Set this attribute's value to one of the standard control events to trigger that event.Either this attribute or the Property attribute must be set, but not both at the same time.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Order" type="xs:string"><xs:annotation><xs:documentation>

This attribute should only need to be set if this element is nested under a UI element inorder to

control the order in which this publish event will be started.If this element is nested under a Control element, the default value will be one greater than

anyprevious Publish element's order (the first element's default value is 1).If this element is nested under a UI element, the default value is always 1 (it does not get adefault value based on any previous Publish elements).

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Property" type="xs:string"><xs:annotation><xs:documentation>

Set this attribute's value to a property name to set that property.Either this attribute or the Event attribute must be set, but not both at the same time.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

If the Property attribute is specified, set the value of this attribute to the new value for theproperty.

To set a property to null, do not set this attribute (the ControlEvent Argument column will beset to '{}').

Otherwise, this attribute's value should be the argument for the event specified in the Eventattribute.

</xs:documentation></xs:annotation>

</xs:attribute></xs:extension>

</xs:simpleContent>

344

Page 345: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:complexType></xs:element>

345

Page 346: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PublishComponents

Description

Manages the advertisement of the components from the PublishComponent table.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="PublishComponents" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="PublishComponents" href="http://msdn.microsoft.com/library/aa370918.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the advertisement of the components from the PublishComponent table. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

346

Page 347: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PublishFeatures

Description

Writes each feature's state into the system registry.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="PublishFeatures" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="PublishFeatures" href="http://msdn.microsoft.com/library/aa370923.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Writes each feature's state into the system registry. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

347

Page 348: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: PublishProduct

Description

Manages the advertisement of the product information with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="PublishProduct" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="PublishProduct" href="http://msdn.microsoft.com/library/aa370932.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the advertisement of the product information with the system. The condition

for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

348

Page 349: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RadioButton

Description

Text or Icon plus Value that is assigned to the Property of the parent Control (RadioButtonGroup).

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Bitmap string No This attribute defines the bitmapdisplayed with the radio button.

Height LocalizableInteger

Yes

Help string No

Icon string No This attribute defines the icondisplayed with the radio button.

Text string No Text displayed with the radio button.

ToolTip string No

Value string Yes Value assigned to the associatedcontrol Property when this radiobutton is selected.

Width LocalizableInteger

Yes

X LocalizableInteger

Yes

Y LocalizableInteger

Yes

Content Model

Always empty.

Referenced By

● Element RadioButtonGroup

Definition

<xs:element name="RadioButton"><xs:annotation><xs:appinfo><xse:seeAlso ref="RadioButtonGroup"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RadioButton" href="http://msdn.microsoft.com/library/aa370962.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

349

Page 350: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:appinfo><xs:documentation>Text or Icon plus Value that is assigned to the Property of the parent Control

(RadioButtonGroup).</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Bitmap" type="xs:string"><xs:annotation><xs:documentation>

This attribute defines the bitmap displayed with the radio button. The value of the attribute createsa reference

to a Binary element that represents the bitmap. This attribute is mutually exclusive with the Iconand Text

attributes.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Height" use="required" type="LocalizableInteger" /><xs:attribute name="Help" type="xs:string" /><xs:attribute name="Icon" type="xs:string"><xs:annotation><xs:documentation>

This attribute defines the icon displayed with the radio button. The value of the attribute creates areference

to a Binary element that represents the icon. This attribute is mutually exclusive with the Bitmapand Text

attributes.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Text" type="xs:string"><xs:annotation><xs:documentation>Text displayed with the radio button. This attribute is mutually exclusive with the

Bitmap and Icon attributes.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ToolTip" type="xs:string" /><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>Value assigned to the associated control Property when this radio button is

selected.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Width" use="required" type="LocalizableInteger" /><xs:attribute name="X" use="required" type="LocalizableInteger" /><xs:attribute name="Y" use="required" type="LocalizableInteger" />

</xs:complexType></xs:element>

350

Page 351: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RadioButtonGroup

Description

Set of radio buttons tied to the specified Property

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Property string Yes Property tied to this group.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

RadioButton anyType (restriction) 1..* Text or Icon plus Value that is assigned to theProperty of the parent Control(RadioButtonGroup).

Referenced By

● Element Control

● Element UI

Definition

<xs:element name="RadioButtonGroup"><xs:annotation><xs:documentation>

Set of radio buttons tied to the specified Property</xs:documentation>

<xs:appinfo><xse:msiRef table="RadioButton" href="http://msdn.microsoft.com/library/aa370962.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="RadioButton" maxOccurs="unbounded" />

</xs:sequence><xs:attribute name="Property" use="required" type="xs:string"><xs:annotation><xs:documentation>Property tied to this group.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType>

351

Page 352: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:element>

352

Page 353: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterClassInfo

Description

Manages the registration of COM class information with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterClassInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterClassInfo" href="http://msdn.microsoft.com/library/aa371154.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the registration of COM class information with the system. The condition for

this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

353

Page 354: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterComPlus

Description

Registers COM+ applications.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterComPlus" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterComPlus" href="http://msdn.microsoft.com/library/aa371155.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers COM+ applications. The condition for this action may be specified in the

element's inner text.</xs:documentation></xs:annotation>

</xs:element>

354

Page 355: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterExtensionInfo

Description

Manages the registration of extension related information with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterExtensionInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterExtensionInfo" href="http://msdn.microsoft.com/library/aa371156.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the registration of extension related information with the system. The condition

for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

355

Page 356: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterFonts

Description

Registers installed fonts with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterFonts" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterFonts" href="http://msdn.microsoft.com/library/aa371158.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers installed fonts with the system. The condition for this action may be specified

in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

356

Page 357: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterMIMEInfo

Description

Registers MIME-related registry information with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterMIMEInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterMIMEInfo" href="http://msdn.microsoft.com/library/aa371160.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers MIME-related registry information with the system. The condition for this

action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

357

Page 358: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterProduct

Description

Registers the product information with the installer.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterProduct" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterProduct" href="http://msdn.microsoft.com/library/aa371162.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers the product information with the installer. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

358

Page 359: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterProgIdInfo

Description

Manages the registration of OLE ProgId information with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdvertiseExecuteSequence

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterProgIdInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterProgIdInfo" href="http://msdn.microsoft.com/library/aa371164.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the registration of OLE ProgId information with the system. The condition for

this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

359

Page 360: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterTypeLibraries

Description

Registers type libraries with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterTypeLibraries" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterTypeLibraries" href="http://msdn.microsoft.com/library/aa371165.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers type libraries with the system. The condition for this action may be specified in

the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

360

Page 361: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegisterUser

Description

Registers the user information with the installer to identify the user of a product.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RegisterUser" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RegisterUser" href="http://msdn.microsoft.com/library/aa371166.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Registers the user information with the installer to identify the user of a product. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

361

Page 362: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Registry

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Primary key used to identify thisparticular entry.

Action NMTOKEN(restriction)

No This is the action that will be takenfor this registry key.

Key string No The localizable key for the registryvalue.

KeyPath YesNoType No Set this attribute to 'yes' to make thisregistry key the KeyPath of theparent component.

Name string No The localizable registry value name.

Root RegistryRootType

No The predefined root key for theregistry value.

Type NMTOKEN(restriction)

No Set this attribute to the type of thedesired registry key.

Value string No Set this attribute to the localizableregistry value. This value isformatted.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Permission anyType (restriction) 1..1 Sets ACLs on File, Registry, or CreateFolder.

Registry anyType (restriction) 1..1

RegistryValue anyType (restriction) 1..1 Used to create a registry value. For multi-stringvalues, this can be used to prepend or appendvalues.

Referenced By

● Element Component

● Element Registry

Definition

<xs:element name="Registry"><xs:annotation><xs:appinfo>

362

Page 363: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:deprecated ref="RegistryValue"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Permission" /><xs:element ref="RegistryValue" /><xs:element ref="Registry" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

Primary key used to identify this particular entry. If this attribute is not specified, an identifier will begenerated by hashing the parent Component identifier, Root, Key, and Name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Action"><xs:annotation><xs:documentation>

This is the action that will be taken for this registry key.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="append"><xs:annotation><xs:documentation>

Appends the specified value(s) to a multiString registry key.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="createKey"><xs:annotation><xs:documentation>

Creates the key, if absent, when the parent component is installed.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="createKeyAndRemoveKeyOnUninstall"><xs:annotation><xs:documentation>

Creates the key, if absent, when the parent component is installed then remove the keywith all its values and subkeys when the parent component is uninstalled.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="prepend"><xs:annotation>

363

Page 364: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Prepends the specified value(s) to a multiString registry key.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="remove"><xs:annotation><xs:documentation>

Removes a registry name when the parent component in installed.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="removeKeyOnInstall"><xs:annotation><xs:documentation>

Removes a key with all its values and subkeys when the parent component is installed.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="removeKeyOnUninstall"><xs:annotation><xs:documentation>

Removes a key with all its values and subkeys when the parent component isuninstalled.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="write"><xs:annotation><xs:documentation>

Writes a registry value.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Key" type="xs:string"><xs:annotation><xs:documentation>The localizable key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="KeyPath" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' to make this registry key the KeyPath of the parent component. Only oneresource (registry,

file, etc) can be the KeyPath of a component.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string"><xs:annotation><xs:documentation>

The localizable registry value name. If this attribute is not provided the default value for the registrykey will

be set instead. The Windows Installer allows several special values to be set for this attribute.You should not

use them in WiX. Instead use appropriate values in the Action attribute to get the desired behavior.</xs:documentation>

364

Page 365: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Root" type="RegistryRootType"><xs:annotation><xs:documentation>

The predefined root key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Type"><xs:annotation><xs:documentation>

Set this attribute to the type of the desired registry key. This attribute must be specifiedwhenever the Value

attribute or a child RegistryValue element is specified. This attributeshould only be set when the value of the Action attribute does not include the word 'remove'.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="string"><xs:annotation><xs:documentation>

The value is interpreted and stored as a string (REG_SZ).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="integer"><xs:annotation><xs:documentation>

The value is interpreted and stored as an integer (REG_DWORD).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="binary"><xs:annotation><xs:documentation>

The value is interpreted and stored as a hexadecimal value (REG_BINARY).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="expandable"><xs:annotation><xs:documentation>

The value is interpreted and stored as an expandable string (REG_EXPAND_SZ).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="multiString"><xs:annotation><xs:documentation>

The value is interpreted and stored as a multiple strings (REG_MULTI_SZ).Please note that this value will only result in a multi-string value if there is more than one

registry valueor the Action attribute's value is 'append' or 'prepend'. Otherwise a string value will be

created.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction>

365

Page 366: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:simpleType></xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

Set this attribute to the localizable registry value. This value is formatted. The Windows Installerallows

several special values to be set for this attribute. You should not use them in WiX. Instead useappropriate

values in the Type attribute to get the desired behavior. This attribute cannot be specified if theAction

attribute's value contains the word 'remove'.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

366

Page 367: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegistryKey

Description

Used for organization of child RegistryValue elements or to create a registry key (and optionally remove itduring uninstallation).

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Primary key used to identify thisparticular entry.

Action NMTOKEN(restriction)

No This is the action that will be takenfor this registry value.

Key string No The localizable key for the registryvalue.

Root RegistryRootType

No The predefined root key for theregistry value.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

Permission anyType (restriction) 0..* Sets ACLs on File, Registry, or CreateFolder.

RegistryKey anyType (restriction) 1..1 Used for organization of child RegistryValueelements or to create a registry key (andoptionally remove it during uninstallation).

RegistryValue anyType (restriction) 1..1 Used to create a registry value. For multi-stringvalues, this can be used to prepend or appendvalues.

Referenced By

● Element Component

● Element RegistryKey

Definition

<xs:element name="RegistryKey"><xs:annotation><xs:documentation>

Used for organization of child RegistryValue elements or to create a registry key(and optionally remove it during uninstallation).

</xs:documentation><xs:appinfo>

367

Page 368: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

<xse:howtoRef href="read_a_registry_entry.htm"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Read a registry entryduring installation</xse:howtoRef>

<xse:howtoRef href="write_a_registry_entry.htm"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Write a registry entryduring installation</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="RegistryKey" /><xs:element ref="RegistryValue" /><xs:element ref="Permission" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>ACL permission</xs:documentation>

</xs:annotation></xs:element><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

Primary key used to identify this particular entry. If this attribute is not specified, an identifier willbe

generated by hashing the parent Component identifier, Root, Key, and Name.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Action"><xs:annotation><xs:documentation>

This is the action that will be taken for this registry value.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="create"><xs:annotation><xs:documentation>

Creates the key, if absent, when the parent component is installed.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="createAndRemoveOnUninstall"><xs:annotation><xs:documentation>

Creates the key, if absent, when the parent component is installed then remove the keywith all its values and subkeys when the parent component is uninstalled.

</xs:documentation></xs:annotation>

</xs:enumeration>

368

Page 369: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:enumeration value="none"><xs:annotation><xs:documentation>

Does nothing; this element is used merely in WiX authoring for organization and doesnothing to the final output.

This is the default value.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Key" type="xs:string"><xs:annotation><xs:documentation>

The localizable key for the registry value.If the parent element is a RegistryKey, this value may be omitted to use thepath of the parent, or if its specified it will be appended to the path of the parent.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Root" type="RegistryRootType"><xs:annotation><xs:documentation>

The predefined root key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

369

Page 370: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegistrySearch

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Signature to be used for the file,directory or registry key beingsearched for.

Root NMTOKEN(restriction)

Yes Root key for the registry value.

Key string Yes Key for the registry value.

Name string No Registry value name.

Type NMTOKEN(restriction)

Yes The value must be 'file' if the lastchild is a FileSearch element andmust be 'directory' if last child is aDirectorySearch element.

Win64 YesNoType No Instructs the search to look in the64-bit registry when the value is'yes'.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

DirectorySearch anyType (restriction) 1..1 Searches for directory and assigns to value ofparent Property.

DirectorySearchRef anyType (restriction) 1..1 References an existing DirectorySearchelement.

FileSearch anyType (restriction) 1..1 Searches for file and assigns to fullpath valueof parent Property

FileSearchRef anyType (restriction) 1..1 References an existing FileSearch element.

Definition

<xs:element name="RegistrySearch"><xs:annotation><xs:appinfo><xse:seeAlso ref="ComponentSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="IniFileSearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RegLocator" href="http://msdn.microsoft.com/library/aa371171.aspx"

370

Page 371: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="read_a_registry_entry.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Read a registry entryduring installation</xse:howtoRef>

</xs:appinfo><xs:documentation>Searches for file, directory or registry key and assigns to value of parent

Property</xs:documentation></xs:annotation><xs:complexType><xs:choice minOccurs="0"><xs:element ref="DirectorySearch" /><xs:element ref="DirectorySearchRef" /><xs:element ref="FileSearch" /><xs:element ref="FileSearchRef" />

</xs:choice><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Signature to be used for the file, directory or registry key being searched

for.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Root" use="required"><xs:annotation><xs:documentation>Root key for the registry value.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="HKCR"><xs:annotation><xs:documentation>

HKEY_CLASSES_ROOT</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="HKCU"><xs:annotation><xs:documentation>

HKEY_CURRENT_USER</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="HKLM"><xs:annotation><xs:documentation>

HKEY_LOCAL_MACHINE</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="HKU"><xs:annotation><xs:documentation>

HKEY_USERS</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute>

371

Page 372: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="Key" use="required" type="xs:string"><xs:annotation><xs:documentation>Key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string"><xs:annotation><xs:documentation>Registry value name.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Type" use="required"><xs:annotation><xs:documentation>

The value must be 'file' if the last child is a FileSearch element and must be 'directory' if last childis a DirectorySearch element.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="directory"><xs:annotation><xs:documentation>

Sets a directory path from the registry value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="file"><xs:annotation><xs:documentation>

Sets a file path from the registry value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="raw"><xs:annotation><xs:documentation>

Sets the raw value from the registry value. Please note that this value will contain aprefix as follows:<html:br xmlns:html="http://www.w3.org/1999/xhtml" />

DWORD: Starts with '#' optionally followed by '+' or '-'.<html:brxmlns:html="http://www.w3.org/1999/xhtml" />

REG_BINARY: Starts with '#x' and the installer converts and saves each hexadecimaldigit (nibble) as an ASCII character prefixed by '#x'.<html:br xmlns:html="http://www.w3.org/1999/xhtml" />

REG_EXPAND_SZ: Starts with '#%'.<html:br xmlns:html="http://www.w3.org/1999/xhtml"/>

REG_MULTI_SZ: Starts with '[~]' and ends with '[~]'.<html:brxmlns:html="http://www.w3.org/1999/xhtml" />

REG_SZ: No prefix, but if the first character of the registry value is '#', the installerescapes the character by prefixing it with another '#'.<html:br xmlns:html="http://www.w3.org/1999/xhtml"/></xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Win64" type="YesNoType"><xs:annotation><xs:documentation>Instructs the search to look in the 64-bit registry when the value is 'yes'. Default is 'no'

and search looks in the 32-bit registry.</xs:documentation></xs:annotation>

</xs:attribute>

372

Page 373: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:complexType></xs:element>

373

Page 374: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegistrySearchRef

Description

References an existing RegistrySearch element.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Specify the Id of the RegistrySearchto reference.

Content Model

Always empty.

Definition

<xs:element name="RegistrySearchRef"><xs:annotation><xs:appinfo><xse:seeAlso ref="RegistrySearch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>References an existing RegistrySearch element.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Specify the Id of the RegistrySearch to reference.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

374

Page 375: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RegistryValue

Description

Used to create a registry value. For multi-string values, this can be used to prepend or append values.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Primary key used to identify thisparticular entry.

Root RegistryRootType

No The predefined root key for theregistry value.

Key string No The localizable key for the registryvalue.

Name string No The localizable registry value name.

Value string No Set this attribute to the localizableregistry value.

Type NMTOKEN(restriction)

No Set this attribute to the type of thedesired registry key.

Action NMTOKEN(restriction)

No This is the action that will be takenfor this registry value.

KeyPath YesNoType No Set this attribute to 'yes' to make thisregistry key the KeyPath of theparent component.

Content Model

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

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

MultiStringValue anyType 1..1 Use several of these elements to specify eachregistry value in a multiString registry value.

Permission anyType (restriction) 1..1 Sets ACLs on File, Registry, or CreateFolder.

Referenced By

● Element Component

● Element Registry

● Element RegistryKey

Remarks

For legacy authoring: Use several of these elements to specify each registry value in a multiString registry

375

Page 376: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Remarks

value. This elementcannot be used if the Value attribute is specified unless the Type attribute is set to 'multiString'. The valuesshould go in the text area of the RegistryValue element.

Definition

<xs:element name="RegistryValue"><xs:annotation><xs:documentation>

Used to create a registry value. For multi-string values, this can be used to prepend or appendvalues.

For legacy authoring: Use several of these elements to specify each registry value in a multiStringregistry value. This element

cannot be used if the Value attribute is specified unless the Type attribute is set to 'multiString'. Thevalues should go in the text area of the RegistryValue element.

</xs:documentation><xs:appinfo><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="write_a_registry_entry.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Write a registry entryduring installation</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType mixed="true"><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="Permission" /><xs:element ref="MultiStringValue" /><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

Primary key used to identify this particular entry. If this attribute is not specified, an identifier willbe

generated by hashing the parent Component identifier, Root, Key, and Name.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Root" type="RegistryRootType"><xs:annotation><xs:documentation>

The predefined root key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Key" type="xs:string"><xs:annotation><xs:documentation>

The localizable key for the registry value.If the parent element is a RegistryKey, this value may be omitted to use the

376

Page 377: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

path of the parent, or if its specified it will be appended to the path of the parent.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string"><xs:annotation><xs:documentation>

The localizable registry value name. If this attribute is not provided the default value for theregistry key will

be set instead. The Windows Installer allows several special values to be set for this attribute.You should not

use them in WiX. Instead use appropriate values in the Action attribute to get the desiredbehavior.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

Set this attribute to the localizable registry value. This value is formatted. The Windows Installerallows

several special values to be set for this attribute. You should not use them in WiX. Instead useappropriate

values in the Type attribute to get the desired behavior.</xs:documentation>

</xs:annotation></xs:attribute><!-- unfortunately, this attribute cannot yet be set to required due to backwards-compatibility, once the

Registry element is removed, this should be required --><xs:attribute name="Type"><xs:annotation><xs:documentation>

Set this attribute to the type of the desired registry key. This attribute must be specifiedwhenever the Value

attribute or a child RegistryValue element is specified. This attributeshould only be set when the value of the Action attribute does not include the word 'remove'.

</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="string"><xs:annotation><xs:documentation>

The value is interpreted and stored as a string (REG_SZ).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="integer"><xs:annotation><xs:documentation>

The value is interpreted and stored as an integer (REG_DWORD).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="binary"><xs:annotation><xs:documentation>

The value is interpreted and stored as a hexadecimal value (REG_BINARY).</xs:documentation>

</xs:annotation>

377

Page 378: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:enumeration><xs:enumeration value="expandable"><xs:annotation><xs:documentation>

The value is interpreted and stored as an expandable string (REG_EXPAND_SZ).</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="multiString"><xs:annotation><xs:documentation>

The value is interpreted and stored as a multiple strings (REG_MULTI_SZ).Please note that this value will only result in a multi-string value if there is more than one

registry valueor the Action attribute's value is 'append' or 'prepend'. Otherwise a string value will be

created.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Action"><xs:annotation><xs:documentation>

This is the action that will be taken for this registry value.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="append"><xs:annotation><xs:documentation>

Appends the specified value(s) to a multiString registry value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="prepend"><xs:annotation><xs:documentation>

Prepends the specified value(s) to a multiString registry value.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="write"><xs:annotation><xs:documentation>

Writes a registry value. This is the default value.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="KeyPath" type="YesNoType"><xs:annotation><xs:documentation>

Set this attribute to 'yes' to make this registry key the KeyPath of the parent component.Only one resource (registry, file, etc) can be the KeyPath of a component.

</xs:documentation>

378

Page 379: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

379

Page 380: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveDuplicateFiles

Description

Deletes files installed by the DuplicateFiles action.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveDuplicateFiles" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveDuplicateFiles" href="http://msdn.microsoft.com/library/aa371195.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Deletes files installed by the DuplicateFiles action. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

380

Page 381: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveEnvironmentStrings

Description

Modifies the values of environment variables.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveEnvironmentStrings" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveEnvironmentStrings" href="http://msdn.microsoft.com/library/aa371196.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Modifies the values of environment variables. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

381

Page 382: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveExistingProducts

Description

Goes through the product codes listed in the ActionProperty column of the Upgrade table and removes theproducts in sequence.

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveExistingProducts" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveExistingProducts" href="http://msdn.microsoft.com/library/aa371197.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Goes through the product codes listed in the ActionProperty column of the Upgrade table

and removes the products in sequence. Special actions don't have a built-in sequence number and thus mustappear 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 andInstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

382

Page 383: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveFile

Description

Remove a file(s) if the parent component is selected for installation or removal.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Primary key used to identify thisparticular entry.

Directory string No Overrides the directory of the parentcomponent with a specific Directory.

Property string No Overrides the directory of the parentcomponent with the value of thespecified property.

Name WildCardLongFileNameType

Yes This value should be set to thelocalizable name of the file(s) to beremoved.

LongName WildCardLongFileNameType

No

ShortName WildCardShortFileNameType

No The short file name of the file in 8.3format.

On NMTOKEN(restriction)

Yes This value determines the time atwhich the file(s) may be removed.

Content Model

Always empty.

Referenced By

● Element Component

Remarks

Multiple files can be removed by specifying a wildcard for the value of the Name attribute. By default, the sourcedirectory of the file is the directory of the parent component. This can be overridden by specifying the Directoryattribute with a value corresponding to the Id of the source directory, or by specifying the Property attribute witha value corresponding to a property that will have a value that resolves to the full path to the source directory.

Definition

<xs:element name="RemoveFile"><xs:annotation><xs:appinfo><xse:seeAlso ref="CopyFile" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RemoveFile" href="http://msdn.microsoft.com/library/aa371201.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

383

Page 384: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Remove a file(s) if the parent component is selected for installation or removal. Multiple files can be

removedby specifying a wildcard for the value of the Name attribute. By default, the sourcedirectory of the file is the directory of the parent component. This can be overridden by specifying theDirectory attribute with a value corresponding to the Id of the source directory, or by specifying the

Propertyattribute with a value corresponding to a property that will have a value that resolves to the full pathto the source directory.

</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Primary key used to identify this particular entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>

Overrides the directory of the parent component with a specific Directory. This Directory must existin the

installer database at creation time. This attribute cannot be specified in conjunction with theProperty attribute.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Property" type="xs:string"><xs:annotation><xs:documentation>

Overrides the directory of the parent component with the value of the specified property. Theproperty

should have a value that resolves to the full path of the source directory. The property does nothave

to exist in the installer database at creation time; it could be created at installation time by a customaction, on the command line, etc. This attribute cannot be specified in conjunction with the

Directory attribute.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="WildCardLongFileNameType" use="required"><xs:annotation><xs:documentation>

This value should be set to the localizable name of the file(s) to be removed. All of the files thatmatch the wild card will be removed from the specified directory. The value is a filename that may

alsocontain the wild card characters "?" for any single character or "*" for zero or more occurrences of

any character.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.If a short file name is specified, the ShortName attribute may not be specified.If a long file name is specified, the LongName attribute may not be specified.Also, if this value is a long file name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short file name.However, if you wish to manually specify the short file name, then the ShortName attribute may be

specified.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LongName" type="WildCardLongFileNameType">

384

Page 385: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="ShortName" type="WildCardShortFileNameType"><xs:annotation><xs:documentation>

The short file name of the file in 8.3 format.This attribute should only be set if you want to manually specify the short file name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="On" use="required"><xs:annotation><xs:documentation>

This value determines the time at which the file(s) may be removed.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="install"><xs:annotation><xs:documentation>

Removes the file only when the parent component is being installed (msiInstallStateLocalor msiInstallStateSource).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="uninstall"><xs:annotation><xs:documentation>

Removes the file only when the parent component is being removed(msiInstallStateAbsent).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="both"><xs:annotation><xs:documentation>

Removes the file when the parent component is being installed or removed.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute></xs:complexType>

</xs:element>

385

Page 386: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveFiles

Description

Removes files previously installed by the InstallFiles action.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveFiles" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveFiles" href="http://msdn.microsoft.com/library/aa371199.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes files previously installed by the InstallFiles action. The condition for this action

may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

386

Page 387: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveFolder

Description

Remove an empty folder if the parent component is selected for installation or removal.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Primary key used to identify thisparticular entry.

Directory string No Overrides the directory of the parentcomponent with a specific Directory.

Property string No Overrides the directory of the parentcomponent with the value of thespecified property.

On NMTOKEN(restriction)

Yes This value determines the time atwhich the folder may be removed.

Content Model

Always empty.

Referenced By

● Element Component

Remarks

By default, the folder is the directory of the parent component. This can be overridden by specifying theDirectory attribute with a value corresponding to the Id of the directory, or by specifying the Property attributewith a value corresponding to a property that will have a value that resolves to the full path of the folder.

Definition

<xs:element name="RemoveFolder"><xs:annotation><xs:appinfo><xse:seeAlso ref="CreateFolder"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RemoveFile" href="http://msdn.microsoft.com/library/aa371201.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

Remove an empty folder if the parent component is selected for installation or removal. By default,the folder

is the directory of the parent component. This can be overridden by specifying the Directory attributewith a value corresponding to the Id of the directory, or by specifying the Property attribute with a

valuecorresponding to a property that will have a value that resolves to the full path of the folder.

</xs:documentation></xs:annotation>

387

Page 388: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Primary key used to identify this particular entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>

Overrides the directory of the parent component with a specific Directory. This Directory must existin the

installer database at creation time. This attribute cannot be specified in conjunction with theProperty attribute.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Property" type="xs:string"><xs:annotation><xs:documentation>

Overrides the directory of the parent component with the value of the specified property. Theproperty

should have a value that resolves to the full path of the source directory. The property does nothave

to exist in the installer database at creation time; it could be created at installation time by a customaction, on the command line, etc. This attribute cannot be specified in conjunction with the

Directory attribute.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="On" use="required"><xs:annotation><xs:documentation>

This value determines the time at which the folder may be removed.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="install"><xs:annotation><xs:documentation>

Removes the folder only when the parent component is being installed(msiInstallStateLocal or msiInstallStateSource).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="uninstall"><xs:annotation><xs:documentation>

Removes the folder only when the parent component is being removed(msiInstallStateAbsent).

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="both"><xs:annotation><xs:documentation>

Removes the folder when the parent component is being installed or removed.</xs:documentation>

</xs:annotation></xs:enumeration>

388

Page 389: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:restriction></xs:simpleType>

</xs:attribute></xs:complexType>

</xs:element>

389

Page 390: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveFolders

Description

Removes any folders linked to components set to be removed or run from source.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveFolders" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveFolders" href="http://msdn.microsoft.com/library/aa371202.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes any folders linked to components set to be removed or run from source. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

390

Page 391: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveIniValues

Description

Removes .ini file information specified for removal in the RemoveIniFile table if the component is set to beinstalled locally or run from source.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveIniValues" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveIniValues" href="http://msdn.microsoft.com/library/aa371205.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes .ini file information specified for removal in the RemoveIniFile table if the

component is set to be installed locally or run from source. The condition for this action may be specified in theelement's inner text.</xs:documentation></xs:annotation>

</xs:element>

391

Page 392: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveODBC

Description

Removes the data sources, translators, and drivers listed for removal during the installation.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveODBC" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveODBC" href="http://msdn.microsoft.com/library/aa371206.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes the data sources, translators, and drivers listed for removal during the

installation. The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

392

Page 393: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveRegistryKey

Description

Used for removing registry keys and all child keys either during install or uninstall.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Primary key used to identify thisparticular entry.

Action NMTOKEN(restriction)

No This is the action that will be takenfor this registry value.

Key string No The localizable key for the registryvalue.

Root RegistryRootType

No The predefined root key for theregistry value.

Content Model

Always empty.

Referenced By

● Element Component

Definition

<xs:element name="RemoveRegistryKey"><xs:annotation><xs:documentation>

Used for removing registry keys and all child keys either during install or uninstall.</xs:documentation>

<xs:appinfo><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="RemoveRegistry" href="http://msdn.microsoft.com/library/aa371208.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

Primary key used to identify this particular entry. If this attribute is not specified, an identifier willbe

generated by hashing the parent Component identifier, Root, Key, and Name.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Action"><xs:annotation><xs:documentation>

393

Page 394: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

This is the action that will be taken for this registry value.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="removeOnInstall"><xs:annotation><xs:documentation>

Removes a key with all its values and subkeys when the parent component is installed.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="removeOnUninstall"><xs:annotation><xs:documentation>

Removes a key with all its values and subkeys when the parent component isuninstalled.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Key" type="xs:string"><xs:annotation><xs:documentation>

The localizable key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Root" type="RegistryRootType"><xs:annotation><xs:documentation>

The predefined root key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

394

Page 395: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveRegistryValue

Description

Used to remove a registry value during installation.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No Primary key used to identify thisparticular entry.

Key string No The localizable key for the registryvalue.

Name string No The localizable registry value name.

Root RegistryRootType

No The predefined root key for theregistry value.

Content Model

Always empty.

Referenced By

● Element Component

Remarks

There is no standard way to remove a single registry value during uninstall (but you can remove an entire keywith RemoveRegistryKey).

Definition

<xs:element name="RemoveRegistryValue"><xs:annotation><xs:documentation>

Used to remove a registry value during installation.There is no standard way to remove a single registry value during uninstall (but you can remove an

entire key with RemoveRegistryKey).</xs:documentation>

<xs:appinfo><xse:msiRef table="RemoveRegistry" href="http://msdn.microsoft.com/library/aa371208.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

Primary key used to identify this particular entry. If this attribute is not specified, an identifier willbe

generated by hashing the parent Component identifier, Root, Key, and Name.</xs:documentation>

395

Page 396: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Key" type="xs:string"><xs:annotation><xs:documentation>

The localizable key for the registry value.If the parent element is a RegistryKey, this value may be omitted to use thepath of the parent, or if its specified it will be appended to the path of the parent.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Name" type="xs:string"><xs:annotation><xs:documentation>

The localizable registry value name. If this attribute is not provided the default value for theregistry key will

be set instead. The Windows Installer allows several special values to be set for this attribute.You should not

use them in WiX. Instead use appropriate values in the Action attribute to get the desiredbehavior.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Root" type="RegistryRootType"><xs:annotation><xs:documentation>

The predefined root key for the registry value.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

396

Page 397: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveRegistryValues

Description

Removes a registry value that has been authored into the registry table if the associated component wasinstalled locally or as run from source, and is now set to be uninstalled.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveRegistryValues" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveRegistryValues" href="http://msdn.microsoft.com/library/aa371207.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>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. The condition for thisaction may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

397

Page 398: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RemoveShortcuts

Description

Manages the removal of an advertised shortcut whose feature is selected for uninstallation or a nonadvertisedshortcut whose component is selected for uninstallation.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="RemoveShortcuts" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="RemoveShortcuts" href="http://msdn.microsoft.com/library/aa371209.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the removal of an advertised shortcut whose feature is selected for

uninstallation or a nonadvertised shortcut whose component is selected for uninstallation. The condition for thisaction may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

398

Page 399: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ReplacePatch

Description

A patch that is deprecated by this patch.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes Patch GUID to be unregistered if itexists on the machine targeted bythis patch.

Content Model

Always empty.

Definition

<xs:element name="ReplacePatch"><xs:annotation><xs:documentation>A patch that is deprecated by this patch.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="Guid" use="required"><xs:annotation><xs:documentation>Patch GUID to be unregistered if it exists on the machine targeted by this

patch.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

399

Page 400: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ReserveCost

Description

Disk cost to reserve in a folder for running locally and/or from source.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes A primary key that uniquely identifiesthis ReserveCost entry.

Directory string No Adds the amount of disk spacespecified in RunFromSource orRunLocal to the volume cost of thedevice containing the directory.

RunFromSource integer Yes The number of bytes of disk space toreserve if the component is installedto run from source.

RunLocal integer Yes The number of bytes of disk space toreserve if the component is installedto run locally.

Content Model

Always empty.

Referenced By

● Element Component

Definition

<xs:element name="ReserveCost"><xs:annotation><xs:documentation>

Disk cost to reserve in a folder for running locally and/or from source.</xs:documentation>

<xs:appinfo><xse:msiRef table="ReserveCost" href="http://msdn.microsoft.com/library/aa371226.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>A primary key that uniquely identifies this ReserveCost entry.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>

Adds the amount of disk space specified in RunFromSource or RunLocal to the volume cost ofthe device containing the directory.

400

Page 401: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

If this attribute is not set, it will default to the directory of parent component.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="RunFromSource" type="xs:integer" use="required"><xs:annotation><xs:documentation>The number of bytes of disk space to reserve if the component is installed to run from

source.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="RunLocal" type="xs:integer" use="required"><xs:annotation><xs:documentation>The number of bytes of disk space to reserve if the component is installed to run

locally.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

401

Page 402: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ResolveSource

Description

Determines the location of the source and sets the SourceDir property if the source has not been resolved yet.

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element AdminExecuteSequence

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

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

Definition

<xs:element name="ResolveSource" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="ResolveSource" href="http://msdn.microsoft.com/library/aa371232.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Determines the location of the source and sets the SourceDir property if the source has

not been resolved yet. Special actions don't have a built-in sequence number and thus must appear relative toanother action. The suggested way to do this is by using the Before or After attribute. InstallExecute andInstallExecuteAgain can optionally appear anywhere between InstallInitialize andInstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

402

Page 403: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: RMCCPSearch

Description

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

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

The RMCCPSearch action should be authored into the InstallUISequence table and InstallExecuteSequencetable. The installer prevents RMCCPSearch from running in the InstallExecuteSequence sequence if the actionhas already run in InstallUISequence sequence. The RMCCPSearch action requires the CCP_DRIVE propertyto be set to the root path on the removable volume that has the installation for any of the qualifying products.The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="RMCCPSearch" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:seeAlso ref="CCPSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/><xse:seeAlso ref="ComplianceCheck"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef action="RMCCPSearch" href="http://msdn.microsoft.com/library/aa371364.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Uses file signatures to validate that qualifying products are installed on a system before

403

Page 404: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

an upgrade installation is performed. The RMCCPSearch action should be authored into the InstallUISequencetable and InstallExecuteSequence table. The installer prevents RMCCPSearch from running in theInstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. TheRMCCPSearch action requires the CCP_DRIVE property to be set to the root path on the removable volumethat has the installation for any of the qualifying products. The condition for this action may be specified in theelement's inner text.</xs:documentation></xs:annotation>

</xs:element>

404

Page 405: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Row

Description

Row data for a Custom Table

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Data string (extension) 1..* Used for a Custom Table. Specifies the datafor the parent Row and specified Column.

Referenced By

● Element CustomTable

Definition

<xs:element name="Row"><xs:annotation><xs:documentation>Row data for a Custom Table</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="Data" maxOccurs="unbounded" />

</xs:sequence></xs:complexType>

</xs:element>

405

Page 406: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ScheduleReboot

Description

Prompts the user to restart the system at the end of installation.

Derived By

Type ActionModuleSequenceType

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

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

Definition

<xs:element name="ScheduleReboot" type="ActionModuleSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="ScheduleReboot" href="http://msdn.microsoft.com/library/aa371527.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Prompts the user to restart the system at the end of installation. Special actions don't

have a built-in sequence number and thus must appear relative to another action. The suggested way to dothis is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appearanywhere between InstallInitialize and InstallFinalize.</xs:documentation></xs:annotation>

</xs:element>

406

Page 407: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SelfRegModules

Description

Processes all modules listed in the SelfReg table and registers all installed modules with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="SelfRegModules" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="SelfRegModules" href="http://msdn.microsoft.com/library/aa371607.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Processes all modules listed in the SelfReg table and registers all installed modules with

the system. The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

407

Page 408: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SelfUnregModules

Description

Unregisters all modules listed in the SelfReg table that are scheduled to be uninstalled.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="SelfUnregModules" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="SelfUnregModules" href="http://msdn.microsoft.com/library/aa371610.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Unregisters all modules listed in the SelfReg table that are scheduled to be uninstalled.

The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

408

Page 409: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ServiceArgument

Description

Argument used in ServiceControl parent

Derived By

Type string

Referenced By

● Element ServiceControl

Definition

<xs:element name="ServiceArgument" type="xs:string"><xs:annotation><xs:documentation>

Argument used in ServiceControl parent</xs:documentation>

<xs:appinfo><xse:msiRef table="ServiceControl" href="http://msdn.microsoft.com/library/aa371634.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:element>

409

Page 410: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ServiceControl

Description

Starts, stops, and removes services for parent Component.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

Name string Yes Name of the service.

Start NMTOKEN(restriction)

No Specifies whether the service shouldbe started on install, uninstall orboth.

Stop NMTOKEN(restriction)

No Specifies whether the service shouldbe stopped on install, uninstall orboth.

Remove NMTOKEN(restriction)

No Specifies whether the service shouldbe removed on install, uninstall orboth.

Wait YesNoType No Specifies whether or not to wait forthe service to complete beforecontinuing.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ServiceArgument string 0..* Argument used in ServiceControl parent

Referenced By

● Element Component

Remarks

This element is used to control the stateof a service installed by the MSI or MSM file by using the start, stop and remove attributes.For example, Start='install' Stop='both' Remove='uninstall' would mean: start the service on install,remove the service when the product is uninstalled, and stop the service both on install and uninstall.

Definition

<xs:element name="ServiceControl"><xs:annotation><xs:documentation>

Starts, stops, and removes services for parent Component. This element is used to control the state

410

Page 411: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

of a service installed by the MSI or MSM file by using the start, stop and remove attributes.For example, Start='install' Stop='both' Remove='uninstall' would mean: start the service on install,remove the service when the product is uninstalled, and stop the service both on install and uninstall.

</xs:documentation><xs:appinfo><xse:msiRef table="ServiceControl" href="http://msdn.microsoft.com/library/aa371634.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="ServiceArgument" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Ordered list of arguments used when modifying services.</xs:documentation>

</xs:annotation></xs:element>

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required" /><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>Name of the service.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Start"><xs:annotation><xs:documentation>Specifies whether the service should be started on install, uninstall or

both.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="install"><xs:annotation><xs:documentation>

The service will be started by the StartServices action during install.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="uninstall"><xs:annotation><xs:documentation>

The service will be started by the StartServices action during uninstall.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="both"><xs:annotation><xs:documentation>

The service will be started by the StartServices action during install and uninstall.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Stop"><xs:annotation><xs:documentation>Specifies whether the service should be stopped on install, uninstall or

both.</xs:documentation></xs:annotation><xs:simpleType>

411

Page 412: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:restriction base="xs:NMTOKEN"><xs:enumeration value="install"><xs:annotation><xs:documentation>

The service will be stopped by the StopServices action during install.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="uninstall"><xs:annotation><xs:documentation>

The service will be stopped by the StopServices action during uninstall.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="both"><xs:annotation><xs:documentation>

The service will be stopped by the StopServices action during install and uninstall.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Remove"><xs:annotation><xs:documentation>Specifies whether the service should be removed on install, uninstall or

both.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="install"><xs:annotation><xs:documentation>

The service will be deleted by the DeleteServices action during install.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="uninstall"><xs:annotation><xs:documentation>

The service will be deleted by the DeleteServices action during uninstall.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="both"><xs:annotation><xs:documentation>

The service will be deleted by the DeleteServices action during install and uninstall.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Wait" type="YesNoType"><xs:annotation><xs:documentation>Specifies whether or not to wait for the service to complete before

continuing.</xs:documentation>

412

Page 413: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

413

Page 414: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ServiceDependency

Description

Service or group of services that must start before the parent service.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

Group YesNoType No Set to 'yes' to indicate that the valuein the Id attribute is the name of agroup of services.

Content Model

Always empty.

Referenced By

● Element ServiceInstall

Definition

<xs:element name="ServiceDependency"><xs:annotation><xs:documentation>

Service or group of services that must start before the parent service.</xs:documentation>

<xs:appinfo><xse:msiRef table="ServiceInstall" href="http://msdn.microsoft.com/library/aa371637.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>

The value of this attribute should be one of the following:<html:ol xmlns:html="http://www.w3.org/1999/xhtml"><html:li>The name (not the display name)

of a previously installed service.</html:li><html:li>A foreign key referring to anotherServiceInstall/@Id.</html:li><html:li>A group of services (in which case the Group attribute should be set to'yes').</html:li></html:ol></xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Group" type="YesNoType"><xs:annotation><xs:documentation>

Set to 'yes' to indicate that the value in the Id attribute is the name of a group of services.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

414

Page 415: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ServiceInstall

Description

Adds and removes services for parent Component.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for this service.

Name string Yes This column is the string that givesthe service name to install.

DisplayName string No This column is the localizable stringthat user interface programs use toidentify the service.

Type NMTOKEN(restriction)

Yes The Windows Installer does notcurrently support kernelDriver orsystemDriver

Interactive YesNoType No Whether or not the service interactswith the desktop.

Start NMTOKEN(restriction)

Yes Determines when the service shouldbe started.

ErrorControl NMTOKEN(restriction)

Yes Determines what action should betaken on an error.

Vital YesNoType No The overall install should fail if thisservice fails to install.

LoadOrderGroup string No The load ordering group that thisservice should be a part of.

Account string No The acount under which to start theservice. Valid only whenServiceType is ownProcess.

Password string No The password for the account. Validonly when the account has apassword.

Arguments string No Contains any command linearguments or properties required torun the service.

Description string No Sets the description of the service.

EraseDescription YesNoType No Determines whether the existingservice description will be ignored.

Content Model

Contains elements as defined in the following table.

415

Page 416: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

0..*

any 1..1 Allow any element from the ##othernamespace.

ServiceDependency anyType (restriction) 1..1 Service or group of services that must startbefore the parent service.

Referenced By

● Element Component

Definition

<xs:element name="ServiceInstall"><xs:annotation><xs:documentation>

Adds and removes services for parent Component.</xs:documentation>

<xs:appinfo><xse:msiRef table="ServiceInstall" href="http://msdn.microsoft.com/library/aa371637.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">

The service executable installed will point to the KeyPath for the Component.Therefore, you must ensure that the correct executable is either the first childFile element under this Component or explicitly mark the appropriate File elementas KeyPath='yes'.

</xse:remarks></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="ServiceDependency"><xs:annotation><xs:documentation>ordered list of dependencies when installing services</xs:documentation>

</xs:annotation></xs:element><xs:any namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalelements at this point in the schema.

</xs:documentation></xs:annotation>

</xs:any></xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for this service.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="xs:string" use="required"><xs:annotation><xs:documentation>This column is the string that gives the service name to install.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DisplayName" type="xs:string"><xs:annotation>

416

Page 417: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>This column is the localizable string that user interface programs use to identify theservice.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Type" use="required"><xs:annotation><xs:documentation>The Windows Installer does not currently support kernelDriver or

systemDriver</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="ownProcess"><xs:annotation><xs:documentation>

A Win32 service that runs its own process.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="shareProcess"><xs:annotation><xs:documentation>

A Win32 service that shares a process.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="kernelDriver"><xs:annotation><xs:documentation>

A kernel driver service. This value is not currently supported by the Windows Installer.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="systemDriver"><xs:annotation><xs:documentation>

A file system driver service. This value is not currently supported by the WindowsInstaller.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Interactive" type="YesNoType"><xs:annotation><xs:documentation>Whether or not the service interacts with the desktop.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Start" use="required"><xs:annotation><xs:documentation>Determines when the service should be started. The Windows Installer does not

support boot or system.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="auto"><xs:annotation><xs:documentation>

The service will start during startup of the system.</xs:documentation>

417

Page 418: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:enumeration><xs:enumeration value="demand"><xs:annotation><xs:documentation>

The service will start when the service control manager calls the StartService function.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="disabled"><xs:annotation><xs:documentation>

The service can no longer be started.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="boot"><xs:annotation><xs:documentation>

The service is a device driver that will be started by the operating system boot loader.This value is not currently supported by the Windows Installer.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="system"><xs:annotation><xs:documentation>

The service is a device driver that will be started by the IoInitSystem function. This valueis not currently supported by the Windows Installer.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="ErrorControl" use="required"><xs:annotation><xs:documentation>Determines what action should be taken on an error.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="ignore"><xs:annotation><xs:documentation>

Logs the error and continues with the startup operation.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="normal"><xs:annotation><xs:documentation>

Logs the error, displays a message box and continues the startup operation.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="critical"><xs:annotation><xs:documentation>

Logs the error if it is possible and the system is restarted with the last configurationknown to be good. If the last-known-good configuration is being started, the startup operation fails.

418

Page 419: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Vital" type="YesNoType"><xs:annotation><xs:documentation>The overall install should fail if this service fails to install.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="LoadOrderGroup" type="xs:string"><xs:annotation><xs:documentation>The load ordering group that this service should be a part of.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Account" type="xs:string"><xs:annotation><xs:documentation>The acount under which to start the service. Valid only when ServiceType is

ownProcess.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Password" type="xs:string"><xs:annotation><xs:documentation>The password for the account. Valid only when the account has a

password.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Arguments" type="xs:string"><xs:annotation><xs:documentation>Contains any command line arguments or properties required to run the

service.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>Sets the description of the service.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="EraseDescription" type="YesNoType"><xs:annotation><xs:documentation>Determines whether the existing service description will be ignored. If 'yes', the

service description will be null, even if the Description attribute is set.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

419

Page 420: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SetDirectory

Description

Sets a Directory to a particular value.

Derived By

Extending string

Attributes

Name Type Required? Default Description

Id string No This attribute specifies a reference toa Directory element with matching Idattribute.

Sequence NMTOKEN(restriction)

No Controls which sequences theDirectory assignment is sequencedin.

Value string No This attribute specifies a string valueto assign to the Directory.

Content Model

Contains text only.

Referenced By

● Element Fragment

Remarks

This is accomplished by creating a Type 51 custom action that is appropriately scheduled inthe InstallUISequence and InstallExecuteSequence.

Definition

<xs:element name="SetDirectory"><xs:annotation><xs:appinfo><xse:seeAlso ref="Custom" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="CustomActionRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="InstallUISequence"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="InstallExecuteSequence"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="CustomAction" href="http://msdn.microsoft.com/library/aa368062.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

Sets a Directory to a particular value. This is accomplished by creating a Type 51 custom action thatis appropriately scheduled in

the InstallUISequence and InstallExecuteSequence.</xs:documentation>

</xs:annotation><xs:complexType>

420

Page 421: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>

The condition that determines whether the Directory is set. If the condition evaluates to false, theSetDirectory is skipped.

</xs:documentation></xs:annotation><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a reference to a Directory element with matching Id attribute. Thepath of the Directory will be set to

the Value attribute.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Sequence"><xs:annotation><xs:documentation>

Controls which sequences the Directory assignment is sequenced in. The default is both.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="both"><xs:annotation><xs:documentation>

Schedules the assignment in the InstallUISequence and theInstallExecuteSequence.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="execute"><xs:annotation><xs:documentation>

Schedules the assignment only in the the InstallExecuteSequence.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="ui"><xs:annotation><xs:documentation>

Schedules the assignment only in the the InstallUISequence.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a string value to assign to the Directory. The value can be a literalvalue or derived from a

Property element using the <html:a href="http://msdn.microsoft.com/library/aa368609.aspx"target="_blank" xmlns:html="http://www.w3.org/1999/xhtml">Formatted</html:a>

syntax.</xs:documentation>

</xs:annotation>

421

Page 422: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:extension>

</xs:simpleContent></xs:complexType>

</xs:element>

422

Page 423: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SetODBCFolders

Description

Checks for existing ODBC drivers and sets the target directory for each new driver to the location of an existingdriver.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="SetODBCFolders" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="SetODBCFolders" href="http://msdn.microsoft.com/library/aa371691.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Checks for existing ODBC drivers and sets the target directory for each new driver to the

location of an existing driver. The condition for this action may be specified in the element's innertext.</xs:documentation></xs:annotation>

</xs:element>

423

Page 424: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SetProperty

Description

Sets a Property to a particular value.

Derived By

Extending string

Attributes

Name Type Required? Default Description

After string No The name of the standard or customaction after which this action shouldbe performed.

Before string No The name of the standard or customaction before which this actionshould be performed.

Id string No This attribute specifies the Propertyto set to the Value.

Sequence NMTOKEN(restriction)

No Controls which sequences theProperty assignment is sequencedin.

Value string No This attribute specifies a string valueto assign to the Property.

Content Model

Contains text only.

Referenced By

● Element Fragment

Remarks

This is accomplished by creating a Type 51 custom action that is appropriately scheduled inthe InstallUISequence and InstallExecuteSequence.

Definition

<xs:element name="SetProperty"><xs:annotation><xs:appinfo><xse:seeAlso ref="Custom" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="CustomActionRef"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="InstallUISequence"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:seeAlso ref="InstallExecuteSequence"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="CustomAction" href="http://msdn.microsoft.com/library/aa368062.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>

424

Page 425: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

Sets a Property to a particular value. This is accomplished by creating a Type 51 custom action thatis appropriately scheduled in

the InstallUISequence and InstallExecuteSequence.</xs:documentation>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>

The condition that determines whether the Property is set. If the condition evaluates to false, theSet is skipped.

</xs:documentation></xs:annotation><xs:attribute name="After" type="xs:string"><xs:annotation><xs:documentation>The name of the standard or custom action after which this action should be

performed. Mutually exclusive with the Before attribute. A Before or After attribute is required when setting aProperty.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Before" type="xs:string"><xs:annotation><xs:documentation>The name of the standard or custom action before which this action should be

performed. Mutually exclusive with the After attribute. A Before or After attribute is required when setting aProperty.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Id" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies the Property to set to the Value.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Sequence"><xs:annotation><xs:documentation>

Controls which sequences the Property assignment is sequenced in. The default is both.</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="both"><xs:annotation><xs:documentation>

Schedules the assignment in the InstallUISequence and theInstallExecuteSequence.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="execute"><xs:annotation><xs:documentation>

Schedules the assignment only in the the InstallExecuteSequence.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="ui"><xs:annotation>

425

Page 426: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Schedules the assignment only in the the InstallUISequence.

</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType></xs:attribute><xs:attribute name="Value" type="xs:string"><xs:annotation><xs:documentation>

This attribute specifies a string value to assign to the Property. The value can be a literalvalue or derived from a

Property element using the <html:a href="http://msdn.microsoft.com/library/aa368609.aspx"target="_blank" xmlns:html="http://www.w3.org/1999/xhtml">Formatted</html:a>

syntax.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:extension>

</xs:simpleContent></xs:complexType>

</xs:element>

426

Page 427: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SFPCatalog

Description

Adds a system file protection update catalog file

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Name string No Filename for catalog file wheninstalled.

Dependency string No Used to define dependency outsideof the package.

SourceFile string No Path to catalog file in binary.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

SFPCatalog anyType (restriction) 0..* Adds a system file protection update catalogfile

SFPFile anyType (restriction) 0..* Provides a many-to-many mapping from theSFPCatalog table to the File table

Referenced By

● Element Fragment

● Element SFPCatalog

Definition

<xs:element name="SFPCatalog"><xs:annotation><xs:documentation>

Adds a system file protection update catalog file</xs:documentation>

<xs:appinfo><xse:msiRef table="SFPCatalog" href="http://msdn.microsoft.com/library/aa371833.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="SFPCatalog" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="SFPFile" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Primary Key to File Table.</xs:documentation>

</xs:annotation></xs:element>

427

Page 428: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:choice><xs:attribute name="Name" type="xs:string"><xs:annotation><xs:documentation>Filename for catalog file when installed.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Dependency" type="xs:string"><xs:annotation><xs:documentation>Used to define dependency outside of the package.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Path to catalog file in binary.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

428

Page 429: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SFPFile

Description

Provides a many-to-many mapping from the SFPCatalog table to the File table

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Primary Key to File Table.

Content Model

Always empty.

Referenced By

● Element SFPCatalog

Definition

<xs:element name="SFPFile"><xs:annotation><xs:documentation>

Provides a many-to-many mapping from the SFPCatalog table to the File table</xs:documentation>

<xs:appinfo><xse:msiRef table="FileSFPCatalog" href="http://msdn.microsoft.com/library/aa368591.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" use="required" type="xs:string"><xs:annotation><xs:documentation>Primary Key to File Table.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

429

Page 430: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Shortcut

Description

Shortcut, default target is parent File, CreateFolder, or Component's Directory

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Unique identifier for the shortcut.

Directory string No Identifier reference to Directoryelement where shortcut is to becreated.

Name LongFileNameType

Yes In prior versions of the WiX toolset,this attribute specified the shortname. This attribute's value may nowbe either a short or long name.

LongName LongFileNameType

No

ShortName ShortFileNameType

No The short name of the shortcut in 8.3format.

Target string No This attribute can only be set if thisShortcut element is nested under aComponent element.

Description string No The localizable description for theshortcut.

Arguments string No The command-line arguments for theshortcut.

Hotkey integer No The hotkey for the shortcut.

Icon string No Identifier reference to Icon element.

IconIndex integer No Identifier reference to Icon element.

Show NMTOKEN(restriction)

No

WorkingDirectory string No Directory identifier (or Propertyidentifier that resolves to a directory)that resolves to the path of theworking directory for the shortcut.

Advertise YesNoType No Specifies if the shortcut should beadvertised or not.

DisplayResourceDll

string No The Formatted string providing thefull path to the language neutral filecontaining the MUI Manifest.

DisplayResourceId

integer No The display name index for theshortcut.

430

Page 431: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Type Required? Default Description

DescriptionResourceDll

string No The Formatted string providing thefull path to the language neutral filecontaining the MUI Manifest.

DescriptionResourceId

integer No The description name index for theshortcut.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Icon anyType (restriction) 0..1 Icon used for Shortcut, ProgId, or Classelements (but not UI controls)

Referenced By

● Element Component

● Element CreateFolder

● Element File

Definition

<xs:element name="Shortcut"><xs:annotation><xs:documentation>

Shortcut, default target is parent File, CreateFolder, or Component's Directory</xs:documentation>

<xs:appinfo><xse:msiRef table="Shortcut" href="http://msdn.microsoft.com/library/aa371847.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:howtoRef href="create_start_menu_shortcut.htm"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Create a shortcut on theStart Menu</xse:howtoRef>

</xs:appinfo></xs:annotation><xs:complexType><xs:sequence><xs:element ref="Icon" minOccurs="0" />

</xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Unique identifier for the shortcut. This value will serve as the primary key for the

row.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Directory" type="xs:string"><xs:annotation><xs:documentation>Identifier reference to Directory element where shortcut is to be created. When nested

under a Component element, this attribute's value will default to the parent directory. Otherwise, this attribute isrequired.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Name" type="LongFileNameType" use="required">

431

Page 432: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>

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.If a short name is specified, the ShortName attribute may not be specified.If a long name is specified, the LongName attribute may not be specified.Also, if this value is a long name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short name.However, if this name collides with another shortcut or you wish to manually specifythe short name, then the ShortName attribute may be specified.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="LongName" type="LongFileNameType"><xs:annotation><xs:appinfo><xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"

/></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="ShortName" type="ShortFileNameType"><xs:annotation><xs:documentation>

The short name of the shortcut in 8.3 format.This attribute should only be set if there is a conflict between generated short namesor the user wants to manually specify the short name.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Target" type="xs:string"><xs:annotation><xs:documentation>

This attribute can only be set if this Shortcut element is nested under a Component element.When nested under a Component element, this attribute's value will default to the parent

directory.This attribute's value is the target for a non-advertised shortcut.This attribute is not valid for advertised shortcuts.If you specify this value, its value should be a property identifier enclosed by square brackets ([

]), that is expanded into the file or a folder pointed to by the shortcut.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>The localizable description for the shortcut.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Arguments" type="xs:string"><xs:annotation><xs:documentation>The command-line arguments for the shortcut. Note that the resolution of properties

in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved ifthe

property already has the intended value when the component owning the shortcut is installed. Forexample, for the

argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the fileMyDoc.doc and

the component that owns the shortcut.</xs:documentation></xs:annotation>

</xs:attribute>

432

Page 433: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="Hotkey" type="xs:integer"><xs:annotation><xs:documentation>The hotkey for the shortcut. The low-order byte contains the virtual-key code for

the key, and the high-order byte contains modifier flags. This must be a non-negative number.Authors of

installation packages are generally recommend not to set this option, because this can add duplicatehotkeys to a

users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for usersusing hotkeys

for accessibility.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Icon" type="xs:string"><xs:annotation><xs:documentation>Identifier reference to Icon element. The Icon identifier should have the same

extensionas the file that it points at. For example, a shortcut to an executable (e.g. "my.exe") should reference

an Icon with identifierlike "MyIcon.exe"</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IconIndex" type="xs:integer"><xs:annotation><xs:documentation>Identifier reference to Icon element.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Show"><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="normal"><xs:annotation><xs:documentation>

The shortcut target will be displayed using the SW_SHOWNORMAL attribute.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="minimized"><xs:annotation><xs:documentation>

The shortcut target will be displayed using the SW_SHOWMINNOACTIVE attribute.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="maximized"><xs:annotation><xs:documentation>

The shortcut target will be displayed using the SW_SHOWMAXIMIZED attribute.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="WorkingDirectory" type="xs:string"><xs:annotation><xs:documentation>Directory identifier (or Property identifier that resolves to a directory) that resolves

to the path of the working directory for the shortcut.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Advertise" type="YesNoType">

433

Page 434: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>Specifies if the shortcut should be advertised or not. Note that advertised shortcuts

always point at a particular application, identified by a ProductCode, and should not be sharedbetween applications.

Advertised shortcuts only work for the most recently installed application, and are removed when thatapplication is

removed. The default value is 'no'.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="DisplayResourceDll" type="xs:string"><xs:annotation><xs:documentation>

The Formatted string providing the full path to the language neutral file containing the MUIManifest. Generally

authored using [#filekey] form. When this attribute is specified, the DisplayResourceId attributemust also

be provided.

This attribute is only used on Windows Vista and above. If this attribute is not populated and theinstall

is running on Vista and above, the value in the Name attribute is used. If this attribute ispopulated and

the install is running on Vista and above, the value in the Name attribute is ignored.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DisplayResourceId" type="xs:integer"><xs:annotation><xs:documentation>

The display name index for the shortcut. This must be a non-negative number. When thisattribute is specified, the

DisplayResourceDll attribute must also be proviced.

This attribute is only used on Windows Vista and above. If this attribute is not specified and theinstall

is running on Vista and above, the value in the Name attribute is used. If this attribute isspecified and

the install is running on Vista and above, the value in the Name attribute is ignored.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DescriptionResourceDll" type="xs:string"><xs:annotation><xs:documentation>

The Formatted string providing the full path to the language neutral file containing the MUIManifest. Generally

authored using [#filekey] form. When this attribute is specified, the DescriptionResourceIdattribute must also

be provided.

This attribute is only used on Windows Vista and above. If this attribute is not specified and theinstall

is running on Vista and above, the value in the Name attribute is used. If this attribute isprovided and

the install is running on Vista and above, the value in the Name attribute is ignored.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="DescriptionResourceId" type="xs:integer"><xs:annotation>

434

Page 435: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>The description name index for the shortcut. This must be a non-negative number. When this

attribute is specified,the DescriptionResourceDll attribute must also be populated.

This attribute is only used on Windows Vista and above. If this attribute is not specified and theinstall

is running on Vista and above, the value in the Name attribute is used. If this attribute ispopulated and the

install is running on Vista and above, the value in the Name attribute is ignored.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

435

Page 436: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Show

Derived By

Extending string

Attributes

Name Type Required? Default Description

Dialog string Yes

OnExit NMTOKEN(restriction)

No mutually exclusive with Before, After,and Sequence attributes

Before string No

After string No

Overridable YesNoType No If "yes", the sequencing of this dialogmay be overridden by sequencingelsewhere.

Sequence integer No

Content Model

Contains text only.

Referenced By

● Element AdminUISequence

● Element InstallUISequence

Definition

<xs:element name="Show"><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:attribute name="Dialog" type="xs:string" use="required" /><xs:attribute name="OnExit"><xs:annotation><xs:documentation>mutually exclusive with Before, After, and Sequence attributes</xs:documentation>

</xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="success" /><xs:enumeration value="cancel" /><xs:enumeration value="error" /><xs:enumeration value="suspend" />

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="Before" type="xs:string" /><xs:attribute name="After" type="xs:string" /><xs:attribute name="Overridable" type="YesNoType"><xs:annotation><xs:documentation>

If "yes", the sequencing of this dialog may be overridden by sequencing elsewhere.</xs:documentation>

</xs:annotation>

436

Page 437: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute><xs:attribute name="Sequence" type="xs:integer" />

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

437

Page 438: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: StartServices

Description

Starts system services.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="StartServices" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="StartServices" href="http://msdn.microsoft.com/library/aa372026.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Starts system services. The condition for this action may be specified in the element's

inner text.</xs:documentation></xs:annotation>

</xs:element>

438

Page 439: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: StopServices

Description

Stops system services.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="StopServices" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="StopServices" href="http://msdn.microsoft.com/library/aa372028.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Stops system services. The condition for this action may be specified in the element's

inner text.</xs:documentation></xs:annotation>

</xs:element>

439

Page 440: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Subscribe

Description

Sets attributes for events in the EventMapping table

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Event string No must be one of the standard controlevents'

Attribute string No if not present can only handleenable, disable, hide, unhide events

Content Model

Always empty.

Definition

<xs:element name="Subscribe"><xs:annotation><xs:documentation>

Sets attributes for events in the EventMapping table</xs:documentation>

<xs:appinfo><xse:msiRef table="EventMapping" href="http://msdn.microsoft.com/library/aa368559.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Event" type="xs:string"><xs:annotation><xs:documentation>must be one of the standard control events'</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Attribute" type="xs:string"><xs:annotation><xs:documentation>if not present can only handle enable, disable, hide, unhide

events</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

440

Page 441: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Substitution

Description

Specifies the configurable fields of a module database and provides a template for the configuration of eachfield.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Table string Yes Specifies the name of the table beingmodified in the module database.

Row string Yes Specifies the primary keys of thetarget row in the table named in theTable column.

Column string Yes Specifies the target column in therow named in the Row column.

Value string No Provides a formatting template forthe data being substituted into thetarget field specified by Table, Row,and Column.

Content Model

Always empty.

Definition

<xs:element name="Substitution"><xs:annotation><xs:documentation>Specifies the configurable fields of a module database and provides a template for the

configuration of each field.</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Table" type="xs:string" use="required"><xs:annotation><xs:documentation>Specifies the name of the table being modified in the module

database.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Row" type="xs:string" use="required"><xs:annotation><xs:documentation>Specifies the primary keys of the target row in the table named in the Table column. If

multiple keys, separated by semicolons.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Column" type="xs:string" use="required"><xs:annotation><xs:documentation>Specifies the target column in the row named in the Row column.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Value" type="xs:string">

441

Page 442: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>Provides a formatting template for the data being substituted into the target field

specified by Table, Row, and Column.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

442

Page 443: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: SymbolPath

Description

A path to symbols.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Path string Yes The path.

Content Model

Always empty.

Referenced By

● Element Component

● Element Directory

● Element ExternalFile

● Element File

● Element TargetFile

● Element TargetImage

● Element UpgradeFile

Definition

<xs:element name="SymbolPath"><xs:annotation><xs:documentation>A path to symbols.</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Path" type="xs:string" use="required"><xs:annotation><xs:documentation>The path.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

443

Page 444: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: TargetFile

Description

Information about specific files in a target image.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Foreign key into the File table.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

SymbolPath anyType (restriction) 0..1 A path to symbols.

0..*

IgnoreRange anyType (restriction) 1..1 Specifies part of a file that is to be ignoredduring patching.

ProtectRange anyType (restriction) 1..1 Specifies part of a file that cannot beoverwritten during patching.

Referenced By

● Element TargetImage

Definition

<xs:element name="TargetFile"><xs:annotation><xs:documentation>Information about specific files in a target image.</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="SymbolPath" minOccurs="0" /><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="IgnoreRange" /><xs:element ref="ProtectRange" />

</xs:choice></xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Foreign key into the File table.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

444

Page 445: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: TargetImage

Description

Contains information about the target images of the product.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier for the target image.

SourceFile string No Full path to the location of the msi filefor the target image.

src string No

Order int Yes Relative order of the target image.

Validation string No Product checking to avoid applyingirrelevant transforms.

IgnoreMissingFiles

YesNoType No Files missing from the target imageare ignored by the installer.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

SymbolPath anyType (restriction) 1..1 A path to symbols.

TargetFile anyType (restriction) 1..1 Information about specific files in a targetimage.

Referenced By

● Element UpgradeImage

Definition

<xs:element name="TargetImage"><xs:annotation><xs:documentation>Contains information about the target images of the product.</xs:documentation>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="SymbolPath" /><xs:element ref="TargetFile" />

</xs:choice><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier for the target image.</xs:documentation>

</xs:annotation></xs:attribute>

445

Page 446: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Full path to the location of the msi file for the target image.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="Order" type="xs:int" use="required"><xs:annotation><xs:documentation>Relative order of the target image.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Validation" type="xs:string"><xs:annotation><xs:documentation>Product checking to avoid applying irrelevant transforms.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreMissingFiles" type="YesNoType"><xs:annotation><xs:documentation>Files missing from the target image are ignored by the installer.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

446

Page 447: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: TargetProductCode

Description

A product code for a product that may receive this patch (or '*' for all products).

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The product code for a product thatcan receive this patch (or '*' for allproducts).

Content Model

Always empty.

Definition

<xs:element name="TargetProductCode"><xs:annotation><xs:documentation>

A product code for a product that may receive this patch (or '*' for all products).</xs:documentation>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>

The product code for a product that can receive this patch (or '*' for all products).</xs:documentation>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

447

Page 448: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Text

Description

An alternative to using the Text attribute when the value contains special XML characters like &lt;, &gt;, or&amp;.

Derived By

Extending string

Attributes

Name Type Required? Default Description

SourceFile string No Instructs the text to be imported froma file instead of the element valueduring the binding process.

src string No

Content Model

Contains text only.

Referenced By

● Element Control

Definition

<xs:element name="Text"><xs:annotation><xs:documentation>

An alternative to using the Text attribute when the value contains special XML characters like &lt;,&gt;, or &amp;.

</xs:documentation></xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Instructs the text to be imported from a file instead of the element value during the

binding process.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute>

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

448

Page 449: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: TextStyle

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

FaceName string Yes

Size string Yes

Red integer No 0 to 255

Green integer No 0 to 255

Blue integer No 0 to 255

Bold YesNoType No

Italic YesNoType No

Underline YesNoType No

Strike YesNoType No

Content Model

Always empty.

Referenced By

● Element UI

Definition

<xs:element name="TextStyle"><xs:annotation><xs:appinfo><xse:msiRef table="TextStyle" href="http://msdn.microsoft.com/library/aa372074.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required" /><xs:attribute name="FaceName" use="required" type="xs:string" /><xs:attribute name="Size" use="required" type="xs:string" /><xs:attribute name="Red" type="xs:integer"><xs:annotation><xs:documentation>0 to 255</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Green" type="xs:integer"><xs:annotation><xs:documentation>0 to 255</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Blue" type="xs:integer"><xs:annotation><xs:documentation>0 to 255</xs:documentation>

449

Page 450: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Bold" type="YesNoType" /><xs:attribute name="Italic" type="YesNoType" /><xs:attribute name="Underline" type="YesNoType" /><xs:attribute name="Strike" type="YesNoType" />

</xs:complexType></xs:element>

450

Page 451: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: TypeLib

Description

Register a type library (TypeLib).

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes The GUID that identifes the typelibrary.

Advertise YesNoType No Value of 'yes' will create a row in theTypeLib table. Value of 'no' willcreate rows in the Registry table.

Control YesNoType No Value of 'yes' means the type librarydescribes controls, and should notbe displayed in type browsersintended for nonvisual objects.

Cost int No The cost associated with theregistration of the type library inbytes.

Description string No The localizable description of thetype library.

HasDiskImage YesNoType No Value of 'yes' means the type libraryexists in a persisted form on disk.

HelpDirectory string No The identifier of the Directoryelement for the help directory.

Hidden YesNoType No Value of 'yes' means the type libraryshould not be displayed to users,although its use is not restricted.

Language integer Yes The language of the type library.

MajorVersion integer No The major version of the type library.

MinorVersion integer No The minor version of the type library.

ResourceId integer No The resource id of a typelib.

Restricted YesNoType No Value of 'yes' means the type libraryis restricted, and should not bedisplayed to users.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

AppId anyType (restriction) 1..1 Application ID containing DCOM information forthe associated application GUID.

451

Page 452: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

Class anyType (restriction) 1..1 COM Class registration for parent Component.

Interface anyType (restriction) 1..1 COM Interface registration for parent Typelib.

Referenced By

● Element Component

● Element File

Remarks

Please note that in order to properly use this non-advertised, you will need use this element with Advertise='no'and also author the appropriate child Interface elements by extracting them from the type library itself.

Definition

<xs:element name="TypeLib"><xs:annotation><xs:documentation>

Register a type library (TypeLib). Please note that in order to properly use thisnon-advertised, you will need use this element with Advertise='no' and also author theappropriate child Interface elements by extracting them from the type library itself.

</xs:documentation><xs:appinfo><xse:msiRef table="TypeLib" href="http://msdn.microsoft.com/library/aa372092.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /><xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="AppId" /><xs:element ref="Class" /><xs:element ref="Interface" />

</xs:choice><xs:attribute name="Id" type="Guid" use="required"><xs:annotation><xs:documentation>The GUID that identifes the type library.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Advertise" type="YesNoType"><xs:annotation><xs:documentation>

Value of 'yes' will create a row in the TypeLib table.Value of 'no' will create rows in the Registry table.The default value is 'no'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Control" type="YesNoType"><xs:annotation><xs:documentation>

Value of 'yes' means the type library describes controls, and should not be displayed in typebrowsers intended for nonvisual objects.

This attribute can only be set if Advertise='no'.</xs:documentation>

452

Page 453: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:attribute><xs:attribute name="Cost" type="xs:int"><xs:annotation><xs:documentation>

The cost associated with the registration of the type library in bytes. This attribute cannot be set ifAdvertise='no'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Description" type="xs:string"><xs:annotation><xs:documentation>The localizable description of the type library.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="HasDiskImage" type="YesNoType"><xs:annotation><xs:documentation>

Value of 'yes' means the type library exists in a persisted form on disk. This attribute can only beset if Advertise='no'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="HelpDirectory" type="xs:string"><xs:annotation><xs:documentation>The identifier of the Directory element for the help directory.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Hidden" type="YesNoType"><xs:annotation><xs:documentation>

Value of 'yes' means the type library should not be displayed to users, although its use is notrestricted.

Should be used by controls. Hosts should create a new type library that wraps the control withextended properties.

This attribute can only be set if Advertise='no'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Language" use="required" type="xs:integer"><xs:annotation><xs:documentation>The language of the type library. This must be a non-negative

integer.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="MajorVersion" type="xs:integer"><xs:annotation><xs:documentation>The major version of the type library. The value should be an integer from 0 -

255.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="MinorVersion" type="xs:integer"><xs:annotation><xs:documentation>The minor version of the type library. The value should be an integer from 0 -

255.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ResourceId" type="xs:integer"><xs:annotation><xs:documentation>The resource id of a typelib. The value is appended to the end of the typelib path in

453

Page 454: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

the registry.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Restricted" type="YesNoType"><xs:annotation><xs:documentation>

Value of 'yes' means the type library is restricted, and should not be displayed to users. Thisattribute can only be set if Advertise='no'.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

454

Page 455: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UI

Description

Enclosing element to compartmentalize UI specifications.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string No

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

BillboardAction anyType (restriction) 1..1 Billboard action during which child Billboardsare displayed

Binary anyType (restriction) 1..1 Binary data used for CustomAction elementsand UI controls.

ComboBox anyType (restriction) 1..1 Set of items for a particular ComboBox controltied to an install Property

Dialog anyType (restriction) 1..1 Defines a dialog box in the Dialog Table.

DialogRef anyType (restriction) 1..1 Reference to a Dialog.

EmbeddedUI anyType (restriction) 1..1 Element value is the condition.

Error string (extension) 1..1

ListBox anyType (restriction) 1..1 Set of items for a particular ListBox control tiedto an install Property

ListView anyType (restriction) 1..1 Set of items for a particular ListView controltied to an install Property

ProgressText string (extension) 1..1

Property anyType (restriction) 1..1 Property value for a Product or Module.

PropertyRef anyType (restriction) 1..1 Reference to a Property value.

Publish string (extension) 1..1

RadioButtonGroup anyType (restriction) 1..1 Set of radio buttons tied to the specifiedProperty

1..1

AdminUISequence

anyType (restriction) 0..1

InstallUISequence anyType (restriction) 0..1

TextStyle anyType (restriction) 1..1

455

Page 456: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Content Model

Component Type Occurs Description

UIRef anyType (restriction) 1..1 Reference to a UI element. This will force theentire referenced Fragment's contents to beincluded in the installer database.

UIText string (extension) 1..1 Text associated with certain controls

Referenced By

● Element Fragment

Definition

<xs:element name="UI"><xs:annotation><xs:documentation>

Enclosing element to compartmentalize UI specifications.</xs:documentation>

<xs:appinfo><xse:seeAlso ref="UIRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="EmbeddedUI"><xs:annotation><xs:documentation>Embedded UI definition with EmbeddedResource children.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="Error"><xs:annotation><xs:documentation>Error text associated with install error</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ProgressText"><xs:annotation><xs:documentation>ActionText entry associated with an action</xs:documentation>

</xs:annotation></xs:element><xs:element ref="BillboardAction"><xs:annotation><xs:documentation>Billboard table item with child Controls</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ComboBox"><xs:annotation><xs:documentation>ComboBox table with ListItem children</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ListBox"><xs:annotation><xs:documentation>ListBox table with ListItem children</xs:documentation>

</xs:annotation></xs:element><xs:element ref="ListView"><xs:annotation><xs:documentation>ListView table with ListItem children</xs:documentation>

</xs:annotation></xs:element>

456

Page 457: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element ref="RadioButtonGroup"><xs:annotation><xs:documentation>RadioButton table with RadioButton children</xs:documentation>

</xs:annotation></xs:element><xs:element ref="TextStyle"><xs:annotation><xs:documentation>TextStyle entry for use in control text</xs:documentation>

</xs:annotation></xs:element><xs:element ref="UIText"><xs:annotation><xs:documentation>values for UIText property, not installer Property</xs:documentation>

</xs:annotation></xs:element><xs:element ref="Dialog"><xs:annotation><xs:documentation>Dialog specification, called from Sequence</xs:documentation>

</xs:annotation></xs:element><xs:element ref="DialogRef"><xs:annotation><xs:documentation>Reference to a Dialog specification.</xs:documentation>

</xs:annotation></xs:element><xs:element ref="Publish" /><!-- elements with identical behavior as under Product key, solely to allow grouping with other UI elements

--><xs:element ref="PropertyRef" /><xs:element ref="Property" /><xs:element ref="Binary" /><xs:sequence><xs:element ref="AdminUISequence" minOccurs="0" /><xs:element ref="InstallUISequence" minOccurs="0" />

</xs:sequence><xs:element ref="UIRef" />

</xs:choice><xs:attribute name="Id" type="xs:string" />

</xs:complexType></xs:element>

457

Page 458: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UIRef

Description

Reference to a UI element. This will force the entire referenced Fragment's contents to be included in theinstaller database.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes

Content Model

Always empty.

Referenced By

● Element Fragment

● Element UI

Definition

<xs:element name="UIRef"><xs:annotation><xs:documentation>

Reference to a UI element. This will force the entire referenced Fragment's contentsto be included in the installer database.

</xs:documentation><xs:appinfo><xse:seeAlso ref="UI" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required" /><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

458

Page 459: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UIText

Description

Text associated with certain controls

Derived By

Extending string

Attributes

Name Type Required? Default Description

Id string Yes

Content Model

Contains text only.

Referenced By

● Element UI

Definition

<xs:element name="UIText"><xs:annotation><xs:documentation>

Text associated with certain controls</xs:documentation>

<xs:appinfo><xse:msiRef table="UIText" href="http://msdn.microsoft.com/library/aa372101.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>Element value is text, may use CDATA if needed to escape XML

delimiters</xs:documentation></xs:annotation><xs:attribute name="Id" use="required" type="xs:string" />

</xs:extension></xs:simpleContent>

</xs:complexType></xs:element>

459

Page 460: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnpublishComponents

Description

Manages the unadvertisement of components listed in the PublishComponent table.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnpublishComponents" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnpublishComponents" href="http://msdn.microsoft.com/library/aa372106.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the unadvertisement of components listed in the PublishComponent table.

The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

460

Page 461: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnpublishFeatures

Description

Removes selection-state and feature-component mapping information from the registry.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnpublishFeatures" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnpublishFeatures" href="http://msdn.microsoft.com/library/aa372107.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes selection-state and feature-component mapping information from the registry.

The condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

461

Page 462: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterClassInfo

Description

Manages the removal of COM class information from the system registry.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterClassInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterClassInfo" href="http://msdn.microsoft.com/library/aa372108.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the removal of COM class information from the system registry. The condition

for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

462

Page 463: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterComPlus

Description

Removes COM+ applications from the registry.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterComPlus" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterComPlus" href="http://msdn.microsoft.com/library/aa372109.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes COM+ applications from the registry. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

463

Page 464: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterExtensionInfo

Description

Manages the removal of extension-related information from the system registry.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterExtensionInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterExtensionInfo" href="http://msdn.microsoft.com/library/aa372110.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the removal of extension-related information from the system registry. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

464

Page 465: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterFonts

Description

Removes registration information about installed fonts from the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterFonts" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterFonts" href="http://msdn.microsoft.com/library/aa372112.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Removes registration information about installed fonts from the system. The condition

for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

465

Page 466: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterMIMEInfo

Description

Unregisters MIME-related registry information from the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterMIMEInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterMIMEInfo" href="http://msdn.microsoft.com/library/aa372113.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Unregisters MIME-related registry information from the system. The condition for this

action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

466

Page 467: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterProgIdInfo

Description

Manages the unregistration of OLE ProgId information with the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterProgIdInfo" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterProgIdInfo" href="http://msdn.microsoft.com/library/aa372114.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Manages the unregistration of OLE ProgId information with the system. The condition

for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

467

Page 468: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UnregisterTypeLibraries

Description

Unregisters type libraries from the system.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="UnregisterTypeLibraries" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="UnregisterTypeLibraries" href="http://msdn.microsoft.com/library/aa372357.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Unregisters type libraries from the system. The condition for this action may be specified

in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

468

Page 469: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Upgrade

Description

Upgrade info for a particular UpgradeCode

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id Guid Yes This value specifies the upgradecode for the products that are to bedetected by the FindRelatedProductsaction.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

Property anyType (restriction) 1..1 Property value for a Product or Module.

UpgradeVersion string (extension) 1..1

Referenced By

● Element Fragment

Definition

<xs:element name="Upgrade"><xs:annotation><xs:documentation>

Upgrade info for a particular UpgradeCode</xs:documentation>

<xs:appinfo><xse:msiRef table="Upgrade" href="http://msdn.microsoft.com/library/aa372379.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="UpgradeVersion" /><xs:element ref="Property"><xs:annotation><xs:documentation>

Nesting a Property element under an Upgrade element has been deprecated.Please nest Property elements in any of the other supported locations.

</xs:documentation></xs:annotation>

</xs:element></xs:choice><xs:attribute name="Id" type="Guid" use="required">

469

Page 470: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>This value specifies the upgrade code for the products that are to be detected by the

FindRelatedProducts action.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

470

Page 471: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UpgradeFile

Description

Specifies files to either ignore or to specify optional data about a file.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

File string Yes Foreign key into the File table.

Ignore YesNoType Yes If yes, the file is ignored duringpatching, and the next two attributesare ignored.

AllowIgnoreOnError

YesNoType No Specifies whether patching this file isvital.

WholeFile YesNoType No Whether the whole file should beinstalled, rather than creating abinary patch.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..*

SymbolPath anyType (restriction) 1..1 A path to symbols.

Definition

<xs:element name="UpgradeFile"><xs:annotation><xs:documentation>Specifies files to either ignore or to specify optional data about a

file.</xs:documentation></xs:annotation><xs:complexType><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="SymbolPath" />

</xs:choice><xs:attribute name="File" type="xs:string" use="required"><xs:annotation><xs:documentation>Foreign key into the File table.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Ignore" type="YesNoType" use="required"><xs:annotation><xs:documentation>If yes, the file is ignored during patching, and the next two attributes are

ignored.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="AllowIgnoreOnError" type="YesNoType"><xs:annotation>

471

Page 472: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Specifies whether patching this file is vital.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="WholeFile" type="YesNoType"><xs:annotation><xs:documentation>Whether the whole file should be installed, rather than creating a binary

patch.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

472

Page 473: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UpgradeImage

Description

Contains information about the upgraded images of the product.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes Identifier to connect target imageswith upgraded image.

SourceFile string No Full path to location of msi file forupgraded image.

src string No

SourcePatch string No Modified copy of the upgradedinstallation database that containsadditional authoring specific topatching.

srcPatch string No

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

TargetImage anyType (restriction) 1..* Contains information about the target imagesof the product.

0..*

SymbolPath anyType (restriction) 1..1 A path to symbols.

UpgradeFile anyType (restriction) 1..1 Specifies files to either ignore or to specifyoptional data about a file.

Referenced By

● Element Family

Definition

<xs:element name="UpgradeImage"><xs:annotation><xs:documentation>Contains information about the upgraded images of the product.</xs:documentation>

</xs:annotation><xs:complexType><xs:sequence><xs:element ref="TargetImage" maxOccurs="unbounded" /><xs:choice minOccurs="0" maxOccurs="unbounded"><xs:element ref="SymbolPath" /><xs:element ref="UpgradeFile" />

473

Page 474: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:choice></xs:sequence><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>Identifier to connect target images with upgraded image.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="SourceFile" type="xs:string"><xs:annotation><xs:documentation>Full path to location of msi file for upgraded image.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="src" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourceFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="SourcePatch" type="xs:string"><xs:annotation><xs:documentation>Modified copy of the upgraded installation database that contains additional authoring

specific to patching.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="srcPatch" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="SourcePatch"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute>

</xs:complexType></xs:element>

474

Page 475: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: UpgradeVersion

Derived By

Extending string

Attributes

Name Type Required? Default Description

Minimum string No Specifies the lower bound on therange of product versions to bedetected by FindRelatedProducts.

Maximum string No Specifies the upper boundary of therange of product versions detectedby FindRelatedProducts.

Language string No Specifies the set of languagesdetected by FindRelatedProducts.

RemoveFeatures string No The installer sets the REMOVEproperty to features specified in thiscolumn.

Property string Yes When the FindRelatedProductsaction detects a related productinstalled on the system, it appendsthe product code to the propertyspecified in this field.

MigrateFeatures YesNoType No Set to "yes" to migrate feature statesfrom upgraded products by enablingthe logic in the MigrateFeatureStatesaction.

OnlyDetect YesNoType No Set to "yes" to detect products andapplications but do not uninstall.

IgnoreRemoveFailure

YesNoType No Set to "yes" to continue installationupon failure to remove a product orapplication.

IncludeMinimum YesNoType No Set to "no" to make the range ofversions detected exclude the valuespecified in Minimum.

IncludeMaximum YesNoType No Set to "yes" to make the range ofversions detected include the valuespecified in Maximum.

ExcludeLanguages

YesNoType No Set to "yes" to detect all languages,excluding the languages listed in theLanguage attribute.

Content Model

Contains text only.

Referenced By

● Element Upgrade

475

Page 476: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:element name="UpgradeVersion"><xs:annotation><xs:appinfo><xse:msiRef table="Upgrade" href="http://msdn.microsoft.com/library/aa372379.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation><xs:complexType><xs:simpleContent><xs:extension base="xs:string"><xs:attribute name="Minimum" type="xs:string"><xs:annotation><xs:documentation>Specifies the lower bound on the range of product versions to be detected by

FindRelatedProducts.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Maximum" type="xs:string"><xs:annotation><xs:documentation>Specifies the upper boundary of the range of product versions detected by

FindRelatedProducts.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Language" type="xs:string"><xs:annotation><xs:documentation>Specifies the set of languages detected by FindRelatedProducts. Enter a list of

numeric language identifiers (LANGID) separated by commas (,). Leave this value null to specify all languages.Set ExcludeLanguages to "yes" in order detect all languages, excluding the languages listed in thisvalue.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="RemoveFeatures" type="xs:string"><xs:annotation><xs:documentation>The installer sets the REMOVE property to features specified in this column. The

features to be removed can be determined at run time. The Formatted string entered in this field must evaluateto a comma-delimited list of feature names. For example: [Feature1],[Feature2],[Feature3]. No features areremoved if the field contains formatted text that evaluates to an empty string. The installer sets REMOVE=ALLonly if the Remove field is empty.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Property" type="xs:string" use="required"><xs:annotation><xs:documentation>When the FindRelatedProducts action detects a related product installed on the

system, it appends the product code to the property specified in this field. Windows Installer documentation forthe <a href="http://msdn2.microsoft.com/library/aa372379.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">Upgrade table</a> states that the property specified in thisfield must be a public property and must be added to the <ahref="http://msdn2.microsoft.com/library/aa371571.aspx" target="_blank"xmlns="http://schemas.microsoft.com/wix/2006/wi">SecureCustomProperties</a> property. WiX automaticallyappends the property specified in this field to the SecureCustomProperties property when creating an MSI.Each UpgradeVersion must have a unique Property value. After the FindRelatedProducts action is run, thevalue of this property is a list product codes, separated by semicolons (;), detected on thesystem.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="MigrateFeatures" type="YesNoType"><xs:annotation><xs:documentation>Set to "yes" to migrate feature states from upgraded products by enabling the logic

in the MigrateFeatureStates action.</xs:documentation></xs:annotation>

</xs:attribute>

476

Page 477: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:attribute name="OnlyDetect" type="YesNoType"><xs:annotation><xs:documentation>Set to "yes" to detect products and applications but do not

uninstall.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreRemoveFailure" type="YesNoType"><xs:annotation><xs:documentation>Set to "yes" to continue installation upon failure to remove a product or

application.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IncludeMinimum" type="YesNoType"><xs:annotation><xs:documentation>Set to "no" to make the range of versions detected exclude the value specified in

Minimum. This attribute is "yes" by default.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IncludeMaximum" type="YesNoType"><xs:annotation><xs:documentation>Set to "yes" to make the range of versions detected include the value specified in

Maximum.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ExcludeLanguages" type="YesNoType"><xs:annotation><xs:documentation>Set to "yes" to detect all languages, excluding the languages listed in the Language

attribute.</xs:documentation></xs:annotation>

</xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additionalattributes at this point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:extension>

</xs:simpleContent></xs:complexType>

</xs:element>

477

Page 478: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Validate

Description

Sets information on the patch transform that determines to which product the transform applies and what errorsshould be ignored when applying the patch transform.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

ProductId YesNoType No yes Requires that the upgradeProductCode match the targetProductCode.

ProductLanguage YesNoType No no Requires that the upgradeProductLanguage match the targetProductLanguage.

ProductVersion NMTOKEN(restriction)

No Update Determines how many fields in theProductVersion to check.

ProductVersionOperator

NMTOKEN(restriction)

No Equal Determines how the target andupgrade ProductVersions arecompared.

UpgradeCode YesNoType No yes Requires that the upgradeUpgradeCode match the targetUpgradeCode.

IgnoreAddExistingRow

YesNoType No yes Ignore errors when adding existingrows.

IgnoreAddExistingTable

YesNoType No yes Ignore errors when adding existingtables.

IgnoreDeleteMissingRow

YesNoType No yes Ignore errors when deleting missingrows.

IgnoreDeleteMissingTable

YesNoType No yes Ignore errors when deleting missingtables.

IgnoreUpdateMissingRow

YesNoType No yes Ignore errors when updating missingrows.

IgnoreChangingCodePage

YesNoType No no Ignore errors when changing thedatabase code page.

Content Model

Always empty.

Referenced By

● Element PatchBaseline

Definition

<xs:element name="Validate"><xs:annotation>

478

Page 479: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Sets information on the patch transform that determines to which product the transformapplies and what errors should be ignored when applying the patch transform.</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="ProductId" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Requires that the upgrade ProductCode match the target ProductCode. The default is

'yes'.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ProductLanguage" type="YesNoType" default="no"><xs:annotation><xs:documentation>Requires that the upgrade ProductLanguage match the target ProductLanguage. The

default is 'no'.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="ProductVersion" default="Update"><xs:annotation><xs:documentation>Determines how many fields in the ProductVersion to check. The default is

'Update'.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="Major"><xs:annotation><xs:documentation>Checks the major version.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Minor"><xs:annotation><xs:documentation>Checks the major and minor versions.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Update"><xs:annotation><xs:documentation>Checks the major, minor, and update versions.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="ProductVersionOperator" default="Equal"><xs:annotation><xs:documentation>Determines how the target and upgrade ProductVersions are compared. The default

is 'Equal'.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="Lesser"><xs:annotation><xs:documentation>Upgrade ProductVersion &lt; target ProductVersion.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="LesserOrEqual"><xs:annotation><xs:documentation>Upgrade ProductVersion &lt;= target ProductVersion.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Equal"><xs:annotation>

479

Page 480: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:documentation>Upgrade ProductVersion = target ProductVersion.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="GreaterOrEqual"><xs:annotation><xs:documentation>Upgrade ProductVersion &gt;= target ProductVersion.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="Greater"><xs:annotation><xs:documentation>Upgrade ProductVersion &gt; target ProductVersion.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

</xs:attribute><xs:attribute name="UpgradeCode" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Requires that the upgrade UpgradeCode match the target UpgradeCode. The default

is 'yes'.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="IgnoreAddExistingRow" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Ignore errors when adding existing rows. The default is 'yes'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreAddExistingTable" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Ignore errors when adding existing tables. The default is 'yes'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreDeleteMissingRow" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Ignore errors when deleting missing rows. The default is 'yes'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreDeleteMissingTable" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Ignore errors when deleting missing tables. The default is 'yes'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreUpdateMissingRow" type="YesNoType" default="yes"><xs:annotation><xs:documentation>Ignore errors when updating missing rows. The default is 'yes'.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="IgnoreChangingCodePage" type="YesNoType" default="no"><xs:annotation><xs:documentation>Ignore errors when changing the database code page. The default is

'no'.</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

480

Page 481: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: ValidateProductID

Description

Sets the ProductID property to the full product identifier.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

● Element InstallUISequence

Remarks

This action must be sequenced before the user interface wizard in the InstallUISequence table and before theRegisterUser action in the InstallExecuteSequence table. If the product identifier has already been validatedsuccessfully, the ValidateProductID action does nothing. The ValidateProductID action always returns asuccess, whether or not the product identifier is valid, so that the product identifier can be entered on thecommand line the first time the product is run. The product identifier can be validated without having the userreenter this information by setting the PIDKEY property on the command line or by using a transform. Thedisplay of the dialog box requesting the user to enter the product identifier can then be made conditional uponthe presence of the ProductID property, which is set when the PIDKEY property is validated. The condition forthis action may be specified in the element's inner text.

Definition

<xs:element name="ValidateProductID" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="ValidateProductID" href="http://msdn.microsoft.com/library/aa372475.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Sets the ProductID property to the full product identifier. This action must be sequenced

before the user interface wizard in the InstallUISequence table and before the RegisterUser action in theInstallExecuteSequence table. If the product identifier has already been validated successfully, theValidateProductID action does nothing. The ValidateProductID action always returns a success, whether or notthe product identifier is valid, so that the product identifier can be entered on the command line the first time theproduct is run. The product identifier can be validated without having the user reenter this information bysetting the PIDKEY property on the command line or by using a transform. The display of the dialog boxrequesting the user to enter the product identifier can then be made conditional upon the presence of theProductID property, which is set when the PIDKEY property is validated. The condition for this action may bespecified in the element's inner text.</xs:documentation></xs:annotation>

481

Page 482: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:element>

482

Page 483: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Verb

Description

Verb definition for an Extension.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The verb for the command.

Command string No The localized text displayed on thecontext menu.

Argument string No Value for the command arguments.

Sequence integer No The sequence of the commands.

Target string No

TargetFile string No Either this attribute or theTargetProperty attribute must bespecified for a non-advertised verb.

TargetProperty string No Either this attribute or the TargetFileattribute must be specified for anon-advertised verb.

Content Model

Always empty.

Referenced By

● Element Extension

Remarks

When advertised, this element creates a row in the Verb table. When not advertised, this element creates theappropriate rows in Registry table.

Definition

<xs:element name="Verb"><xs:annotation><xs:documentation>

Verb definition for an Extension. When advertised, this element creates a row in the<html:a href="http://msdn.microsoft.com/library/aa372487.aspx" target="_blank"

xmlns:html="http://www.w3.org/1999/xhtml">Verb table</html:a>.When not advertised, this element creates the appropriate rows in <html:a

href="http://msdn.microsoft.com/library/aa371168.aspx" target="_blank"xmlns:html="http://www.w3.org/1999/xhtml">Registry table</html:a>.

</xs:documentation><xs:appinfo><xse:msiRef table="Verb" href="http://msdn.microsoft.com/library/aa372487.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

483

Page 484: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx"xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />

</xs:appinfo></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The verb for the command.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Command" type="xs:string"><xs:annotation><xs:documentation>The localized text displayed on the context menu.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Argument" type="xs:string"><xs:annotation><xs:documentation>Value for the command arguments. Note that the resolution of properties in the

Argument field is limited. A property formatted as [Property] in this field can only be resolved if theproperty

already has the intended value when the component owning the verb is installed. For example, for theargument

"[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the fileMyDoc.doc and the

component that owns the verb.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Sequence" type="xs:integer"><xs:annotation><xs:documentation>The sequence of the commands. Only verbs for which the Sequence is specified

are used to prepare an ordered list for the default value of the shell key. The Verb with the lowestvalue in this

column becomes the default verb. Used only for Advertised verbs.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Target" type="xs:string"><xs:annotation><xs:appinfo><xse:deprecated ref="TargetFile"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo>

</xs:annotation></xs:attribute><xs:attribute name="TargetFile" type="xs:string"><xs:annotation><xs:documentation>

Either this attribute or the TargetProperty attribute must be specified for a non-advertised verb.The value should be the identifier of the target file to be executed for the verb.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="TargetProperty" type="xs:string"><xs:annotation><xs:documentation>

Either this attribute or the TargetFile attribute must be specified for a non-advertised verb.The value should be the identifier of the property which will resolve to the path to the target file to

be executed for the verb.</xs:documentation>

</xs:annotation></xs:attribute>

484

Page 485: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:complexType></xs:element>

485

Page 486: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: Wix

Description

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

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

RequiredVersion VersionType No Required version of the WiX toolsetto compile this input file.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

0..1

PatchCreation anyType (restriction) 1..1 The PatchCreation element is analogous to themain function in a C program.

1..1

0..1

Module anyType (restriction) 1..1 The Module element is analogous to the mainfunction in a C program.

Patch anyType (restriction) 1..1 The Patch element is analogous to the mainfunction in a C program.

Product anyType (restriction) 1..1 The Product element is analogous to the mainfunction in a C program.

Fragment anyType (restriction) 0..* The Fragment element is the building block ofcreating an installer database in WiX.

Remarks

Among the possible children, the Product, Module, Patch, and PatchCreation elements are analogous to themain function in a C program. There can only be one of these present when linking occurs. Product compilesinto an msi file, Module compiles into an msm file, PatchCreation compiles into a pcp file. The Fragmentelement is an atomic unit which ultimately links into either a Product, Module, or PatchCreation. The Fragmentcan either be completely included or excluded during linking.

Definition

<xs:element name="Wix"><xs:annotation><xs:documentation>

This is the top-level container element for every wxs file. Among the possible children,the Product, Module, Patch, and PatchCreation elements are analogous to the main function in a C

program.There can only be one of these present when linking occurs. Product compiles into an msi file,Module compiles into an msm file, PatchCreation compiles into a pcp file. The Fragment element

486

Page 487: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

is an atomic unit which ultimately links into either a Product, Module, or PatchCreation. TheFragment can either be completely included or excluded during linking.

</xs:documentation></xs:annotation><xs:complexType><xs:choice minOccurs="0"><xs:sequence><xs:choice minOccurs="0"><xs:element ref="Product" /><xs:element ref="Module" /><xs:element ref="Patch" />

</xs:choice><xs:element ref="Fragment" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence><xs:element ref="PatchCreation" />

</xs:choice><xs:attribute name="RequiredVersion" type="VersionType"><xs:annotation><xs:documentation>Required version of the WiX toolset to compile this input file.</xs:documentation>

</xs:annotation></xs:attribute><xs:anyAttribute namespace="##other" processContents="lax"><xs:annotation><xs:documentation>

Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes atthis point in the schema.

</xs:documentation></xs:annotation>

</xs:anyAttribute></xs:complexType>

</xs:element>

487

Page 488: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: WixVariable

Description

This element exposes advanced WiX functionality.

Derived By

Restricting anyType

Attributes

Name Type Required? Default Description

Id string Yes The name of the variable.

Overridable YesNoType No Set this value to 'yes' in order tomake the variable's value overridableeither by another WixVariable entryor via the command-line option-d<name>=<value> for light.exe.

Value string Yes The value of the variable.

Content Model

Always empty.

Referenced By

● Element Fragment

Remarks

Use this element to declare WiX variables from directly within your authoring. WiX variables are not resolveduntil the final msi/msm/pcpfile is actually generated. WiX variables do not persist into the msi/msm/pcp file, so they cannot be used whenan MSI file is being installed; its a WiX-only concept.

Definition

<xs:element name="WixVariable"><xs:annotation><xs:documentation>

This element exposes advanced WiX functionality. Use this element to declare WiX variablesfrom directly within your authoring. WiX variables are not resolved until the final msi/msm/pcpfile is actually generated. WiX variables do not persist into the msi/msm/pcp file, so they cannotbe used when an MSI file is being installed; its a WiX-only concept.

</xs:documentation></xs:annotation><xs:complexType><xs:attribute name="Id" type="xs:string" use="required"><xs:annotation><xs:documentation>The name of the variable.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Overridable" type="YesNoType"><xs:annotation><xs:documentation>

Set this value to 'yes' in order to make the variable's value overridable either by

488

Page 489: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

another WixVariable entry or via the command-line option -d&lt;name&gt;=&lt;value&gt;for light.exe. If the same variable is declared overridable in multiple places itwill cause an error (since WiX won't know which value is correct). The default valueis 'no'.

</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Value" type="xs:string" use="required"><xs:annotation><xs:documentation>

The value of the variable. The value cannot be an empty string because that wouldmake it possible to accidentally set a column to null.

</xs:documentation></xs:annotation>

</xs:attribute></xs:complexType>

</xs:element>

489

Page 490: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: WriteEnvironmentStrings

Description

Modifies the values of environment variables.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="WriteEnvironmentStrings" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="WriteEnvironmentStrings" href="http://msdn.microsoft.com/library/aa372883.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Modifies the values of environment variables. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

490

Page 491: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: WriteIniValues

Description

Writes the .ini file information that the application needs written to its .ini files.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="WriteIniValues" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="WriteIniValues" href="http://msdn.microsoft.com/library/aa372884.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Writes the .ini file information that the application needs written to its .ini files. The

condition for this action may be specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

491

Page 492: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Element: WriteRegistryValues

Description

Sets up an application's registry information.

Derived By

Type ActionSequenceType

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Content Model

Contains text only.

Referenced By

● Element InstallExecuteSequence

Remarks

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

Definition

<xs:element name="WriteRegistryValues" type="ActionSequenceType"><xs:annotation><xs:appinfo><xse:msiRef action="WriteRegistryValues" href="http://msdn.microsoft.com/library/aa372891.aspx"

xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /></xs:appinfo><xs:documentation>Sets up an application's registry information. The condition for this action may be

specified in the element's inner text.</xs:documentation></xs:annotation>

</xs:element>

492

Page 493: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes: WiX Database

Attributes

Name Description

Absent [element Feature] This attribute determines if a user will have the option to set a featureto absent in the user interface.

Account [element ServiceInstall] The acount under which to start the service. Valid only whenServiceType is ownProcess.

Action [element Condition] Used only under Control elements and is required. Allows specificactions to be applied to a control based on the result of this condition.

Action [element Custom] The action to which the Custom element applies.

Action [element Environment] Specfies whether the environmental variable should be created, set orremoved when the parent component is installed.

Action [element IniFile] The type of modification to be made.

Action [element ProgressText]

Action [element Registry] This is the action that will be taken for this registry key.

Action [element RegistryKey] This is the action that will be taken for this registry value.

Action [element RegistryValue] This is the action that will be taken for this registry value.

Action [element RemoveRegistryKey] This is the action that will be taken for this registry value.

ActivateAtStorage [element AppId] Set this value to 'yes' to configure the client to activate on the samesystem as persistent storage.

Admin [element Property] Denotes that the Property is saved during

AdminImage [element Package] Set to 'yes' if the source is an admin image.

AdminImage [elementPatchInformation]

Source is an admin image

Advertise [element AppId] Set this value to 'yes' in order to create a normal AppId table row. Setthis value to 'no' in order to generate Registry rows that perform similarregistration (without the often problematic Windows Installeradvertising behavior).

Advertise [element Class] Set this value to "yes" in order to create a normal Class table row. Setthis value to "no" in order to generate Registry rows that performsimilar registration (without the often problematic Windows Installeradvertising behavior).

Advertise [element Extension] Whether this extension is to be advertised. The default is "no".

Advertise [element MIME] Whether this MIME is to be advertised.

Advertise [element ProgId]

Advertise [element Shortcut] Specifies if the shortcut should be advertised or not.

Advertise [element TypeLib] Value of 'yes' will create a row in the TypeLib table. Value of 'no' willcreate rows in the Registry table.

After [element Custom] The name of the standard or custom action after which this actionshould be performed.

After [element SetProperty] The name of the standard or custom action after which this actionshould be performed.

After [element Show]

493

Page 494: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

After [typeActionModuleSequenceType]

The name of an action that this action should come after.

AllowAdvertise [element Feature] This attribute determins the possible advertise states for this feature.

AllowIgnoreOnError [elementUpgradeFile]

Specifies whether patching this file is vital.

AllowMajorVersionMismatches[element PatchCreation]

Use this to set whether the major versions between the upgrade andtarget images match.

AllowProductCodeMismatches[element PatchCreation]

Use this to set whether the product code between the upgrade andtarget images match.

AllowRemoval [element Patch] Whether this is an uninstallable patch.

AllowRemoval [elementPatchMetadata]

Whether this is an uninstallable patch.

ApiPatchingSymbolNoFailuresFlag[element Patch]

Flag used when creating a binary file patch.

ApiPatchingSymbolNoImagehlpFlag[element Patch]

Flag used when creating a binary file patch.

ApiPatchingSymbolUndecoratedTooFlag [element Patch]

Flag used when creating a binary file patch.

AppData [element Category] An optional localizable text describing the category.

Append [element Permission]

AppId [element Class] This attribute is only allowed when a Class is advertised.

Argument [element Class] This column is optional only when the Context column is set to"LocalServer" or "LocalServer32" server context.

Argument [element Verb] Value for the command arguments.

Arguments [element ServiceInstall] Contains any command line arguments or properties required to runthe service.

Arguments [element Shortcut] The command-line arguments for the shortcut.

Assembly [element File] Specifies if this File is a Win32 Assembly or .NET Assembly that needsto be installed into the Global Assembly Cache.

AssemblyApplication [element File] Specifies the file identifier of the application file.

AssemblyManifest [element File] Specifies the file identifier of the manifest file that describes thisassembly.

AssignToProperty [elementDirectorySearch]

Set the result of this search to the value of the outer Property.

AssignToProperty [elementDirectorySearchRef]

Set the result of this search to the value of the outer Property.

Attribute [element Subscribe] if not present can only handle enable, disable, hide, unhide events

Before [element Custom] The name of the standard or custom action before which this actionshould be performed. Mutually exclusive with OnExit, After, andSequence attributes

Before [element SetProperty] The name of the standard or custom action before which this actionshould be performed.

Before [element Show]

494

Page 495: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Before [typeActionModuleSequenceType]

The name of an action that this action should come before.

BinaryKey [element CustomAction] This attribute is a reference to a Binary element with matching Idattribute.

BinarySource [elementEmbeddedChainer]

Reference to the Binary element that contains the chainer executeable.

BindPath [element File] A list of paths, separated by semicolons, that represent the paths to besearched to find the imported DLLs.

Bitmap [element Control] This attribute is only valid for RadioButton and PushButton Controls.

Bitmap [element RadioButton] This attribute defines the bitmap displayed with the radio button.

Blue [element TextStyle] 0 to 255

Bold [element TextStyle]

Cabinet [element Media] The name of the cabinet if some or all of the files stored on the mediaare in a cabinet file.

Cancel [element Control] Set this attribute to "yes" to cause this Control to be invoked by theescape key.

Category [element Column] Category of this column.

CDROM [element Control] This attribute is only valid for Volume and Directory Controls.

ChangePermission [elementPermission]

CheckBoxValue [element Control] This attribute is only valid for CheckBox Controls.

Checksum [element File] This attribute should be set to "yes" for every executable file in theinstallation that has a valid checksum stored in the PortableExecutable (PE) file header.

Class [element MIME] Class ID for the COM server that is to be associated with the MIMEcontent.

Classification [element Patch] Category of updates.

Classification [elementPatchMetadata]

Category of update.

CleanWorkingFolder [elementPatchCreation]

Use this to set whether Patchwiz should clean the temp folder whenfinished.

ClientPatchId [element Patch] An easily referenced identity unique to a patch that can be used inproduct authoring.

Codepage [element Module] The code page integer value or web name for the resulting MSM.

Codepage [element Patch] The code page integer value or web name for the resulting MSP.

Codepage [element PatchCreation] The code page integer value or web name for the resulting PCP.

Codepage [element Product] The code page integer value or web name for the resulting MSI. Seeremarks for more information.

Column [element Data] Specifies in which column to insert this data.

Column [element Substitution] Specifies the target column in the row named in the Row column.

ComboList [element Control] This attribute is only valid for ComboBox Controls.

Command [element Verb] The localized text displayed on the context menu.

495

Page 496: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

CommandLine [elementEmbeddedChainer]

Value to append to the transaction handle and passed to the chainerexecutable.

Comments [element Package] Optional comments for browsing.

Comments [elementPatchInformation]

Optional comments for browsing

CompanionFile [element File] Set this attribute to make this file a companion child of another file.

Company [element CustomProperty] The name of the company.

Company [element PatchProperty] Name of the company for a custom metadata property.

ComplianceCheck [element Property] Adds a row to the CCPSearch table. This attribute is only valid whenthis Property contains a search element.

ComPlusFlags [element Component] Set this attribute to create a ComPlus entry.

ComponentGuidGenerationSeed[element Directory]

The Component Guid Generation Seed is a guid that must be usedwhen a Component with the generate guid directive ("*") is not rootedin a standard Windows Installer directory (for example,ProgramFilesFolder or CommonFilesFolder, etc).

Compressed [element File] Sets the file's source type compression.

Compressed [element Package] Set to 'yes' to have compressed files in the source.

Compressed [elementPatchInformation]

Compressed files on source

CompressionLevel [element Media] Indicates the compression level for the Media's cabinet.

ConfigurableDirectory [elementFeature]

Specify the Id of a Directory that can be configured by the user atinstallation time.

ContentType [element Extension] The MIME type that is to be written.

ContentType [element MIME] This is the identifier for the MIME content.

Context [element Class] The server context(s) for this server.

ContextData [element Configuration] Specifies a semantic context for the requested data.

Control [element Class] Set this attribute's value to 'yes' to identify an object as an ActiveXControl.

Control [element Publish] The parent Control for this Publish element, should only be specifiedwhen this element is a child of the UI element.

Control [element TypeLib] Value of 'yes' means the type library describes controls, and should notbe displayed in type browsers intended for nonvisual objects.

Cost [element TypeLib] The cost associated with the registration of the type library in bytes.

CreateChild [element Permission] For a directory, the right to create a subdirectory.

CreateFile [element Permission] For a directory, the right to create a file in the directory.

CreateLink [element Permission]

CreateSubkeys [element Permission]

CreationTimeUTC [elementPatchMetadata]

Creation time of the .msp file in the form mm-dd-yy HH:MM(month-day-year hour:minute).

CustomPalette [element Dialog] Used to specify if pictures in the dialog box are rendered with a custompalette.

496

Page 497: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Default [element Control] Set this attribute to "yes" to cause this Control to be invoked by thereturn key.

Default [element MIME] If 'yes', become the content type for the parent Extension.

DefaultLanguage [element File] This is the default language of this file.

DefaultSize [element File] This is the default size of this file.

DefaultValue [element Configuration] Specifies a default value for the item in this record if the merge tooldeclines to provide a value.

DefaultVersion [element File] This is the default version of this file.

Delete [element CopyFile] This attribute cannot be specified if the element is nested under a Fileelement or the FileId attribute is specified.

Delete [element Permission]

DeleteChild [element Permission] For a directory, the right to delete a directory and all the files itcontains, including read-only files.

Dependency [element SFPCatalog] Used to define dependency outside of the package.

Depth [element DirectorySearch] Depth below the path that the installer searches for the file or directoryspecified by the search.

Description [element AppId] Set this value to the description of the AppId.

Description [element Class] Localized description associated with the Class ID and Program ID.

Description [element Column] Description of this column.

Description [element Configuration] Description for authoring.

Description [element Feature] Longer string of text describing the feature.

Description [element Package] The product full name or description.

Description [element Patch] Description of the patch.

Description [elementPatchInformation]

Product full name or description

Description [element PatchMetadata] Description of the patch.

Description [element ProgId]

Description [element ServiceInstall] Sets the description of the service.

Description [element Shortcut] The localizable description for the shortcut.

Description [element TypeLib] The localizable description of the type library.

DescriptionResourceDll [elementShortcut]

The Formatted string providing the full path to the language neutral filecontaining the MUI Manifest.

DescriptionResourceId [elementShortcut]

The description name index for the shortcut.

DestinationDirectory [elementCopyFile]

Set this value to the destination directory where an existing file on thetarget machine should be moved or copied to.

DestinationLongName [elementCopyFile]

DestinationName [element CopyFile] In prior versions of the WiX toolset, this attribute specified the short filename.

497

Page 498: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

DestinationProperty [elementCopyFile]

Set this value to a property that will have a value that resolves to thefull path of the destination directory.

DestinationShortName [elementCopyFile]

The short file name of the file in 8.3 format.

Dialog [element Publish] The parent Dialog for this Publish element, should only be specifiedwhen this element is a child of the UI element.

Dialog [element Show]

Directory [element Component] Sets the Directory of the Component.

Directory [element CreateFolder] Identifier of Directory to create.

Directory [element CustomAction] This attribute specifies a reference to a Directory element withmatching Id attribute containing a directory path.

Directory [element IniFile] Name of a property, the value of which is the full path of the foldercontaining the .ini file.

Directory [element RemoveFile] Overrides the directory of the parent component with a specificDirectory.

Directory [element RemoveFolder] Overrides the directory of the parent component with a specificDirectory.

Directory [element ReserveCost] Adds the amount of disk space specified in RunFromSource orRunLocal to the volume cost of the device containing the directory.

Directory [element Shortcut] Identifier reference to Directory element where shortcut is to becreated.

Disabled [element Control] Set this attribute to "yes" to cause the Control to be disabled.

DisableRegistryReflection [elementComponent]

Set this attribute to 'yes' in order to disable registry reflection on allexisting and new registry keys affected by this component.

DiskId [element Component] This attribute must be set either on a Component element or all of itschildren File elements.

DiskId [element Directory] Sets the default disk identifier for the files contained in this directory.

DiskId [element DirectoryRef] Sets the default disk identifier for the files contained in this directory.

DiskId [element Family] Entered into the DiskId field of the new Media table record.

DiskId [element File] Specifies the Media this File should be sourced on.

DiskId [element Merge] The value of this attribute should correspond to the Id attribute of aMedia element authored elsewhere.

DiskPrompt [element Family] Value to display in the "[1]" of the DiskPrompt Property.

DiskPrompt [element Media] The disk name, which is usually the visible text printed on the disk.

Display [element Feature] Determines the initial display of this feature in the feature tree.

DisplayName [element Configuration] Display name for authoring.

DisplayName [element Patch] A title for the patch that is suitable for public display.

DisplayName [elementPatchMetadata]

A title for the patch that is suitable for public display.

DisplayName [element ServiceInstall] This column is the localizable string that user interface programs useto identify the service.

498

Page 499: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

DisplayResourceDll [elementShortcut]

The Formatted string providing the full path to the language neutral filecontaining the MUI Manifest.

DisplayResourceId [elementShortcut]

The display name index for the shortcut.

DllEntry [element CustomAction] This attribute specifies the name of a function in a custom action toexecute.

DllSurrogate [element AppId] Set this value to specify that the class is a DLL that is to be activated ina surrogate EXE process, and the surrogate process to be used is thepath of a surrogate EXE file specified by the value.

Domain [element Permission]

DriverName [elementODBCDataSource]

Required if not found as child of ODBCDriver element

ElevationShield [element Control] This attribute is only valid for PushButton controls.

EmbedCab [element Media] Instructs the binder to embed the cabinet in the product if 'yes'.

EnumerateSubkeys [elementPermission]

EraseDescription [elementServiceInstall]

Determines whether the existing service description will be ignored.

Error [element CustomAction] This attribute specifies an index in the MSI Error table to use as anerror message for a type 19 custom action that displays the errormessage and aborts a product's installation.

ErrorControl [element ServiceInstall] Determines what action should be taken on an error.

ErrorDialog [element Dialog] Specifies this dialog as an error dialog.

Event [element Publish] Set this attribute's value to one of the standard control events to triggerthat event.

Event [element Subscribe] must be one of the standard control events'

ExcludedId [element Exclusion] Identifier of the merge module that is incompatible.

ExcludedMaxVersion [elementExclusion]

Maximum version excluded from a range.

ExcludedMinVersion [elementExclusion]

Minimum version excluded from a range.

ExcludeExceptLanguage [elementExclusion]

Numeric language ID of the merge module in ExcludedID.

ExcludeLanguage [elementExclusion]

Numeric language ID of the merge module in ExcludedID.

ExcludeLanguages [elementUpgradeVersion]

Set to "yes" to detect all languages, excluding the languages listed inthe Language attribute.

ExeCommand [elementCustomAction]

This attribute specifies the command line parameters to supply to anexternally run executable.

Execute [element CustomAction] This attribute indicates the scheduling of the custom action.

Execute [element Permission]

FaceName [element TextStyle]

Feature [element Billboard] Feature whose state determines if the Billboard is shown.

499

Page 500: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Feature [element Category] Feature that controls the advertisement of the category.

Feature [element Component] Identifies a feature to which this component belongs, as a shorthandfor a child ComponentRef element of the Feature element.

Field [element IniFileSearch] The field in the .ini line. If field is Null or 0, the entire line is read.

File [element ExternalFile] Foreign key into the File table.

File [element ODBCDriver] Required if not found as child of File element

File [element ODBCTranslator] Required if not found as child of File element

File [element ProtectFile] Foreign key into the File table.

File [element UpgradeFile] Foreign key into the File table.

FileCompression [element Merge] Specifies if the files in the merge module should be compressed.

FileId [element CopyFile] This attribute cannot be specified if the element is nested under a Fileelement.

FileKey [element CustomAction] This attribute specifies a reference to a File element with matching Idattribute that will execute the custom action code in the file after the fileis installed.

FileSource [element Directory] Used to set the file system source for this directory's child elements.

FileSource [element DirectoryRef] Used to set the file system source for this directory ref's childelements.

FileSource [elementEmbeddedChainer]

Reference to the File element that is the chainer executeable.

Fixed [element Control] This attribute is only valid for Volume and Directory Controls.

FixedSize [element Control] This attribute is only valid for RadioButton, PushButton, and IconControls.

Floppy [element Control] This attribute is only valid for Volume and Directory Controls.

FontTitle [element File] Causes an entry to be generated for the file in the Font table with thespecified FontTitle.

Format [element Configuration] Specifies the format of the data being changed.

FormatSize [element Control] This attribute is only valid for Text Controls.

GenericAll [element Permission]

GenericExecute [elementPermission]

GenericRead [element Permission] specifying this will fail to grant read access

GenericWrite [element Permission]

Green [element TextStyle] 0 to 255

Group [element ServiceDependency] Set to 'yes' to indicate that the value in the Id attribute is the name of agroup of services.

Guid [element Component] This value should be a guid that uniquely identifies this component'scontents, language, platform, and version.

Guid [element ComponentSearch] The component ID of the component whose key path is to be used forthe search.

Guid [element Module] This attribute is deprecated. Use the Package/@Id instead.

500

Page 501: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Handler [element Class] The default inproc handler.

HasBorder [element Control] This attribute is only valid for RadioButton Controls.

HasDiskImage [element TypeLib] Value of 'yes' means the type library exists in a persisted form on disk.

Height [element Control] Height of the rectangular boundary of the control.

Height [element Dialog] The height of the dialog box in dialog units.

Height [element RadioButton]

Help [element Control] This attribute is reserved for future use.

Help [element RadioButton]

HelpDirectory [element TypeLib] The identifier of the Directory element for the help directory.

HelpKeyword [element Configuration] Keyword into chm file for authoring.

HelpLocation [element Configuration] Location of chm file for authoring.

Hidden [element Control] Set this attribute to "yes" to cause the Control to be hidden.

Hidden [element Dialog] Used to hide the dialog.

Hidden [element File] Set to yes in order to have the file's hidden attribute set when it isinstalled on the target machine.

Hidden [element Property] Denotes that the Property is not logged during installation.

Hidden [element TypeLib] Value of 'yes' means the type library should not be displayed to users,although its use is not restricted.

HideTarget [element CustomAction] Ensures the installer does not log the CustomActionData for thedeferred custom action.

Hotkey [element Shortcut] The hotkey for the shortcut.

Icon [element Class] The file providing the icon associated with this CLSID.

Icon [element Control] This attribute is only valid for RadioButton and PushButton Controls.

Icon [element ListItem] The identifier of the Binary (not Icon) element containing the icon toassociate with this item.

Icon [element ProgId] For an advertised ProgId, the Id of an Icon element.

Icon [element RadioButton] This attribute defines the icon displayed with the radio button.

Icon [element Shortcut] Identifier reference to Icon element.

IconIndex [element Class] Icon index into the icon file.

IconIndex [element ProgId]

IconIndex [element Shortcut] Identifier reference to Icon element.

IconSize [element Control] This attribute is only valid for RadioButton, PushButton, and IconControls.

Id [element AppId] Set this value to the AppID GUID that corresponds to the namedexecutable.

Id [element AssemblyName] Name of the attribute associated with the value specified in the Valuecolumn.

Id [element Billboard] Unique identifier for the Billboard.

Id [element BillboardAction] Action name that determines when the Billboard should be shown.

501

Page 502: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Id [element Binary] The Id cannot by longer than 55 characters.

Id [element BinaryRef] The identifier of the Binary element to reference.

Id [element Category] A string GUID that represents the category of components beinggrouped together.

Id [element Class] The Class identifier (CLSID) of a COM server.

Id [element Column] Identifier for the column.

Id [element Component] Component identifier; this is the primary key for identifyingcomponents.

Id [element ComponentGroup] Identifier for the ComponentGroup.

Id [element ComponentGroupRef] The identifier of the ComponentGroup to reference.

Id [element ComponentRef] The identifier of the Component element to reference.

Id [element ComponentSearch]

Id [element Control] Combined with the Dialog Id to make up the primary key of the Controltable.

Id [element CopyFile] Primary key used to identify this particular entry.

Id [element CustomAction] The identifier of the custom action.

Id [element CustomActionRef] The identifier of the CustomAction to reference.

Id [element CustomTable] Identifier for the custom table.

Id [element Dialog] Unique identifier for the dialog.

Id [element DialogRef] The identifier of the Dialog to reference.

Id [element DigitalCertificate] Identifier for a certificate file.

Id [element Directory] This value is the unique identifier of the directory entry.

Id [element DirectoryRef] The identifier of the Directory element to reference.

Id [element DirectorySearch] Unique identifier for the directory search.

Id [element DirectorySearchRef] Id of the search being referred to.

Id [element EmbeddedChainer] Unique identifier for embedded chainer.

Id [element EmbeddedChainerRef]

Id [element EmbeddedUI] Unique identifier for embedded UI.

Id [element EmbeddedUIResource] Identifier for the embedded UI resource.

Id [element EnsureTable] The name of the table.

Id [element Environment] Unique identifier for environment entry.

Id [element Error] Number of the error for which a message is being provided.

Id [element Extension] This is simply the file extension, like "doc" or "xml". Do not include thepreceding period.

Id [element Feature] Unique identifier of the feature.

Id [element FeatureGroup] Identifier for the FeatureGroup.

Id [element FeatureGroupRef] The identifier of the FeatureGroup to reference.

Id [element FeatureRef] The identifier of the Feature element to reference.

502

Page 503: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Id [element File] The unique identifier for this File element.

Id [element FileSearch] Unique identifier for the file search and external key into the Signaturetable.

Id [element FileSearchRef] Specify the Id to the FileSearch to reference.

Id [element Fragment] Optional identifier for a Fragment.

Id [element Icon] The Id cannot by longer than 55 characters.

Id [element IconRef] The identifier of the Icon element to reference.

Id [element IgnoreTable] The name of the table in the merge module that is not to be mergedinto the .msi file.

Id [element IniFile] Identifier for ini file.

Id [element IniFileSearch] External key into the Signature table.

Id [element Instance] The identity of the instance transform.

Id [element Interface] GUID identifier for COM Interface.

Id [element Media] Disk identifier for Media table.

Id [element Merge] The unique identifier for the Merge element in the source code.

Id [element MergeRef] The unique identifier for the Merge element to be referenced.

Id [element Module] The name of the merge module (not the file name).

Id [element ODBCDataSource] Identifier of the data source.

Id [element ODBCDriver] Identifier for the driver.

Id [element ODBCTranslator] Identifier for the translator.

Id [element Package] The package code GUID for a product or merge module.

Id [element Patch] Patch code for this patch.

Id [element PatchBaseline] Identifier for a set of product versions.

Id [element PatchCreation] PatchCreation identifier; this is the primary key for identifying patches.

Id [element PatchFamily] Identifier which indicates a sequence family to which this patchbelongs.

Id [element PatchFamilyRef] The identifier of the CustomAction to reference.

Id [element Product] The product code GUID for the product.

Id [element ProgId]

Id [element Property] Unique identifier for Property.

Id [element PropertyRef] Identifier of Property to reference.

Id [element Registry] Primary key used to identify this particular entry.

Id [element RegistryKey] Primary key used to identify this particular entry.

Id [element RegistrySearch] Signature to be used for the file, directory or registry key beingsearched for.

Id [element RegistrySearchRef] Specify the Id of the RegistrySearch to reference.

Id [element RegistryValue] Primary key used to identify this particular entry.

Id [element RemoveFile] Primary key used to identify this particular entry.

503

Page 504: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Id [element RemoveFolder] Primary key used to identify this particular entry.

Id [element RemoveRegistryKey] Primary key used to identify this particular entry.

Id [element RemoveRegistryValue] Primary key used to identify this particular entry.

Id [element ReplacePatch] Patch GUID to be unregistered if it exists on the machine targeted bythis patch.

Id [element ReserveCost] A primary key that uniquely identifies this ReserveCost entry.

Id [element ServiceControl]

Id [element ServiceDependency]

Id [element ServiceInstall] Unique identifier for this service.

Id [element SetDirectory] This attribute specifies a reference to a Directory element withmatching Id attribute.

Id [element SetProperty] This attribute specifies the Property to set to the Value.

Id [element SFPFile] Primary Key to File Table.

Id [element Shortcut] Unique identifier for the shortcut.

Id [element TargetFile] Foreign key into the File table.

Id [element TargetImage] Identifier for the target image.

Id [element TargetProductCode] The product code for a product that can receive this patch (or '*' for allproducts).

Id [element TextStyle]

Id [element TypeLib] The GUID that identifes the type library.

Id [element UI]

Id [element UIRef]

Id [element UIText]

Id [element Upgrade] This value specifies the upgrade code for the products that are to bedetected by the FindRelatedProducts action.

Id [element UpgradeImage] Identifier to connect target images with upgraded image.

Id [element Verb] The verb for the command.

Id [element WixVariable] The name of the variable.

Ignore [element UpgradeFile] If yes, the file is ignored during patching, and the next two attributesare ignored.

IgnoreActionData [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_ACTIONDATAmessages.

IgnoreActionStart [elementEmbeddedUI]

Embedded UI will not recieve anyINSTALLLOGMODE_ACTIONSTART messages.

IgnoreAddExistingRow [elementValidate]

Ignore errors when adding existing rows.

IgnoreAddExistingTable [elementValidate]

Ignore errors when adding existing tables.

IgnoreChangingCodePage [elementValidate]

Ignore errors when changing the database code page.

504

Page 505: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

IgnoreCommonData [elementEmbeddedUI]

Embedded UI will not recieve anyINSTALLLOGMODE_COMMONDATA messages.

IgnoreDeleteMissingRow [elementValidate]

Ignore errors when deleting missing rows.

IgnoreDeleteMissingTable [elementValidate]

Ignore errors when deleting missing tables.

IgnoreError [element EmbeddedUI] Embedded UI will not recieve any INSTALLLOGMODE_ERRORmessages.

IgnoreFatalExit [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_FATALEXITmessages.

IgnoreFilesInUse [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_FILESINUSEmessages.

IgnoreInfo [element EmbeddedUI] Embedded UI will not recieve any INSTALLLOGMODE_INFOmessages.

IgnoreInitialize [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_INITIALIZEmessages.

IgnoreMissingFiles [elementTargetImage]

Files missing from the target image are ignored by the installer.

IgnoreOutOfDiskSpace [elementEmbeddedUI]

Embedded UI will not recieve anyINSTALLLOGMODE_OUTOFDISKSPACE messages.

IgnoreParent [elementFeatureGroupRef]

Normally feature group references that end up nested under a parentelement create a connection to that parent.

IgnoreParent [element FeatureRef] Normally feature references that are nested under a parent elementcreate a connection to that parent.

IgnoreProgress [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_PROGRESSmessages.

IgnoreRemoveFailure [elementUpgradeVersion]

Set to "yes" to continue installation upon failure to remove a product orapplication.

IgnoreResolveSource [elementEmbeddedUI]

Embedded UI will not recieve anyINSTALLLOGMODE_RESOLVESOURCE messages.

IgnoreRMFilesInUse [elementEmbeddedUI]

Embedded UI will not recieve anyINSTALLLOGMODE_RMFILESINUSE messages.

IgnoreShowDialog [elementEmbeddedUI]

Embedded UI will not recieve anyINSTALLLOGMODE_SHOWDIALOG messages.

IgnoreTerminate [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_TERMINATEmessages.

IgnoreUpdateMissingRow [elementValidate]

Ignore errors when updating missing rows.

IgnoreUser [element EmbeddedUI] Embedded UI will not recieve any INSTALLLOGMODE_USERmessages.

IgnoreWarning [elementEmbeddedUI]

Embedded UI will not recieve any INSTALLLOGMODE_WARNINGmessages.

Image [element Control] This attribute is only valid for RadioButton, PushButton, and IconControls.

505

Page 506: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Impersonate [element CustomAction] This attribute specifies whether the Windows Installer, which executesas LocalSystem, should impersonate the user context of the installinguser when executing this custom action.

IncludeMaximum [elementUpgradeVersion]

Set to "yes" to make the range of versions detected include the valuespecified in Maximum.

IncludeMinimum [elementUpgradeVersion]

Set to "no" to make the range of versions detected exclude the valuespecified in Minimum.

Indirect [element Control] Specifies whether the value displayed or changed by this control isreferenced indirectly.

Insertable [element Class] Specifies the CLISD may be insertable.

InstallDefault [element Feature] This attribute determines the default install/run location of a feature.

InstallerVersion [element Package] The minimum version of the Windows Installer required to install thispackage.

InstallPrivileges [element Package] Use this attribute to specify the priviliges required to install the packageon Windows Vista and above.

InstallScope [element Package] Use this attribute to specify the installation scope of this package:per-machine or per-user.

Integer [element Control] Set this attribute to "yes" to cause the linked Property value for theControl to be treated as an integer. Otherwise, the Property will betreated as a string.

Interactive [element ServiceInstall] Whether or not the service interacts with the desktop.

Italic [element TextStyle]

JScriptCall [element CustomAction] This attribute specifies the name of the JScript function to execute in ascript.

KeepModeless [element Dialog] Keep modeless dialogs alive when this dialog is created throughDoAction.

Key [element IniFile] The localizable .ini file key within the section.

Key [element IniFileSearch] The key value within the section.

Key [element Registry] The localizable key for the registry value.

Key [element RegistryKey] The localizable key for the registry value.

Key [element RegistrySearch] Key for the registry value.

Key [element RegistryValue] The localizable key for the registry value.

Key [element RemoveRegistryKey] The localizable key for the registry value.

Key [element RemoveRegistryValue] The localizable key for the registry value.

KeyColumn [element Column] Column in the table in KeyTable attribute.

KeyNoOrphan [elementConfiguration]

Does not merge rule according to rules in MSI SDK.

KeyPath [element Component] If this attribute's value is set to 'yes', then the Directory of thisComponent is used as the KeyPath.

KeyPath [element File] Set to yes in order to force this file to be the key path for the parentcomponent.

KeyPath [element ODBCDataSource] Set 'yes' to force this file to be key path for parent Component

506

Page 507: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

KeyPath [element Registry] Set this attribute to 'yes' to make this registry key the KeyPath of theparent component.

KeyPath [element RegistryValue] Set this attribute to 'yes' to make this registry key the KeyPath of theparent component.

KeyTable [element Column] Table in which this column is an external key.

Keywords [element Package] Optional keywords for browsing.

Keywords [element PatchInformation] Optional keywords for browsing

Language [element Merge] Specifies the decimal LCID or localization token for the language tomerge the Module in as.

Language [element Module] The decimal language ID (LCID) of the merge module.

Language [element Product] The decimal language ID (LCID) for the product.

Language [element TypeLib] The language of the type library.

Language [element UpgradeVersion] Specifies the set of languages detected by FindRelatedProducts.

Languages [element FileSearch] The languages supported by the file.

Languages [element Package] The list of language IDs (LCIDs) supported in the package.

Languages [elementPatchInformation]

List of language IDs supported in package

Layout [element Media] This attribute specifies the root directory for the uncompressed filesthat are a part of this Media element.

LeftScroll [element Control] Set this attribute to "yes" to cause the scroll bar to display on the leftside of the Control.

LeftScroll [element Dialog] Used to align the scroll bar on the left.

Length [element IgnoreRange] Length of the range.

Length [element ProtectRange] Length of the range.

Level [element Condition] Used only under Feature elements and is required.

Level [element Feature] Sets the install level of this feature.

LoadOrderGroup [elementServiceInstall]

The load ordering group that this service should be a part of.

Localizable [element Column] Whether this column can be localized.

LocalService [element AppId] Set this value to the name of a service to allow the object to beinstalled as a Win32 service.

Location [element Component]

LongName [element Directory]

LongName [element File]

LongName [element FileSearch]

LongName [element IniFile]

LongName [element IniFileSearch]

LongName [element RemoveFile]

LongName [element Shortcut]

LongSource [element Directory]

507

Page 508: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

MajorVersion [element TypeLib] The major version of the type library.

Manufacturer [element Package] The vendor releasing the package.

Manufacturer [element Patch] Vendor releasing the package

Manufacturer [elementPatchInformation]

Vendor releasing the package

Manufacturer [element Product] The manufacturer of the product.

ManufacturerName [elementPatchMetadata]

Name of the manufacturer.

Mask [element FileTypeMask] Hex value that is AND'd against the bytes in the file at Offset.

MaxDate [element FileSearch] The maximum modification date and time of the file.

Maximum [element UpgradeVersion] Specifies the upper boundary of the range of product versions detectedby FindRelatedProducts.

MaxSize [element FileSearch] The maximum size of the file.

MaxValue [element Column] Maximum value for a numeric value, date or version in this column.

MaxVersion [element FileSearch] The maximum version of the file.

MediaSrcProp [element Family] Entered into the Source field of the new Media table entry of theupgraded image.

Message [element Condition] Used only under Fragment or Product elements and is required.

MigrateFeatures [elementUpgradeVersion]

Set to "yes" to migrate feature states from upgraded products byenabling the logic in the MigrateFeatureStates action.

MinDate [element FileSearch] The minimum modification date and time of the file.

Minimum [element UpgradeVersion] Specifies the lower bound on the range of product versions to bedetected by FindRelatedProducts.

MinorUpdateTargetRTM [elementPatch]

Indicates that the patch targets the RTM version of the product or themost recent major upgrade patch.

MinorUpdateTargetRTM [elementPatchMetadata]

Indicates that the patch targets the RTM version of the product or themost recent major upgrade patch.

MinorVersion [element TypeLib] The minor version of the type library.

MinSize [element FileSearch] The minimum size of the file.

MinValue [element Column] Minimum value for a numeric value, date or version in this column.

MinVersion [element FileSearch] The minimum version of the file.

Modeless [element Dialog] Used to set the dialog as modeless.

Modularize [element Column] How this column should be modularized, if at all.

MoreInfoURL [element Patch] A URL that provides information specific to this patch.

MoreInfoURL [elementPatchMetadata]

A URL that provides information specific to this patch.

Multiline [element Control] This attribute is only valid for Edit Controls.

Name [element Configuration] Defines the name of the configurable item.

Name [element ConfigurationData] Key into the ModuleConfiguration table.

Name [element Directory] The name of the directory.

508

Page 509: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Name [element EmbeddedUI] The name for the embedded UI DLL when it is extracted from theProduct and executed. (Windows Installer does not support the typicalshort filename and long filename combination for embedded UI files asit does for other kinds of files.)

Name [elementEmbeddedUIResource]

The name for the resource when it is extracted from the Product foruse by the embedded UI DLL. (Windows Installer does not support thetypical short filename and long filename combination for embedded UIfiles as it does for other kinds of files.)

Name [element Environment] Name of the environment variable.

Name [element Family] Identifier for the family.

Name [element File] In prior versions of the WiX toolset, this attribute specified the short filename. This attribute's value may now be either a short or long filename.

Name [element FileSearch] In prior versions of the WiX toolset, this attribute specified the short filename. This attribute's value may now be either a short or long filename.

Name [elementIgnoreModularization]

The name of the item to ignore modularization for.

Name [element IniFile] In prior versions of the WiX toolset, this attribute specified the shortname. This attribute's value may now be either a short or long name.

Name [element IniFileSearch] In prior versions of the WiX toolset, this attribute specified the shortname. This attribute's value may now be either a short or long name.

Name [element Interface] Name for COM Interface.

Name [element ODBCDataSource] Name for the data source.

Name [element ODBCDriver] Name for the driver.

Name [element ODBCTranslator] Name for the translator.

Name [element PatchProperty] Name of the patch property.

Name [element Product] The descriptive name of the product.

Name [element Registry] The localizable registry value name.

Name [element RegistrySearch] Registry value name.

Name [element RegistryValue] The localizable registry value name.

Name [element RemoveFile] This value should be set to the localizable name of the file(s) to beremoved.

Name [elementRemoveRegistryValue]

The localizable registry value name.

Name [element ServiceControl] Name of the service.

Name [element ServiceInstall] This column is the string that gives the service name to install.

Name [element SFPCatalog] Filename for catalog file when installed.

Name [element Shortcut] In prior versions of the WiX toolset, this attribute specified the shortname. This attribute's value may now be either a short or long name.

NeverOverwrite [elementComponent]

If this attribute is set to 'yes', the installer does not install or reinstall thecomponent if a key path file or a key path registry entry for thecomponent already exists.

509

Page 510: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

NoMinimize [element Dialog] Used to specify if the dialog can be minimized.

NonNullable [element Configuration] If yes, null is not a valid entry.

NoOpen [element ProgId] Specifies that the associated ProgId should not be opened by users.

NoPrefix [element Control] This attribute is only valid for Text Controls.

Notify [element Permission]

NoWrap [element Control] This attribute is only valid for Text Controls.

Nullable [element Column] Whether this column can be left null.

NumMethods [element Interface] Number of methods implemented on COM Interface.

Offset [element FileTypeMask] Offset into file. If positive, offset is from the beginning; if negative,offset is from the end.

Offset [element IgnoreRange] Offset of the start of the range.

Offset [element ProtectRange] Offset of the start of the range.

On [element RemoveFile] This value determines the time at which the file(s) may be removed.

On [element RemoveFolder] This value determines the time at which the folder may be removed.

OnExit [element Custom] Mutually exclusive with Before, After, and Sequence attributes

OnExit [element Show] mutually exclusive with Before, After, and Sequence attributes

OnlyDetect [elementUpgradeVersion]

Set to "yes" to detect products and applications but do not uninstall.

OptimizedInstallMode [elementPatch]

If this attribute is set to 'yes' in all the patches to be applied in atransaction, the application of the patch is optimized if possible.

OptimizedInstallMode [elementPatchMetadata]

If this attribute is set to 'yes' in all the patches to be applied in atransaction, the application of the patch is optimized if possible.

OptimizePatchSizeForLargeFiles[element Patch]

When this attribute is set, patches for files greater than approximately4 MB in size may be made smaller.

Order [element ExternalFile] Specifies the order of the external files to use when creating the patch.

Order [element Publish] This attribute should only need to be set if this element is nested undera UI element in order to control the order in which this publish eventwill be started.

Order [element TargetImage] Relative order of the target image.

OutputPath [element PatchCreation] The full path, including file name, of the patch package file that is to begenerated.

Overridable [element Custom] If "yes", the sequencing of this action may be overridden bysequencing elsewhere.

Overridable [element Show] If "yes", the sequencing of this dialog may be overridden bysequencing elsewhere.

Overridable [element WixVariable] Set this value to 'yes' in order to make the variable's value overridableeither by another WixVariable entry or via the command-line option-d<name>=<value> for light.exe.

Overridable [typeActionModuleSequenceType]

If "yes", the sequencing of this action may be overridden bysequencing elsewhere.

Parent [element DirectorySearchRef] This attribute is the signature of the parent directory of the file ordirectory in the Signature_ column.

510

Page 511: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Part [element Environment]

Password [element Control] This attribute is only valid for Edit Controls.

Password [element ServiceInstall] The password for the account. Valid only when the account has apassword.

PatchAllowIgnoreOnError [elementFile]

Set to indicate that the patch is non-vital.

PatchFamily [elementPatchSequence]

Identifier which indicates a sequence family to which this patchbelongs.

PatchGroup [element File] This attribute must be set for patch-added files.

PatchIgnore [element File] Prevents the updating of the file that is in fact changed in the upgradedimage relative to the target images.

PatchUninstall [elementCustomAction]

This attribute specifies that the Windows Installer, execute the customaction only when a patch is being uninstalled.

PatchWholeFile [element File] Set if the entire file should be installed rather than creating a binarypatch.

Path [element DirectorySearch] Path on the user's system. Either absolute, or relative to containingdirectories.

Path [element DirectorySearchRef] Path on the user's system. Either absolute, or relative to containingdirectories.

Path [element SymbolPath] The path.

Permanent [element Component] If this attribute is set to 'yes', the installer does not remove thecomponent during an uninstall.

Permanent [element Environment] Specifies that the environment variable should not be removed onuninstall.

Platform [element Package] The platform supported by the package.

Platforms [element Package]

Platforms [element PatchInformation] List of platforms supported in package

Primary [elementComponentGroupRef]

Set this attribute to 'yes' in order to make the parent feature of thiscomponent the primary feature for this component.

Primary [element ComponentRef] Set this attribute to 'yes' in order to make the parent feature of thiscomponent the primary feature for this component.

Primary [element FeatureGroupRef] Set this attribute to 'yes' in order to make the parent feature of thisgroup the primary feature for any components and merges containedin the group.

Primary [element MergeRef] Specifies whether the feature containing this MergeRef is the primaryfeature for advertising the merge module's components.

PrimaryKey [element Column] Whether this column is a primary key.

ProcessorArchitecture [element File] Specifies the architecture for this assembly.

ProductCode [element Instance] The ProductCode for this instance.

ProductCode [element PatchFamily] Specifies the ProductCode of the product that this family applies to.

ProductCode [elementPatchSequence]

Specifies the ProductCode of the product that this family applies to.

511

Page 512: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

ProductId [element Validate] Requires that the upgrade ProductCode match the targetProductCode.

ProductLanguage [element Validate] Requires that the upgrade ProductLanguage match the targetProductLanguage.

ProductName [element Instance] The ProductName for this instance.

ProductVersion [element Validate] Determines how many fields in the ProductVersion to check.

ProductVersionOperator [elementValidate]

Determines how the target and upgrade ProductVersions arecompared.

Programmable [element Class] Specifies the CLSID may be programmable.

ProgressBlocks [element Control] This attribute is only valid for ProgressBar Controls.

Property [element ComboBox] Property tied to this group

Property [element Control] The name of a defined property to be linked to this control.

Property [element CustomAction] This attribute specifies a reference to a Property element withmatching Id attribute that specifies the Property to be used or updatedon execution of this custom action.

Property [element CustomProperty] The name of the metadata property.

Property [elementInstanceTransforms]

The Id of the Property who's value should change for each instance.

Property [element ListBox] Property tied to this group

Property [element ListView] Property tied to this group

Property [element Publish] Set this attribute's value to a property name to set that property.

Property [elementRadioButtonGroup]

Property tied to this group.

Property [element RemoveFile] Overrides the directory of the parent component with the value of thespecified property.

Property [element RemoveFolder] Overrides the directory of the parent component with the value of thespecified property.

Property [element UpgradeVersion] When the FindRelatedProducts action detects a related productinstalled on the system, it appends the product code to the propertyspecified in this field.

PropertySource [elementEmbeddedChainer]

Reference to a Property that resolves to the full path to the chainerexecuteable.

ProxyStubClassId [element Interface] GUID CLSID for proxy stub to COM Interface.

ProxyStubClassId32 [elementInterface]

GUID CLSID for 32-bit proxy stub to COM Interface.

PushLike [element Control] This attribute is only valid for RadioButton and Checkbox Controls.

Qualifier [element Category] A text string that qualifies the value in the Id attribute.

RAMDisk [element Control] This attribute is only valid for Volume and Directory Controls.

Read [element Permission]

ReadAttributes [element Permission]

ReadExtendedAttributes [elementPermission]

512

Page 513: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

ReadOnly [element File] Set to yes in order to have the file's read-only attribute set when it isinstalled on the target machine.

ReadOnly [element Package] The value of this attribute conveys whether the package should beopened as read-only.

ReadOnly [elementPatchInformation]

The value of this attribute conveys whether the package should beopened as read-only.

ReadPermission [elementPermission]

Red [element TextStyle] 0 to 255

Registration [elementODBCDataSource]

Scope for which the data source should be registered.

RelativePath [element Class] When the value is "yes", the bare file name can be used for COMservers.

Remote [element Control] This attribute is only valid for Volume and Directory Controls.

RemoteServerName [element AppId] Set this value to the name of the remote server to configure the clientto request the object be run at a particular machine whenever anactivation function is called for which a COSERVERINFO structure isnot specified.

Removable [element Control] This attribute is only valid for Volume and Directory Controls.

Remove [element ServiceControl] Specifies whether the service should be removed on install, uninstall orboth.

RemoveFeatures [elementUpgradeVersion]

The installer sets the REMOVE property to features specified in thiscolumn.

RequiredId [element Dependency] Identifier of the merge module required by the merge module.

RequiredLanguage [elementDependency]

Numeric language ID of the merge module in RequiredID.

RequiredVersion [elementDependency]

Version of the merge module in RequiredID.

RequiredVersion [element Wix] Required version of the WiX toolset to compile this input file.

ResourceId [element TypeLib] The resource id of a typelib.

Restricted [element TypeLib] Value of 'yes' means the type library is restricted, and should not bedisplayed to users.

Return [element CustomAction] Set this attribute to set the return behavior of the custom action.

RightAligned [element Control] Set this attribute to "yes" to cause the Control to be right aligned.

RightAligned [element Dialog] Align text on the right.

RightToLeft [element Control] Set this attribute to "yes" to cause the Control to display from right toleft.

RightToLeft [element Dialog] Used to specify if the text in the dialog should be displayed in right toleft reading order.

Root [element Registry] The predefined root key for the registry value.

Root [element RegistryKey] The predefined root key for the registry value.

Root [element RegistrySearch] Root key for the registry value.

Root [element RegistryValue] The predefined root key for the registry value.

513

Page 514: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Root [element RemoveRegistryKey] The predefined root key for the registry value.

Root [elementRemoveRegistryValue]

The predefined root key for the registry value.

Row [element Substitution] Specifies the primary keys of the target row in the table named in theTable column.

RunAsInteractiveUser [elementAppId]

Set this value to 'yes' to configure a class to run under the identity ofthe user currently logged on and connected to the interactive desktopwhen activated by a remote client without being written as a Win32service.

RunFromSource [elementReserveCost]

The number of bytes of disk space to reserve if the component isinstalled to run from source.

RunLocal [element ReserveCost] The number of bytes of disk space to reserve if the component isinstalled to run locally.

SafeForInitializing [element Class] May only be specified if the value of the Advertise attribute is "no".

SafeForScripting [element Class] May only be specified if the value of the Advertise attribute is "no".

Script [element CustomAction] Creates a type 37 or 38 custom action.

Section [element IniFile] The localizable .ini file section.

Section [element IniFileSearch] The localizable .ini file section.

Secure [element Property] Denotes that the Property can be passed to the server side whendoing a managed installation with elevated privileges.

SelfRegCost [element File] The cost of registering the file in bytes.

Separator [element Environment] Optional attribute to change the separator used between values.

Sequence [element Custom] The sequence number for this action.

Sequence [element PatchSequence] Used to populate the sequence column of the MsiPatchSequence tablein the final MSP file.

Sequence [element SetDirectory] Controls which sequences the Directory assignment is sequenced in.

Sequence [element SetProperty] Controls which sequences the Property assignment is sequenced in.

Sequence [element Show]

Sequence [element Verb] The sequence of the commands.

Sequence [typeActionModuleSequenceType]

A value used to indicate the position of this action in a sequence.

Sequence [typeActionSequenceType]

A value used to indicate the position of this action in a sequence.

SequenceStart [element Family] Sequence number for the starting file.

Server [element Class] May only be specified if the value of the Advertise attribute is "no".

ServiceParameters [element AppId] Set this value to the parameters to be passed to a LocalService oninvocation.

Set [element Column] Semicolon delimited list of permissible values.

SetupFile [element ODBCDriver] Required if not found as child of File element or different from Fileattribute above

SetupFile [element ODBCTranslator] Required if not found as child of File element or different from Fileattribute above

514

Page 515: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Shared [element Component] If this attribute's value is set to 'yes', enables advanced patchingsemantics for Components that are shared across multiple Products.

Shared [element IsolateComponent] Shared Component for this application Component.

SharedDllRefCount [elementComponent]

If this attribute's value is set to 'yes', the installer increments thereference count in the shared DLL registry of the component's key file.

ShortName [element Directory] The short name of the directory in 8.3 format.

ShortName [element File] The short file name of the file in 8.3 format.

ShortName [element FileSearch] The short file name of the file in 8.3 format.

ShortName [element IniFile] The short name of the in 8.3 format.

ShortName [element IniFileSearch] The short name of the file in 8.3 format.

ShortName [element RemoveFile] The short file name of the file in 8.3 format.

ShortName [element Shortcut] The short name of the shortcut in 8.3 format.

ShortNames [element Package] Set to 'yes' to have short filenames in the source.

ShortNames [elementPatchInformation]

Short filenames on source

ShortPath [element Class] Specifies whether or not to use the short path for the COM server.

ShortSourceName [elementDirectory]

The short name of the directory on the source media in 8.3 format.

Show [element Shortcut]

ShowRollbackCost [element Control] This attribute is only valid for VolumeCostList Controls.

Size [element TextStyle]

SkipAssignment [elementOptimizeCustomActions]

Skip property (type 51) and directory (type 35) assignment customactions.

SkipDeferred [elementOptimizeCustomActions]

Skip custom actions that run within the script.

SkipImmediate [elementOptimizeCustomActions]

Skip immediate custom actions that are not property or directoryassignment custom actions.

Sorted [element Control] This attribute is only valid for Listbox, ListView, and ComboBoxControls.

Source [element ExternalFile] Full path of the external file.

Source [element File] Specifies the path to the File in the build process.

Source [element Media] Optional property that identifies the source of the embedded cabinet.

SourceDirectory [element CopyFile] This attribute cannot be specified if the element is nested under a Fileelement or the FileId attribute is specified.

SourceFile [element Binary] Path to the binary file.

SourceFile [elementDigitalCertificate]

The path to the certificate file.

SourceFile [element DigitalSignature] The path to signature's optional hash file.

SourceFile [element EmbeddedUI] Path to the binary file that is the embedded UI.

SourceFile [elementEmbeddedUIResource]

Path to the binary file that is the embedded UI resource.

515

Page 516: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

SourceFile [element Icon] Path to the icon file.

SourceFile [element Merge] Path to the source location of the merge module.

SourceFile [element SFPCatalog] Path to catalog file in binary.

SourceFile [element TargetImage] Full path to the location of the msi file for the target image.

SourceFile [element Text] Instructs the text to be imported from a file instead of the element valueduring the binding process.

SourceFile [element UpgradeImage] Full path to location of msi file for upgraded image.

SourceList [element PatchCreation] Used to locate the .msp file for the patch if the cached copy isunavailable.

SourceName [element CopyFile] This attribute cannot be specified if the element is nested under a Fileelement or the FileId attribute is specified.

SourceName [element Directory] The name of the directory on the source media.

SourcePatch [elementUpgradeImage]

Modified copy of the upgraded installation database that containsadditional authoring specific to patching.

SourceProperty [element CopyFile] This attribute cannot be specified if the element is nested under a Fileelement or the FileId attribute is specified.

src [element Binary]

src [element Directory]

src [element DirectoryRef]

src [element ExternalFile]

src [element File]

src [element Icon]

src [element Media]

src [element Merge]

src [element TargetImage]

src [element Text]

src [element UpgradeImage]

srcPatch [element UpgradeImage]

Start [element ServiceControl] Specifies whether the service should be started on install, uninstall orboth.

Start [element ServiceInstall] Determines when the service should be started.

Stop [element ServiceControl] Specifies whether the service should be stopped on install, uninstall orboth.

Strike [element TextStyle]

SummaryCodepage [elementPackage]

The code page integer value or web name for summary info stringsonly.

SummaryCodepage [elementPatchInformation]

The code page integer value or web name for summary info stringsonly.

Sunken [element Control] Set this attribute to "yes" to cause the Control to be sunken.

Supersede [element PatchFamily] Set this value to 'yes' to indicate that this patch will supersede allprevious patches in this patch family.

516

Page 517: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Supersede [element PatchSequence] Set this value to 'yes' to indicate that this patch will supersede allprevious patches in this patch family.

SupportBasicUI [elementEmbeddedUI]

Set yes to allow the Windows Installer to display the embedded UIduring basic UI level installation.

Suppress [typeActionModuleSequenceType]

If yes, this action will not occur.

Suppress [typeActionSequenceType]

If yes, this action will not occur.

SuppressModularization [elementBinary]

Use to suppress modularization of this Binary identifier in mergemodules.

SuppressModularization [elementCustomAction]

Use to suppress modularization of this custom action name in mergemodules.

SuppressModularization [elementProperty]

Use to suppress modularization of this property identifier in mergemodules.

SymbolFlags [elementPatchCreation]

An 8-digit hex integer representing the combination of patch symbolusage flags to use when creating a binary file patch.

Synchronize [element Permission]

System [element Environment] Specifies that the environment variable should be added to the systemenvironment space.

System [element File] Set to yes in order to have the file's system attribute set when it isinstalled on the target machine.

SystemModal [element Dialog] Used to set the dialog as system modal.

Table [element Substitution] Specifies the name of the table being modified in the module database.

TabSkip [element Control] Set this attribute to "yes" to cause this Control to be skipped in the tabsequence.

TakeOwnership [element Permission]

Target [element PatchSequence]

Target [element Shortcut] This attribute can only be set if this Shortcut element is nested under aComponent element.

Target [element Verb]

TargetFile [element Verb] Either this attribute or the TargetProperty attribute must be specifiedfor a non-advertised verb.

TargetImage [elementPatchSequence]

Specifies the TargetImage that this family applies to.

TargetProductName [element Patch] Name of the application or target product suite.

TargetProductName [elementPatchMetadata]

Name of the application or target product suite.

TargetProperty [element Verb] Either this attribute or the TargetFile attribute must be specified for anon-advertised verb.

Template [element ProgressText] used to format ActionData messages from action processing

TerminalServerAware [elementCustomAction]

This attribute specifies controls whether the custom action willimpersonate the installing user during per-machine installs on TerminalServer machines.

517

Page 518: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Text [element Control] A localizable string used to set the initial text contained in a control.

Text [element ListItem] The localizable, visible text to be assigned to the item.

Text [element RadioButton] Text displayed with the radio button.

ThreadingModel [element Class] Threading model for the CLSID.

Title [element Dialog] The title of the dialog box.

Title [element Feature] Short string of text identifying the feature.

ToolTip [element Control] The string used for the Tooltip.

ToolTip [element RadioButton]

TrackDiskSpace [element Dialog] Have the dialog periodically call the installer to check if available diskspace has changed.

Transitive [element Component] If this attribute is set to 'yes', the installer reevaluates the value of thestatement in the Condition upon a reinstall.

Transparent [element Control] This attribute is only valid for Text Controls.

Traverse [element Permission] For a directory, the right to traverse the directory.

TrueType [element File] Causes an entry to be generated for the file in the Font table with noFontTitle specified.

Type [element Column] The type of this column.

Type [element ComponentSearch] Must be file if last child is FileSearch element and must be directory iflast child is DirectorySearch element.

Type [element Configuration] Specifies the type of the data being changed.

Type [element Control] The type of the control.

Type [element IgnoreModularization] The type of the item to ignore modularization for.

Type [element IniFileSearch] Must be file if last child is FileSearch element and must be directory iflast child is DirectorySearch element.

Type [element Registry] Set this attribute to the type of the desired registry key.

Type [element RegistrySearch] The value must be 'file' if the last child is a FileSearch element andmust be 'directory' if last child is a DirectorySearch element.

Type [element RegistryValue] Set this attribute to the type of the desired registry key.

Type [element ServiceInstall] The Windows Installer does not currently support kernelDriver orsystemDriver

TypicalDefault [element Feature] This attribute determines the default advertise state of the feature.

Underline [element TextStyle]

UninstallWhenSuperseded [elementComponent]

If this attribute is set to 'yes', the installer will uninstall the Component'sfiles and registry keys when it is superseded by a patch.

UpgradeCode [element Product] The upgrade code GUID for the product.

UpgradeCode [element Validate] Requires that the upgrade UpgradeCode match the targetUpgradeCode.

User [element Permission]

UserLanguage [element Control] This attribute is only valid for Text Controls.

Validation [element TargetImage] Product checking to avoid applying irrelevant transforms.

518

Page 519: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Value [element AssemblyName] Value associated with the name specified in the Name column.

Value [element ConfigurationData] Value to be passed to configurable merge module.

Value [element CustomAction] This attribute specifies a string value to use in the custom action.

Value [element CustomProperty] Value of the metadata property.

Value [element Environment] The value to set into the environment variable.

Value [element FileTypeMask] 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.

Value [element IniFile] The localizable value to be written or deleted. This attribute must beset if the Action attribute's value is "addLine", "addTag", or"createLine".

Value [element ListItem] The value assigned to the associated ComboBox, ListBox, or ListViewproperty if this item is selected.

Value [element PatchProperty] Value of the patch property.

Value [element Property] Sets a default value for the property. The value will be overwritten if theProperty is used for a search.

Value [element Publish] If the Property attribute is specified, set the value of this attribute to thenew value for the property.

Value [element RadioButton] Value assigned to the associated control Property when this radiobutton is selected.

Value [element Registry] Set this attribute to the localizable registry value. This value isformatted.

Value [element RegistryValue] Set this attribute to the localizable registry value.

Value [element SetDirectory] This attribute specifies a string value to assign to the Directory.

Value [element SetProperty] This attribute specifies a string value to assign to the Property.

Value [element Substitution] Provides a formatting template for the data being substituted into thetarget field specified by Table, Row, and Column.

Value [element WixVariable] The value of the variable.

VBScriptCall [element CustomAction] This attribute specifies the name of the VBScript Subroutine to executein a script.

Version [element Class] Version for the CLSID.

Version [element Module] The major and minor versions of the merge module.

Version [element PatchFamily] Used to populate the sequence column of the MsiPatchSequence tablein the final MSP file.

Version [element Product] The product's version string.

Versioned [element Interface] Determines whether a Typelib version entry should be created with theother COM Interface registry keys.

Vital [element File] If a file is vital, then installation cannot proceed unless the file issuccessfully installed.

Vital [element ServiceInstall] The overall install should fail if this service fails to install.

VolumeLabel [element Family] Entered into the VolumeLabel field of the new Media table record.

VolumeLabel [element Media] The label attributed to the volume.

519

Page 520: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attributes

Name Description

Wait [element ServiceControl] Specifies whether or not to wait for the service to complete beforecontinuing.

WholeFile [element UpgradeFile] Whether the whole file should be installed, rather than creating abinary patch.

WholeFilesOnly [elementPatchCreation]

Use this to set whether changing files should be included in theirentirety.

Width [element Column] Width of this column.

Width [element Control] Width of the rectangular boundary of the control.

Width [element Dialog] The width of the dialog box in dialog units.

Width [element RadioButton]

Win64 [element Component] Set this attribute to 'yes' to mark this as a 64-bit component.

Win64 [element CustomAction] Specifies that a script custom action targets a 64-bit platform.

Win64 [element RegistrySearch] Instructs the search to look in the 64-bit registry when the value is'yes'.

WorkingDirectory [element Shortcut] Directory identifier (or Property identifier that resolves to a directory)that resolves to the path of the working directory for the shortcut.

Write [element Permission]

WriteAttributes [element Permission]

WriteExtendedAttributes [elementPermission]

X [element Control] Horizontal coordinate of the upper-left corner of the rectangularboundary of the control.

X [element Dialog] Horizontal placement of the dialog box as a percentage of screenwidth.

X [element RadioButton]

Y [element Control] Vertical coordinate of the upper-left corner of the rectangular boundaryof the control.

Y [element Dialog] Vertical placement of the dialog box as a percentage of screen height.

Y [element RadioButton]

520

Page 521: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Absent [element Feature]

Description

This attribute determines if a user will have the option to set a feature to absent in the user interface.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

allow Allows the user interface to display an option to change the featurestate to Absent.

disallow Prevents the user interface from displaying an option to change thefeature stateto Absent by setting the msidbFeatureAttributesUIDisallowAbsentattribute. This will force the featureto the installation state, whether or not the feature is visible in the UI.

Referenced By

● Element Feature

Definition

See Feature

521

Page 522: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Account [element ServiceInstall]

Description

The acount under which to start the service. Valid only when ServiceType is ownProcess.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

522

Page 523: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element Condition]

Description

Used only under Control elements and is required. Allows specific actions to be applied to a control based onthe result of this condition.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

default Set the Control as the default. Only used under Control elements.

enable Enable the Control. Only used under Control elements.

disable Disable the Control. Only used under Control elements.

hide Hide the Control. Only used under Control elements.

show Display the Control. Only used under Control elements.

Referenced By

● Element Condition

Definition

See Condition

523

Page 524: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element Custom]

Description

The action to which the Custom element applies.

Derived By

Type string

Referenced By

● Element Custom

Definition

See Custom

524

Page 525: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element Environment]

Description

Specfies whether the environmental variable should be created, set or removed when the parent component isinstalled.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

create Creates the environment variable if it does not exist, then set it duringinstallation. This has no effect on the value of the environment variableif it already exists.

set Creates the environment variable if it does not exist, and then set itduring installation. If the environment variable exists, set it during theinstallation.

remove Removes the environment variable during an installation.The installer only removes an environment variable during aninstallation if the name and valueof the variable match the entries in the Name and Value attributes.If you want to remove an environment variable, regardless of its value,do not set the Value attribute.

Referenced By

● Element Environment

Definition

See Environment

525

Page 526: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element IniFile]

Description

The type of modification to be made.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

addLine Creates or updates an .ini entry.

addTag Creates a new entry or appends a new comma-separated value to anexisting entry.

createLine Creates an .ini entry only if the entry does no already exist.

removeLine Removes an .ini entry.

removeTag Removes a tag from an .ini entry.

Referenced By

● Element IniFile

Definition

See IniFile

526

Page 527: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element ProgressText]

Derived By

Type string

Referenced By

● Element ProgressText

Definition

See ProgressText

527

Page 528: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element Registry]

Description

This is the action that will be taken for this registry key.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

append Appends the specified value(s) to a multiString registry key.

createKey Creates the key, if absent, when the parent component is installed.

createKeyAndRemoveKeyOnUninstall

Creates the key, if absent, when the parent component is installed thenremove the key with all its values and subkeys when the parentcomponent is uninstalled.

prepend Prepends the specified value(s) to a multiString registry key.

remove Removes a registry name when the parent component in installed.

removeKeyOnInstall Removes a key with all its values and subkeys when the parentcomponent is installed.

removeKeyOnUninstall Removes a key with all its values and subkeys when the parentcomponent is uninstalled.

write Writes a registry value.

Referenced By

● Element Registry

Definition

See Registry

528

Page 529: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element RegistryKey]

Description

This is the action that will be taken for this registry value.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

create Creates the key, if absent, when the parent component is installed.

createAndRemoveOnUninstall Creates the key, if absent, when the parent component is installed thenremove the key with all its values and subkeys when the parentcomponent is uninstalled.

none Does nothing; this element is used merely in WiX authoring fororganization and does nothing to the final output.This is the default value.

Referenced By

● Element RegistryKey

Definition

See RegistryKey

529

Page 530: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element RegistryValue]

Description

This is the action that will be taken for this registry value.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

append Appends the specified value(s) to a multiString registry value.

prepend Prepends the specified value(s) to a multiString registry value.

write Writes a registry value. This is the default value.

Referenced By

● Element RegistryValue

Definition

See RegistryValue

530

Page 531: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Action [element RemoveRegistryKey]

Description

This is the action that will be taken for this registry value.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

removeOnInstall Removes a key with all its values and subkeys when the parentcomponent is installed.

removeOnUninstall Removes a key with all its values and subkeys when the parentcomponent is uninstalled.

Referenced By

● Element RemoveRegistryKey

Definition

See RemoveRegistryKey

531

Page 532: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ActivateAtStorage [element AppId]

Description

Set this value to 'yes' to configure the client to activate on the same system as persistent storage.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element AppId

Definition

See AppId

532

Page 533: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Admin [element Property]

Description

Denotes that the Property is saved during

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Property

Remarks

<html:a href="http://msdn.microsoft.com/library/aa367541.aspx" target="_blank"xmlns:html="http://www.w3.org/1999/xhtml">admininistrative installation</html:a>

. See the

<html:a href="http://msdn.microsoft.com/library/aa367542.aspx" target="_blank"xmlns:html="http://www.w3.org/1999/xhtml">AdminProperties Property</html:a>

for more information.

Definition

See Property

533

Page 534: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AdminImage [element Package]

Description

Set to 'yes' if the source is an admin image.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Package

Definition

See Package

534

Page 535: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AdminImage [element PatchInformation]

Description

Source is an admin image

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchInformation

Definition

See PatchInformation

535

Page 536: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element AppId]

Description

Set this value to 'yes' in order to create a normal AppId table row. Set this value to 'no' in order to generateRegistry rows that perform similar registration (without the often problematic Windows Installer advertisingbehavior).

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element AppId

Definition

See AppId

536

Page 537: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element Class]

Description

Set this value to "yes" in order to create a normal Class table row. Set this value to "no" in order to generateRegistry rows that perform similar registration (without the often problematic Windows Installer advertisingbehavior).

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Definition

See Class

537

Page 538: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element Extension]

Description

Whether this extension is to be advertised. The default is "no".

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Extension

Definition

See Extension

538

Page 539: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element MIME]

Description

Whether this MIME is to be advertised.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element MIME

Remarks

The default is to match whatever the parent extension element uses. If the parent element is not advertised,then this element cannot be advertised either.

Definition

See MIME

539

Page 540: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element ProgId]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ProgId

Definition

See ProgId

540

Page 541: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element Shortcut]

Description

Specifies if the shortcut should be advertised or not.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Shortcut

Remarks

Note that advertised shortcuts always point at a particular application, identified by a ProductCode, and shouldnot be shared between applications. Advertised shortcuts only work for the most recently installed application,and are removed when that application is removed. The default value is 'no'.

Definition

See Shortcut

541

Page 542: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Advertise [element TypeLib]

Description

Value of 'yes' will create a row in the TypeLib table. Value of 'no' will create rows in the Registry table.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TypeLib

Remarks

The default value is 'no'.

Definition

See TypeLib

542

Page 543: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: After [element Custom]

Description

The name of the standard or custom action after which this action should be performed.

Derived By

Type string

Referenced By

● Element Custom

Remarks

Mutually exclusive with Before, OnExit, and Sequence attributes

Definition

See Custom

543

Page 544: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: After [element SetProperty]

Description

The name of the standard or custom action after which this action should be performed.

Derived By

Type string

Referenced By

● Element SetProperty

Remarks

Mutually exclusive with the Before attribute. A Before or After attribute is required when setting a Property.

Definition

See SetProperty

544

Page 545: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: After [element Show]

Derived By

Type string

Referenced By

● Element Show

Definition

See Show

545

Page 546: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: After [type ActionModuleSequenceType]

Description

The name of an action that this action should come after.

Derived By

Type string

Referenced By

● Complex Type ActionModuleSequenceType

Definition

See ActionModuleSequenceType

546

Page 547: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AllowAdvertise [element Feature]

Description

This attribute determins the possible advertise states for this feature.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

no Prevents this feature from being advertised by settting themsidbFeatureAttributesDisallowAdvertise attribute.

system Prevents advertising for this feature if the operating system shell doesnot support Windows Installerdescriptors by setting themsidbFeatureAttributesNoUnsupportedAdvertise attribute.

yes Allows the feature to be advertised.

Referenced By

● Element Feature

Definition

See Feature

547

Page 548: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AllowIgnoreOnError [element UpgradeFile]

Description

Specifies whether patching this file is vital.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeFile

Definition

See UpgradeFile

548

Page 549: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AllowMajorVersionMismatches [element PatchCreation]

Description

Use this to set whether the major versions between the upgrade and target images match.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchCreation

Remarks

See AllowProductVersionMajorMismatches for more information.

Definition

See PatchCreation

549

Page 550: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AllowProductCodeMismatches [element PatchCreation]

Description

Use this to set whether the product code between the upgrade and target images match.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchCreation

Remarks

See AllowProductCodeMismatches for more information.

Definition

See PatchCreation

550

Page 551: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AllowRemoval [element Patch]

Description

Whether this is an uninstallable patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Definition

See Patch

551

Page 552: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AllowRemoval [element PatchMetadata]

Description

Whether this is an uninstallable patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchMetadata

Definition

See PatchMetadata

552

Page 553: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ApiPatchingSymbolNoFailuresFlag [element Patch]

Description

Flag used when creating a binary file patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Remarks

Default is "no". Don't fail patch due to imagehlp failures.

Definition

See Patch

553

Page 554: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ApiPatchingSymbolNoImagehlpFlag [element Patch]

Description

Flag used when creating a binary file patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Remarks

Default is "no". Don't use imagehlp.dll.

Definition

See Patch

554

Page 555: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ApiPatchingSymbolUndecoratedTooFlag [element Patch]

Description

Flag used when creating a binary file patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Remarks

Default is "no". After matching decorated symbols, try to match remaining by undecorated names.

Definition

See Patch

555

Page 556: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AppData [element Category]

Description

An optional localizable text describing the category.

Derived By

Type string

Referenced By

● Element Category

Remarks

The string is commonly parsed by the application and can be displayed to the user. It should describe thecategory.

Definition

See Category

556

Page 557: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Append [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

557

Page 558: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AppId [element Class]

Description

This attribute is only allowed when a Class is advertised.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Class

Remarks

Using this attribute will reference an Application ID containing DCOM information for the associated applicationGUID. The value must correspond to an AppId/@Id of an AppId element nested under a Fragment, Module, orProduct element. To associate an AppId with a non-advertised class, nest the class within a parent AppIdelement.

Definition

See Class

558

Page 559: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Argument [element Class]

Description

This column is optional only when the Context column is set to "LocalServer" or "LocalServer32" server context.

Derived By

Type string

Referenced By

● Element Class

Remarks

The text is registered as the argument against the OLE server and is used by OLE for invoking the server. Notethat the resolution of properties in the Argument field is limited. A property formatted as [Property] in this fieldcan only be resolved if the property already has the intended value when the component owning the class isinstalled. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process mustbe installing the file MyDoc.doc and the component that owns the class.

Definition

See Class

559

Page 560: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Argument [element Verb]

Description

Value for the command arguments.

Derived By

Type string

Referenced By

● Element Verb

Remarks

Note that the resolution of properties in the Argument field is limited. A property formatted as [Property] in thisfield can only be resolved if the property already has the intended value when the component owning the verbis installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same processmust be installing the file MyDoc.doc and the component that owns the verb.

Definition

See Verb

560

Page 561: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Arguments [element ServiceInstall]

Description

Contains any command line arguments or properties required to run the service.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

561

Page 562: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Arguments [element Shortcut]

Description

The command-line arguments for the shortcut.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in thisfield can only be resolved if the property already has the intended value when the component owning theshortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the sameprocess must be installing the file MyDoc.doc and the component that owns the shortcut.

Definition

See Shortcut

562

Page 563: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Assembly [element File]

Description

Specifies if this File is a Win32 Assembly or .NET Assembly that needs to be installed into the Global AssemblyCache.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

.net The file is a .NET Framework assembly.

no The file is not a .NET Framework or Win32 assembly. This is thedefault value.

win32 The file is a Win32 assembly.

Referenced By

● Element File

Remarks

If the value is '.net' or 'win32', this file must also be the key path of the Component.

Definition

See File

563

Page 564: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AssemblyApplication [element File]

Description

Specifies the file identifier of the application file.

Derived By

Type string

Referenced By

● Element File

Remarks

This assembly will be isolated to the same directory as the application file. If this attribute is absent, theassembly will be installed to the Global Assembly Cache. This attribute may only be specified if the Assemblyattribute is set to '.net' or 'win32'.

Definition

See File

564

Page 565: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AssemblyManifest [element File]

Description

Specifies the file identifier of the manifest file that describes this assembly.

Derived By

Type string

Referenced By

● Element File

Remarks

The manifest file should be in the same component as the assembly it describes. This attribute may only bespecified if the Assembly attribute is set to '.net' or 'win32'.

Definition

See File

565

Page 566: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AssignToProperty [element DirectorySearch]

Description

Set the result of this search to the value of the outer Property.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element DirectorySearch

Definition

See DirectorySearch

566

Page 567: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: AssignToProperty [element DirectorySearchRef]

Description

Set the result of this search to the value of the outer Property.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element DirectorySearchRef

Definition

See DirectorySearchRef

567

Page 568: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Attribute [element Subscribe]

Description

if not present can only handle enable, disable, hide, unhide events

Derived By

Type string

Referenced By

● Element Subscribe

Definition

See Subscribe

568

Page 569: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Before [element Custom]

Description

The name of the standard or custom action before which this action should be performed. Mutually exclusivewith OnExit, After, and Sequence attributes

Derived By

Type string

Referenced By

● Element Custom

Definition

See Custom

569

Page 570: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Before [element SetProperty]

Description

The name of the standard or custom action before which this action should be performed.

Derived By

Type string

Referenced By

● Element SetProperty

Remarks

Mutually exclusive with the After attribute. A Before or After attribute is required when setting a Property.

Definition

See SetProperty

570

Page 571: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Before [element Show]

Derived By

Type string

Referenced By

● Element Show

Definition

See Show

571

Page 572: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Before [type ActionModuleSequenceType]

Description

The name of an action that this action should come before.

Derived By

Type string

Referenced By

● Complex Type ActionModuleSequenceType

Definition

See ActionModuleSequenceType

572

Page 573: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: BinaryKey [element CustomAction]

Description

This attribute is a reference to a Binary element with matching Id attribute.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

That binary stream contains the custom action for use during install. The custom action will not be installed intoa target directory. This attribute is typically used with the DllEntry attribute to specify the custom action DLL touse for a type 1 custom action, with the ExeCommand attribute to specify a type 17 custom action that runs anembedded executable, or with the VBScriptCall or JScriptCall attributes to specify a type 5 or 6 custom action.

Definition

See CustomAction

573

Page 574: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: BinarySource [element EmbeddedChainer]

Description

Reference to the Binary element that contains the chainer executeable.

Derived By

Type string

Referenced By

● Element EmbeddedChainer

Remarks

Mutually exclusive with the FileSource and PropertySource attributes.

Definition

See EmbeddedChainer

574

Page 575: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: BindPath [element File]

Description

A list of paths, separated by semicolons, that represent the paths to be searched to find the imported DLLs.

Derived By

Type string

Referenced By

● Element File

Remarks

The list is usually a list of properties, with each property enclosed inside square brackets. The value may be setto an empty string. Including this attribute will cause an entry to be generated for the file in the BindImage table.

Definition

See File

575

Page 576: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Bitmap [element Control]

Description

This attribute is only valid for RadioButton and PushButton Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

576

Page 577: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Bitmap [element RadioButton]

Description

This attribute defines the bitmap displayed with the radio button.

Derived By

Type string

Referenced By

● Element RadioButton

Remarks

The value of the attribute creates a reference to a Binary element that represents the bitmap. This attribute ismutually exclusive with the Icon and Text attributes.

Definition

See RadioButton

577

Page 578: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Blue [element TextStyle]

Description

0 to 255

Derived By

Type integer

Referenced By

● Element TextStyle

Definition

See TextStyle

578

Page 579: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Bold [element TextStyle]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TextStyle

Definition

See TextStyle

579

Page 580: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Cabinet [element Media]

Description

The name of the cabinet if some or all of the files stored on the media are in a cabinet file.

Derived By

Type string

Referenced By

● Element Media

Remarks

If no cabinets are used, this attribute must not be set.

Definition

See Media

580

Page 581: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Cancel [element Control]

Description

Set this attribute to "yes" to cause this Control to be invoked by the escape key.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

581

Page 582: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Category [element Column]

Description

Category of this column.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

Text

UpperCase

LowerCase

Integer

DoubleInteger

TimeDate

Identifier

Property

Filename

WildCardFilename

Path

Paths

AnyPath

DefaultDir

RegPath

Formatted

Template

Condition

Guid

Version

Language

Binary

CustomSource

Cabinet

Shortcut

Referenced By

● Element Column

582

Page 583: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Remarks

This attribute must be specified with a value of 'Binary' if the Type attribute's value is 'binary'.

Definition

See Column

583

Page 584: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CDROM [element Control]

Description

This attribute is only valid for Volume and Directory Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

584

Page 585: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ChangePermission [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

585

Page 586: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CheckBoxValue [element Control]

Description

This attribute is only valid for CheckBox Controls.

Derived By

Type string

Referenced By

● Element Control

Remarks

When set, the linked Property will be set to this value when the check box is checked.

Definition

See Control

586

Page 587: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Checksum [element File]

Description

This attribute should be set to "yes" for every executable file in the installation that has a valid checksum storedin the Portable Executable (PE) file header.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Remarks

Only those files that have this attribute set will be verified for valid checksum during a reinstall.

Definition

See File

587

Page 588: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Class [element MIME]

Description

Class ID for the COM server that is to be associated with the MIME content.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element MIME

Definition

See MIME

588

Page 589: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Classification [element Patch]

Description

Category of updates.

Derived By

Type PatchClassificationType

Enumeration

Value Description

Critical Update A broadly released fix for a specific problem addressing a critical,non-security related bug.

Hotfix Hotfixes address a specific customer situation and generally should notbe distributed outside the customer's organization.

Security Rollup A broadly released fix for a specific security-related relatedvulnerability.

Service Pack A cumulative set of all hotfixes, security rollups, critical updates, andupdates, as well as additional fixes and even new features found sincethe release of the product.

Update A broadly released fix for a specific problem addressing a non-critical,non-security related bug.

Update Rollup A cumulative set of hotfixes, security rollups, critical updates, andupdates packaged together which typically targets a specific area of aproduct.

Referenced By

● Element Patch

Definition

See Patch

589

Page 590: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Classification [element PatchMetadata]

Description

Category of update.

Derived By

Type PatchClassificationType

Enumeration

Value Description

Critical Update A broadly released fix for a specific problem addressing a critical,non-security related bug.

Hotfix Hotfixes address a specific customer situation and generally should notbe distributed outside the customer's organization.

Security Rollup A broadly released fix for a specific security-related relatedvulnerability.

Service Pack A cumulative set of all hotfixes, security rollups, critical updates, andupdates, as well as additional fixes and even new features found sincethe release of the product.

Update A broadly released fix for a specific problem addressing a non-critical,non-security related bug.

Update Rollup A cumulative set of hotfixes, security rollups, critical updates, andupdates packaged together which typically targets a specific area of aproduct.

Referenced By

● Element PatchMetadata

Definition

See PatchMetadata

590

Page 591: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CleanWorkingFolder [element PatchCreation]

Description

Use this to set whether Patchwiz should clean the temp folder when finished.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchCreation

Remarks

See DontRemoveTempFolderWhenFinished for more information.

Definition

See PatchCreation

591

Page 592: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ClientPatchId [element Patch]

Description

An easily referenced identity unique to a patch that can be used in product authoring.

Derived By

Type string

Referenced By

● Element Patch

Remarks

See remarks for more information.

Definition

See Patch

592

Page 593: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Codepage [element Module]

Description

The code page integer value or web name for the resulting MSM.

Derived By

Type string

Referenced By

● Element Module

Remarks

See remarks for more information.

Definition

See Module

593

Page 594: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Codepage [element Patch]

Description

The code page integer value or web name for the resulting MSP.

Derived By

Type string

Referenced By

● Element Patch

Remarks

See remarks for more information.

Definition

See Patch

594

Page 595: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Codepage [element PatchCreation]

Description

The code page integer value or web name for the resulting PCP.

Derived By

Type string

Referenced By

● Element PatchCreation

Remarks

See remarks for more information.

Definition

See PatchCreation

595

Page 596: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Codepage [element Product]

Description

The code page integer value or web name for the resulting MSI. See remarks for more information.

Derived By

Type string

Referenced By

● Element Product

Definition

See Product

596

Page 597: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Column [element Data]

Description

Specifies in which column to insert this data.

Derived By

Type string

Referenced By

● Element Data

Definition

See Data

597

Page 598: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Column [element Substitution]

Description

Specifies the target column in the row named in the Row column.

Derived By

Type string

Referenced By

● Element Substitution

Definition

See Substitution

598

Page 599: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ComboList [element Control]

Description

This attribute is only valid for ComboBox Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

599

Page 600: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Command [element Verb]

Description

The localized text displayed on the context menu.

Derived By

Type string

Referenced By

● Element Verb

Definition

See Verb

600

Page 601: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CommandLine [element EmbeddedChainer]

Description

Value to append to the transaction handle and passed to the chainer executable.

Derived By

Type string

Referenced By

● Element EmbeddedChainer

Definition

See EmbeddedChainer

601

Page 602: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Comments [element Package]

Description

Optional comments for browsing.

Derived By

Type string

Referenced By

● Element Package

Definition

See Package

602

Page 603: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Comments [element PatchInformation]

Description

Optional comments for browsing

Derived By

Type string

Referenced By

● Element PatchInformation

Definition

See PatchInformation

603

Page 604: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CompanionFile [element File]

Description

Set this attribute to make this file a companion child of another file.

Derived By

Type string

Referenced By

● Element File

Remarks

The installation state of a companion file depends not on its own file versioning information, but on theversioning of its companion parent. A file that is the key path for its component can not be a companion file (thatmeans this attribute cannot be set if KeyPath="yes" for this file). The Version attribute cannot be set along withthis attribute since companion files are not installed based on their own version.

Definition

See File

604

Page 605: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Company [element CustomProperty]

Description

The name of the company.

Derived By

Type string

Referenced By

● Element CustomProperty

Definition

See CustomProperty

605

Page 606: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Company [element PatchProperty]

Description

Name of the company for a custom metadata property.

Derived By

Type string

Referenced By

● Element PatchProperty

Definition

See PatchProperty

606

Page 607: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ComplianceCheck [element Property]

Description

Adds a row to the CCPSearch table. This attribute is only valid when this Property contains a search element.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Property

Definition

See Property

607

Page 608: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ComPlusFlags [element Component]

Description

Set this attribute to create a ComPlus entry.

Derived By

Type integer

Referenced By

● Element Component

Remarks

The value should be the export flags used during the generation of the .msi file. For more information see theCOM+ documentation in the Platform SDK.

Definition

See Component

608

Page 609: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ComponentGuidGenerationSeed [element Directory]

Description

The Component Guid Generation Seed is a guid that must be used when a Component with the generate guiddirective ("*") is not rooted in a standard Windows Installer directory (for example, ProgramFilesFolder orCommonFilesFolder, etc).

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Directory

Remarks

It is recommended that this attribute be avoided and that developers install their Components under standarddirectories with unique names instead (for example, "ProgramFilesFolder\Company Name Product NameVersion"). It is important to note that once a directory is assigned a Component Guid Generation Seed the valuemust not change until the directory name changes.

Definition

See Directory

609

Page 610: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Compressed [element File]

Description

Sets the file's source type compression.

Derived By

Type YesNoDefaultType

Enumeration

Value Description

default

no

yes

Referenced By

● Element File

Remarks

A setting of "yes" or "no" will override the setting in the Word Count Summary Property.

Definition

See File

610

Page 611: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Compressed [element Package]

Description

Set to 'yes' to have compressed files in the source.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Package

Remarks

This attribute cannot be set for merge modules.

Definition

See Package

611

Page 612: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Compressed [element PatchInformation]

Description

Compressed files on source

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchInformation

Definition

See PatchInformation

612

Page 613: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CompressionLevel [element Media]

Description

Indicates the compression level for the Media's cabinet.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

high

low

medium

mszip

none

Referenced By

● Element Media

Remarks

This attribute can only be used in conjunction with the Cabinet attribute. The default is 'mszip'.

Definition

See Media

613

Page 614: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ConfigurableDirectory [element Feature]

Description

Specify the Id of a Directory that can be configured by the user at installation time.

Derived By

Type string

Referenced By

● Element Feature

Remarks

This identifier must be a public property and therefore completely uppercase.

Definition

See Feature

614

Page 615: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ContentType [element Extension]

Description

The MIME type that is to be written.

Derived By

Type string

Referenced By

● Element Extension

Definition

See Extension

615

Page 616: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ContentType [element MIME]

Description

This is the identifier for the MIME content.

Derived By

Type string

Referenced By

● Element MIME

Remarks

It is commonly written in the form of type/format.

Definition

See MIME

616

Page 617: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Context [element Class]

Description

The server context(s) for this server.

Derived By

List anySimpleType

Referenced By

● Element Class

Definition

See Class

617

Page 618: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ContextData [element Configuration]

Description

Specifies a semantic context for the requested data.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

618

Page 619: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Control [element Class]

Description

Set this attribute's value to 'yes' to identify an object as an ActiveX Control.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Remarks

The default value is 'no'.

Definition

See Class

619

Page 620: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Control [element Publish]

Description

The parent Control for this Publish element, should only be specified when this element is a child of the UIelement.

Derived By

Type string

Referenced By

● Element Publish

Definition

See Publish

620

Page 621: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Control [element TypeLib]

Description

Value of 'yes' means the type library describes controls, and should not be displayed in type browsers intendedfor nonvisual objects.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TypeLib

Remarks

This attribute can only be set if Advertise='no'.

Definition

See TypeLib

621

Page 622: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Cost [element TypeLib]

Description

The cost associated with the registration of the type library in bytes.

Derived By

Type int

Referenced By

● Element TypeLib

Remarks

This attribute cannot be set if Advertise='no'.

Definition

See TypeLib

622

Page 623: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CreateChild [element Permission]

Description

For a directory, the right to create a subdirectory.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Remarks

Only valid under a 'CreateFolder' parent.

Definition

See Permission

623

Page 624: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CreateFile [element Permission]

Description

For a directory, the right to create a file in the directory.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Remarks

Only valid under a 'CreateFolder' parent.

Definition

See Permission

624

Page 625: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CreateLink [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

625

Page 626: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CreateSubkeys [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

626

Page 627: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CreationTimeUTC [element PatchMetadata]

Description

Creation time of the .msp file in the form mm-dd-yy HH:MM (month-day-year hour:minute).

Derived By

Type string

Referenced By

● Element PatchMetadata

Definition

See PatchMetadata

627

Page 628: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: CustomPalette [element Dialog]

Description

Used to specify if pictures in the dialog box are rendered with a custom palette.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

628

Page 629: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Default [element Control]

Description

Set this attribute to "yes" to cause this Control to be invoked by the return key.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

629

Page 630: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Default [element MIME]

Description

If 'yes', become the content type for the parent Extension.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element MIME

Remarks

The default value is 'no'.

Definition

See MIME

630

Page 631: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DefaultLanguage [element File]

Description

This is the default language of this file.

Derived By

Type string

Referenced By

● Element File

Remarks

The linker will replace this value from the value in the file if the suppress files option is not used.

Definition

See File

631

Page 632: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DefaultSize [element File]

Description

This is the default size of this file.

Derived By

Type integer

Referenced By

● Element File

Remarks

The linker will replace this value from the value in the file if the suppress files option is not used.

Definition

See File

632

Page 633: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DefaultValue [element Configuration]

Description

Specifies a default value for the item in this record if the merge tool declines to provide a value.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

633

Page 634: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DefaultVersion [element File]

Description

This is the default version of this file.

Derived By

Type string

Referenced By

● Element File

Remarks

The linker will replace this value from the value in the file if the suppress files option is not used.

Definition

See File

634

Page 635: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Delete [element CopyFile]

Description

This attribute cannot be specified if the element is nested under a File element or the FileId attribute isspecified.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CopyFile

Remarks

In other cases, if the attribute is not specified, the default value is "no" and the file is copied, not moved. Set thevalue to "yes" in order to move the file (thus deleting the source file) instead of copying it.

Definition

See CopyFile

635

Page 636: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Delete [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

636

Page 637: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DeleteChild [element Permission]

Description

For a directory, the right to delete a directory and all the files it contains, including read-only files.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Remarks

Only valid under a 'CreateFolder' parent.

Definition

See Permission

637

Page 638: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Dependency [element SFPCatalog]

Description

Used to define dependency outside of the package.

Derived By

Type string

Referenced By

● Element SFPCatalog

Definition

See SFPCatalog

638

Page 639: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Depth [element DirectorySearch]

Description

Depth below the path that the installer searches for the file or directory specified by the search.

Derived By

Type integer

Referenced By

● Element DirectorySearch

Remarks

If this value is not specified, the depth is assumed to be 0.

Definition

See DirectorySearch

639

Page 640: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element AppId]

Description

Set this value to the description of the AppId.

Derived By

Type string

Referenced By

● Element AppId

Remarks

It can only be specified when the AppId is not being advertised.

Definition

See AppId

640

Page 641: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Class]

Description

Localized description associated with the Class ID and Program ID.

Derived By

Type string

Referenced By

● Element Class

Definition

See Class

641

Page 642: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Column]

Description

Description of this column.

Derived By

Type string

Referenced By

● Element Column

Definition

See Column

642

Page 643: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Configuration]

Description

Description for authoring.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

643

Page 644: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Feature]

Description

Longer string of text describing the feature.

Derived By

Type string

Referenced By

● Element Feature

Remarks

This localizable string is displayed by the Text Control of the Selection Dialog.

Definition

See Feature

644

Page 645: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Package]

Description

The product full name or description.

Derived By

Type string

Referenced By

● Element Package

Definition

See Package

645

Page 646: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Patch]

Description

Description of the patch.

Derived By

Type string

Referenced By

● Element Patch

Definition

See Patch

646

Page 647: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element PatchInformation]

Description

Product full name or description

Derived By

Type string

Referenced By

● Element PatchInformation

Definition

See PatchInformation

647

Page 648: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element PatchMetadata]

Description

Description of the patch.

Derived By

Type string

Referenced By

● Element PatchMetadata

Definition

See PatchMetadata

648

Page 649: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element ProgId]

Derived By

Type string

Referenced By

● Element ProgId

Definition

See ProgId

649

Page 650: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element ServiceInstall]

Description

Sets the description of the service.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

650

Page 651: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element Shortcut]

Description

The localizable description for the shortcut.

Derived By

Type string

Referenced By

● Element Shortcut

Definition

See Shortcut

651

Page 652: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Description [element TypeLib]

Description

The localizable description of the type library.

Derived By

Type string

Referenced By

● Element TypeLib

Definition

See TypeLib

652

Page 653: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DescriptionResourceDll [element Shortcut]

Description

The Formatted string providing the full path to the language neutral file containing the MUI Manifest.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

Generally authored using [#filekey] form. When this attribute is specified, the DescriptionResourceId attributemust also be provided.

This attribute is only used on Windows Vista and above. If this attribute is not specified and the install is runningon Vista and above, the value in the Name attribute is used. If this attribute is provided and the install is runningon Vista and above, the value in the Name attribute is ignored.

Definition

See Shortcut

653

Page 654: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DescriptionResourceId [element Shortcut]

Description

The description name index for the shortcut.

Derived By

Type integer

Referenced By

● Element Shortcut

Remarks

This must be a non-negative number. When this attribute is specified, the DescriptionResourceDll attribute mustalso be populated.

This attribute is only used on Windows Vista and above. If this attribute is not specified and the install is runningon Vista and above, the value in the Name attribute is used. If this attribute is populated and the install isrunning on Vista and above, the value in the Name attribute is ignored.

Definition

See Shortcut

654

Page 655: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DestinationDirectory [element CopyFile]

Description

Set this value to the destination directory where an existing file on the target machine should be moved orcopied to.

Derived By

Type string

Referenced By

● Element CopyFile

Remarks

This Directory must exist in the installer database at creation time. This attribute cannot be specified inconjunction with DestinationProperty.

Definition

See CopyFile

655

Page 656: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DestinationLongName [element CopyFile]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element CopyFile

Definition

See CopyFile

656

Page 657: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DestinationName [element CopyFile]

Description

In prior versions of the WiX toolset, this attribute specified the short file name.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element CopyFile

Remarks

Now set this value to the localizable name to be given to the original file after it is moved or copied. If thisattribute is not specified, then the destination file is given the same name as the source file. If a short file nameis specified, the DestinationShortName attribute may not be specified. If a long file name is specified, theDestinationLongName attribute may not be specified. Also, if this value is a long file name, theDestinationShortName attribute may be omitted to allow WiX to attempt to generate a unique short file name.However, if this name collides with another file or you wish to manually specify the short file name, then theDestinationShortName attribute may be specified.

Definition

See CopyFile

657

Page 658: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DestinationProperty [element CopyFile]

Description

Set this value to a property that will have a value that resolves to the full path of the destination directory.

Derived By

Type string

Referenced By

● Element CopyFile

Remarks

The property does not have to exist in the installer database at creation time; it could be created at installationtime by a custom action, on the command line, etc. This attribute cannot be specified in conjunction withDestinationDirectory.

Definition

See CopyFile

658

Page 659: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DestinationShortName [element CopyFile]

Description

The short file name of the file in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element CopyFile

Remarks

This attribute should only be set if there is a conflict between generated short file names or you wish tomanually specify the short file name.

Definition

See CopyFile

659

Page 660: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Dialog [element Publish]

Description

The parent Dialog for this Publish element, should only be specified when this element is a child of the UIelement.

Derived By

Type string

Referenced By

● Element Publish

Remarks

This attribute will create a reference to the specified Dialog, so an additional DialogRef is not necessary.

Definition

See Publish

660

Page 661: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Dialog [element Show]

Derived By

Type string

Referenced By

● Element Show

Definition

See Show

661

Page 662: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element Component]

Description

Sets the Directory of the Component.

Derived By

Type string

Referenced By

● Element Component

Remarks

If this element is nested under a Directory element, this value defaults to the value of the parent Directory/@Id.

Definition

See Component

662

Page 663: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element CreateFolder]

Description

Identifier of Directory to create.

Derived By

Type string

Referenced By

● Element CreateFolder

Remarks

Defaults to Directory of parent Component.

Definition

See CreateFolder

663

Page 664: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element CustomAction]

Description

This attribute specifies a reference to a Directory element with matching Id attribute containing a directory path.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

This attribute is typically used with the ExeCommand attribute to specify the source executable for a type 34custom action, or with the Value attribute to specify a formatted string to place in the specified Directory tableentry in a type 35 custom action.

Definition

See CustomAction

664

Page 665: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element IniFile]

Description

Name of a property, the value of which is the full path of the folder containing the .ini file.

Derived By

Type string

Referenced By

● Element IniFile

Remarks

Can be name of a directory in the Directory table, a property set by the AppSearch table, or any other propertyrepresenting a full path.

Definition

See IniFile

665

Page 666: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element RemoveFile]

Description

Overrides the directory of the parent component with a specific Directory.

Derived By

Type string

Referenced By

● Element RemoveFile

Remarks

This Directory must exist in the installer database at creation time. This attribute cannot be specified inconjunction with the Property attribute.

Definition

See RemoveFile

666

Page 667: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element RemoveFolder]

Description

Overrides the directory of the parent component with a specific Directory.

Derived By

Type string

Referenced By

● Element RemoveFolder

Remarks

This Directory must exist in the installer database at creation time. This attribute cannot be specified inconjunction with the Property attribute.

Definition

See RemoveFolder

667

Page 668: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element ReserveCost]

Description

Adds the amount of disk space specified in RunFromSource or RunLocal to the volume cost of the devicecontaining the directory.

Derived By

Type string

Referenced By

● Element ReserveCost

Remarks

If this attribute is not set, it will default to the directory of parent component.

Definition

See ReserveCost

668

Page 669: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Directory [element Shortcut]

Description

Identifier reference to Directory element where shortcut is to be created.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

When nested under a Component element, this attribute's value will default to the parent directory. Otherwise,this attribute is required.

Definition

See Shortcut

669

Page 670: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Disabled [element Control]

Description

Set this attribute to "yes" to cause the Control to be disabled.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

670

Page 671: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisableRegistryReflection [element Component]

Description

Set this attribute to 'yes' in order to disable registry reflection on all existing and new registry keys affected bythis component.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

When set to 'yes', the Windows Installer calls the RegDisableReflectionKey on each key being accessed by thecomponent. This bit is available with Windows Installer version 4.0 and is ignored on 32-bit systems.

Definition

See Component

671

Page 672: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskId [element Component]

Description

This attribute must be set either on a Component element or all of its children File elements.

Derived By

Type integer

Referenced By

● Element Component

Remarks

The value of this attribute should correspond to the Id attribute of a Media element authored elsewhere. Bycreating this connection between a component (or particular files), you set the packaging options to the valuesspecified in the Media element (values such as compression level, cab embedding, etc...).

Definition

See Component

672

Page 673: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskId [element Directory]

Description

Sets the default disk identifier for the files contained in this directory.

Derived By

Type integer

Referenced By

● Element Directory

Remarks

This attribute must be set on a Component, Directory, or DirectoryRef element or all of its children Fileelements, else the default disk identifier of 1 is assumed. The value of this attribute should correspond to the Idattribute of a Media element authored elsewhere. By creating this connection between a component (orparticular files), you set the packaging options to the values specified in the Media element (values such ascompression level, cab embedding, etc...).

Definition

See Directory

673

Page 674: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskId [element DirectoryRef]

Description

Sets the default disk identifier for the files contained in this directory.

Derived By

Type integer

Referenced By

● Element DirectoryRef

Remarks

This attribute must be set on a Component, Directory, or DirectoryRef element or all of its children Fileelements, else the default disk identifier of 1 is assumed. The value of this attribute should correspond to the Idattribute of a Media element authored elsewhere. By creating this connection between a component (orparticular files), you set the packaging options to the values specified in the Media element (values such ascompression level, cab embedding, etc...).

Definition

See DirectoryRef

674

Page 675: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskId [element Family]

Description

Entered into the DiskId field of the new Media table record.

Derived By

Type int

Referenced By

● Element Family

Definition

See Family

675

Page 676: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskId [element File]

Description

Specifies the Media this File should be sourced on.

Derived By

Type integer

Referenced By

● Element File

Remarks

This attribute overrides the default DiskId attribute from the parent Component element. If no DiskId attribute isspecifed, the default is "1".

Definition

See File

676

Page 677: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskId [element Merge]

Description

The value of this attribute should correspond to the Id attribute of a Media element authored elsewhere.

Derived By

Type string

Referenced By

● Element Merge

Remarks

By creating this connection between the Merge Module and Media element, you set the packaging options tothe values specified in the Media element (values such as compression level, cab embedding, etc...).

Definition

See Merge

677

Page 678: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskPrompt [element Family]

Description

Value to display in the "[1]" of the DiskPrompt Property.

Derived By

Type string

Referenced By

● Element Family

Remarks

Using this attribute will require you to define a DiskPrompt Property.

Definition

See Family

678

Page 679: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DiskPrompt [element Media]

Description

The disk name, which is usually the visible text printed on the disk.

Derived By

Type string

Referenced By

● Element Media

Remarks

This localizable text is used to prompt the user when this disk needs to be inserted. This value will be used inthe "[1]" of the DiskPrompt Property. Using this attribute will require you to define a DiskPrompt Property.

Definition

See Media

679

Page 680: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Display [element Feature]

Description

Determines the initial display of this feature in the feature tree.

Derived By

Type string

Referenced By

● Element Feature

Remarks

This attribute's value should be one of the following:

collapse - Initially shows the feature collapsed. This is the default value.expand - Initially shows the feature expanded.hidden - Prevents the feature from displaying in the user interface.<an explicit integer value> - For advanced users only, it is possible to directly set the integer value of thedisplay value that will appear in the Feature row.

Definition

See Feature

680

Page 681: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisplayName [element Configuration]

Description

Display name for authoring.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

681

Page 682: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisplayName [element Patch]

Description

A title for the patch that is suitable for public display.

Derived By

Type string

Referenced By

● Element Patch

Remarks

In Add/Remove Programs from XP SP2 on.

Definition

See Patch

682

Page 683: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisplayName [element PatchMetadata]

Description

A title for the patch that is suitable for public display.

Derived By

Type string

Referenced By

● Element PatchMetadata

Remarks

In Add/Remove Programs from XP SP2 on.

Definition

See PatchMetadata

683

Page 684: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisplayName [element ServiceInstall]

Description

This column is the localizable string that user interface programs use to identify the service.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

684

Page 685: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisplayResourceDll [element Shortcut]

Description

The Formatted string providing the full path to the language neutral file containing the MUI Manifest.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

Generally authored using [#filekey] form. When this attribute is specified, the DisplayResourceId attribute mustalso be provided.

This attribute is only used on Windows Vista and above. If this attribute is not populated and the install isrunning on Vista and above, the value in the Name attribute is used. If this attribute is populated and the installis running on Vista and above, the value in the Name attribute is ignored.

Definition

See Shortcut

685

Page 686: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DisplayResourceId [element Shortcut]

Description

The display name index for the shortcut.

Derived By

Type integer

Referenced By

● Element Shortcut

Remarks

This must be a non-negative number. When this attribute is specified, the DisplayResourceDll attribute mustalso be proviced.

This attribute is only used on Windows Vista and above. If this attribute is not specified and the install is runningon Vista and above, the value in the Name attribute is used. If this attribute is specified and the install is runningon Vista and above, the value in the Name attribute is ignored.

Definition

See Shortcut

686

Page 687: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DllEntry [element CustomAction]

Description

This attribute specifies the name of a function in a custom action to execute.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

This attribute is used with the BinaryKey attribute to create a type 1 custom action, or with the FileKey attributeto create a type 17 custom action.

Definition

See CustomAction

687

Page 688: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DllSurrogate [element AppId]

Description

Set this value to specify that the class is a DLL that is to be activated in a surrogate EXE process, and thesurrogate process to be used is the path of a surrogate EXE file specified by the value.

Derived By

Type string

Referenced By

● Element AppId

Definition

See AppId

688

Page 689: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Domain [element Permission]

Derived By

Type string

Referenced By

● Element Permission

Definition

See Permission

689

Page 690: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: DriverName [element ODBCDataSource]

Description

Required if not found as child of ODBCDriver element

Derived By

Type string

Referenced By

● Element ODBCDataSource

Definition

See ODBCDataSource

690

Page 691: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ElevationShield [element Control]

Description

This attribute is only valid for PushButton controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Remarks

Set this attribute to "yes" to add the User Account Control (UAC) elevation icon (shield icon) to the PushButtoncontrol. If this attribute's value is "yes" and the installation is not yet running with elevated privileges, thepushbutton control is created using the User Account Control (UAC) elevation icon (shield icon). If thisattribute's value is "yes" and the installation is already running with elevated privileges, the pushbutton control iscreated using the other icon attributes. Otherwise, the pushbutton control is created using the other iconattributes.

Definition

See Control

691

Page 692: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: EmbedCab [element Media]

Description

Instructs the binder to embed the cabinet in the product if 'yes'.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Media

Remarks

This attribute can only be specified in conjunction with the Cabinet attribute.

Definition

See Media

692

Page 693: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: EnumerateSubkeys [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

693

Page 694: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: EraseDescription [element ServiceInstall]

Description

Determines whether the existing service description will be ignored.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ServiceInstall

Remarks

If 'yes', the service description will be null, even if the Description attribute is set.

Definition

See ServiceInstall

694

Page 695: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Error [element CustomAction]

Description

This attribute specifies an index in the MSI Error table to use as an error message for a type 19 custom actionthat displays the error message and aborts a product's installation.

Derived By

Type string

Referenced By

● Element CustomAction

Definition

See CustomAction

695

Page 696: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ErrorControl [element ServiceInstall]

Description

Determines what action should be taken on an error.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

ignore Logs the error and continues with the startup operation.

normal Logs the error, displays a message box and continues the startupoperation.

critical Logs the error if it is possible and the system is restarted with the lastconfiguration known to be good. If the last-known-good configuration isbeing started, the startup operation fails.

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

696

Page 697: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ErrorDialog [element Dialog]

Description

Specifies this dialog as an error dialog.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

697

Page 698: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Event [element Publish]

Description

Set this attribute's value to one of the standard control events to trigger that event.

Derived By

Type string

Referenced By

● Element Publish

Remarks

Either this attribute or the Property attribute must be set, but not both at the same time.

Definition

See Publish

698

Page 699: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Event [element Subscribe]

Description

must be one of the standard control events'

Derived By

Type string

Referenced By

● Element Subscribe

Definition

See Subscribe

699

Page 700: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExcludedId [element Exclusion]

Description

Identifier of the merge module that is incompatible.

Derived By

Type string

Referenced By

● Element Exclusion

Definition

See Exclusion

700

Page 701: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExcludedMaxVersion [element Exclusion]

Description

Maximum version excluded from a range.

Derived By

Type string

Referenced By

● Element Exclusion

Remarks

If not set, all versions after min are excluded. If neither max nor min, no exclusion based on version.

Definition

See Exclusion

701

Page 702: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExcludedMinVersion [element Exclusion]

Description

Minimum version excluded from a range.

Derived By

Type string

Referenced By

● Element Exclusion

Remarks

If not set, all versions before max are excluded. If neither max nor min, no exclusion based on version.

Definition

See Exclusion

702

Page 703: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExcludeExceptLanguage [element Exclusion]

Description

Numeric language ID of the merge module in ExcludedID.

Derived By

Type integer

Referenced By

● Element Exclusion

Remarks

All except this language will be excluded. Only one of ExcludeExceptLanguage and ExcludeLanguage may bespecified.

Definition

See Exclusion

703

Page 704: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExcludeLanguage [element Exclusion]

Description

Numeric language ID of the merge module in ExcludedID.

Derived By

Type integer

Referenced By

● Element Exclusion

Remarks

The specified language will be excluded. Only one of ExcludeExceptLanguage and ExcludeLanguage may bespecified.

Definition

See Exclusion

704

Page 705: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExcludeLanguages [element UpgradeVersion]

Description

Set to "yes" to detect all languages, excluding the languages listed in the Language attribute.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

705

Page 706: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ExeCommand [element CustomAction]

Description

This attribute specifies the command line parameters to supply to an externally run executable.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for atype 18 custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34custom action that specify the executable to run.

Definition

See CustomAction

706

Page 707: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Execute [element CustomAction]

Description

This attribute indicates the scheduling of the custom action.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

commit Indicates that the custom action will run after successful completion ofthe installation script (at the end of the installation).

deferred Indicates that the custom action runs in-script (possibly with elevatedprivileges).

firstSequence Indicates that the custom action will only run in the first sequence thatruns it.

immediate Indicates that the custom action will run during normal processing timewith user privileges. This is the default.

oncePerProcess Indicates that the custom action will only run in the first sequence thatruns it in the same process.

rollback Indicates that a custom action will run in the rollback sequence when afailureoccurs during installation, usually to undo changes made by a deferredcustom action.

secondSequence Indicates that a custom action should be run a second time if it waspreviously run in an earlier sequence.

Referenced By

● Element CustomAction

Definition

See CustomAction

707

Page 708: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Execute [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

708

Page 709: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FaceName [element TextStyle]

Derived By

Type string

Referenced By

● Element TextStyle

Definition

See TextStyle

709

Page 710: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Feature [element Billboard]

Description

Feature whose state determines if the Billboard is shown.

Derived By

Type string

Referenced By

● Element Billboard

Definition

See Billboard

710

Page 711: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Feature [element Category]

Description

Feature that controls the advertisement of the category.

Derived By

Type string

Referenced By

● Element Category

Remarks

Defaults to the primary Feature for the parent Component.

Definition

See Category

711

Page 712: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Feature [element Component]

Description

Identifies a feature to which this component belongs, as a shorthand for a child ComponentRef element of theFeature element.

Derived By

Type string

Referenced By

● Element Component

Remarks

The value of this attribute should correspond to the Id attribute of a Feature element authored elsewhere. Notethat a single component can belong to multiple features but this attribute allows you to specify only a singlefeature.

Definition

See Component

712

Page 713: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Field [element IniFileSearch]

Description

The field in the .ini line. If field is Null or 0, the entire line is read.

Derived By

Type integer

Referenced By

● Element IniFileSearch

Definition

See IniFileSearch

713

Page 714: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: File [element ExternalFile]

Description

Foreign key into the File table.

Derived By

Type string

Referenced By

● Element ExternalFile

Definition

See ExternalFile

714

Page 715: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: File [element ODBCDriver]

Description

Required if not found as child of File element

Derived By

Type string

Referenced By

● Element ODBCDriver

Definition

See ODBCDriver

715

Page 716: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: File [element ODBCTranslator]

Description

Required if not found as child of File element

Derived By

Type string

Referenced By

● Element ODBCTranslator

Definition

See ODBCTranslator

716

Page 717: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: File [element ProtectFile]

Description

Foreign key into the File table.

Derived By

Type string

Referenced By

● Element ProtectFile

Definition

See ProtectFile

717

Page 718: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: File [element UpgradeFile]

Description

Foreign key into the File table.

Derived By

Type string

Referenced By

● Element UpgradeFile

Definition

See UpgradeFile

718

Page 719: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FileCompression [element Merge]

Description

Specifies if the files in the merge module should be compressed.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Merge

Definition

See Merge

719

Page 720: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FileId [element CopyFile]

Description

This attribute cannot be specified if the element is nested under a File element.

Derived By

Type string

Referenced By

● Element CopyFile

Remarks

Set this attribute's value to the identifier of a file from a different component to copy it based on the install stateof the parent component.

Definition

See CopyFile

720

Page 721: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FileKey [element CustomAction]

Description

This attribute specifies a reference to a File element with matching Id attribute that will execute the customaction code in the file after the file is installed.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

This attribute is typically used with the ExeCommand attribute to specify a type 18 custom action that runs aninstalled executable, with the DllEntry attribute to specify an installed custom action DLL to use for a type 17custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action.

Definition

See CustomAction

721

Page 722: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FileSource [element Directory]

Description

Used to set the file system source for this directory's child elements.

Derived By

Type string

Referenced By

● Element Directory

Definition

See Directory

722

Page 723: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FileSource [element DirectoryRef]

Description

Used to set the file system source for this directory ref's child elements.

Derived By

Type string

Referenced By

● Element DirectoryRef

Definition

See DirectoryRef

723

Page 724: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FileSource [element EmbeddedChainer]

Description

Reference to the File element that is the chainer executeable.

Derived By

Type string

Referenced By

● Element EmbeddedChainer

Remarks

Mutually exclusive with the BinarySource and PropertySource attributes.

Definition

See EmbeddedChainer

724

Page 725: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Fixed [element Control]

Description

This attribute is only valid for Volume and Directory Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

725

Page 726: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FixedSize [element Control]

Description

This attribute is only valid for RadioButton, PushButton, and Icon Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

726

Page 727: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Floppy [element Control]

Description

This attribute is only valid for Volume and Directory Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

727

Page 728: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FontTitle [element File]

Description

Causes an entry to be generated for the file in the Font table with the specified FontTitle.

Derived By

Type string

Referenced By

● Element File

Remarks

This attribute is intended to be used to register the file as a non-TrueType font.

Definition

See File

728

Page 729: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Format [element Configuration]

Description

Specifies the format of the data being changed.

Derived By

Restricting string

Enumeration

Value Description

Text

Key

Integer

Bitfield

Referenced By

● Element Configuration

Definition

See Configuration

729

Page 730: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: FormatSize [element Control]

Description

This attribute is only valid for Text Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

730

Page 731: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: GenericAll [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

731

Page 732: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: GenericExecute [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

732

Page 733: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: GenericRead [element Permission]

Description

specifying this will fail to grant read access

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

733

Page 734: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: GenericWrite [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

734

Page 735: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Green [element TextStyle]

Description

0 to 255

Derived By

Type integer

Referenced By

● Element TextStyle

Definition

See TextStyle

735

Page 736: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Group [element ServiceDependency]

Description

Set to 'yes' to indicate that the value in the Id attribute is the name of a group of services.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ServiceDependency

Definition

See ServiceDependency

736

Page 737: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Guid [element Component]

Description

This value should be a guid that uniquely identifies this component's contents, language, platform, and version.

Derived By

Type ComponentGuid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Component

Remarks

It's also possible to set the value to an empty string to specify an unmanaged component. Unmanagedcomponents are a security vulnerability because the component cannot be removed or repaired by WindowsInstaller (it is essentially an unpatchable, permanent component). Therefore, a guid should always be specifiedfor any component which contains resources that may need to be patched in the future.

Definition

See Component

737

Page 738: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Guid [element ComponentSearch]

Description

The component ID of the component whose key path is to be used for the search.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element ComponentSearch

Definition

See ComponentSearch

738

Page 739: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Guid [element Module]

Description

This attribute is deprecated. Use the Package/@Id instead.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Module

Definition

See Module

739

Page 740: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Handler [element Class]

Description

The default inproc handler.

Derived By

Type string

Referenced By

● Element Class

Remarks

May be optionally provided only for Context = LocalServer or LocalServer32. Value of "1" creates a 16-bitInprocHandler (appearing as the InprocHandler value). Value of "2" creates a 32-bit InprocHandler (appearingas the InprocHandler32 value). Value of "3" creates 16-bit as well as 32-bit InprocHandlers. A non-numericvalue is treated as a system file that serves as the 32-bit InprocHandler (appearing as the InprocHandler32value).

Definition

See Class

740

Page 741: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: HasBorder [element Control]

Description

This attribute is only valid for RadioButton Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

741

Page 742: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: HasDiskImage [element TypeLib]

Description

Value of 'yes' means the type library exists in a persisted form on disk.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TypeLib

Remarks

This attribute can only be set if Advertise='no'.

Definition

See TypeLib

742

Page 743: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Height [element Control]

Description

Height of the rectangular boundary of the control.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Control

Remarks

This must be a non-negative number.

Definition

See Control

743

Page 744: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Height [element Dialog]

Description

The height of the dialog box in dialog units.

Derived By

Type integer

Referenced By

● Element Dialog

Definition

See Dialog

744

Page 745: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Height [element RadioButton]

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element RadioButton

Definition

See RadioButton

745

Page 746: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Help [element Control]

Description

This attribute is reserved for future use.

Derived By

Type string

Referenced By

● Element Control

Remarks

There is no need to use this until Windows Installer uses it for something.

Definition

See Control

746

Page 747: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Help [element RadioButton]

Derived By

Type string

Referenced By

● Element RadioButton

Definition

See RadioButton

747

Page 748: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: HelpDirectory [element TypeLib]

Description

The identifier of the Directory element for the help directory.

Derived By

Type string

Referenced By

● Element TypeLib

Definition

See TypeLib

748

Page 749: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: HelpKeyword [element Configuration]

Description

Keyword into chm file for authoring.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

749

Page 750: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: HelpLocation [element Configuration]

Description

Location of chm file for authoring.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

750

Page 751: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Hidden [element Control]

Description

Set this attribute to "yes" to cause the Control to be hidden.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

751

Page 752: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Hidden [element Dialog]

Description

Used to hide the dialog.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

752

Page 753: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Hidden [element File]

Description

Set to yes in order to have the file's hidden attribute set when it is installed on the target machine.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

753

Page 754: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Hidden [element Property]

Description

Denotes that the Property is not logged during installation.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Property

Remarks

See the MsiHiddenProperties Property for more information.

Definition

See Property

754

Page 755: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Hidden [element TypeLib]

Description

Value of 'yes' means the type library should not be displayed to users, although its use is not restricted.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TypeLib

Remarks

Should be used by controls. Hosts should create a new type library that wraps the control with extendedproperties. This attribute can only be set if Advertise='no'.

Definition

See TypeLib

755

Page 756: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: HideTarget [element CustomAction]

Description

Ensures the installer does not log the CustomActionData for the deferred custom action.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CustomAction

Definition

See CustomAction

756

Page 757: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Hotkey [element Shortcut]

Description

The hotkey for the shortcut.

Derived By

Type integer

Referenced By

● Element Shortcut

Remarks

The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags.This must be a non-negative number. Authors of installation packages are generally recommend not to set thisoption, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeysto shortcuts can be problematic for users using hotkeys for accessibility.

Definition

See Shortcut

757

Page 758: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Icon [element Class]

Description

The file providing the icon associated with this CLSID.

Derived By

Type string

Referenced By

● Element Class

Remarks

Reference to an Icon element (should match the Id attribute of an Icon element). This is currently not supportedif the value of the Advertise attribute is "no".

Definition

See Class

758

Page 759: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Icon [element Control]

Description

This attribute is only valid for RadioButton and PushButton Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

759

Page 760: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Icon [element ListItem]

Description

The identifier of the Binary (not Icon) element containing the icon to associate with this item.

Derived By

Type string

Referenced By

● Element ListItem

Remarks

This value is only valid when nested under a ListView element.

Definition

See ListItem

760

Page 761: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Icon [element ProgId]

Description

For an advertised ProgId, the Id of an Icon element.

Derived By

Type string

Referenced By

● Element ProgId

Remarks

For a non-advertised ProgId, this is the Id of a file containing an icon resource.

Definition

See ProgId

761

Page 762: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Icon [element RadioButton]

Description

This attribute defines the icon displayed with the radio button.

Derived By

Type string

Referenced By

● Element RadioButton

Remarks

The value of the attribute creates a reference to a Binary element that represents the icon. This attribute ismutually exclusive with the Bitmap and Text attributes.

Definition

See RadioButton

762

Page 763: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Icon [element Shortcut]

Description

Identifier reference to Icon element.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

The Icon identifier should have the same extension as the file that it points at. For example, a shortcut to anexecutable (e.g. "my.exe") should reference an Icon with identifier like "MyIcon.exe"

Definition

See Shortcut

763

Page 764: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IconIndex [element Class]

Description

Icon index into the icon file.

Derived By

Type integer

Referenced By

● Element Class

Definition

See Class

764

Page 765: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IconIndex [element ProgId]

Derived By

Type integer

Referenced By

● Element ProgId

Definition

See ProgId

765

Page 766: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IconIndex [element Shortcut]

Description

Identifier reference to Icon element.

Derived By

Type integer

Referenced By

● Element Shortcut

Definition

See Shortcut

766

Page 767: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IconSize [element Control]

Description

This attribute is only valid for RadioButton, PushButton, and Icon Controls.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

16

32

48

Referenced By

● Element Control

Definition

See Control

767

Page 768: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element AppId]

Description

Set this value to the AppID GUID that corresponds to the named executable.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element AppId

Definition

See AppId

768

Page 769: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element AssemblyName]

Description

Name of the attribute associated with the value specified in the Value column.

Derived By

Type string

Referenced By

● Element AssemblyName

Definition

See AssemblyName

769

Page 770: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Billboard]

Description

Unique identifier for the Billboard.

Derived By

Type string

Referenced By

● Element Billboard

Definition

See Billboard

770

Page 771: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element BillboardAction]

Description

Action name that determines when the Billboard should be shown.

Derived By

Type string

Referenced By

● Element BillboardAction

Definition

See BillboardAction

771

Page 772: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Binary]

Description

The Id cannot by longer than 55 characters.

Derived By

Type string

Referenced By

● Element Binary

Remarks

In order to prevent errors in cases where the Id is modularized, it should not be longer than 18 characters.

Definition

See Binary

772

Page 773: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element BinaryRef]

Description

The identifier of the Binary element to reference.

Derived By

Type string

Referenced By

● Element BinaryRef

Definition

See BinaryRef

773

Page 774: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Category]

Description

A string GUID that represents the category of components being grouped together.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Category

Definition

See Category

774

Page 775: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Class]

Description

The Class identifier (CLSID) of a COM server.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Class

Definition

See Class

775

Page 776: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Column]

Description

Identifier for the column.

Derived By

Type string

Referenced By

● Element Column

Definition

See Column

776

Page 777: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Component]

Description

Component identifier; this is the primary key for identifying components.

Derived By

Type string

Referenced By

● Element Component

Definition

See Component

777

Page 778: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ComponentGroup]

Description

Identifier for the ComponentGroup.

Derived By

Type string

Referenced By

● Element ComponentGroup

Definition

See ComponentGroup

778

Page 779: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ComponentGroupRef]

Description

The identifier of the ComponentGroup to reference.

Derived By

Type string

Referenced By

● Element ComponentGroupRef

Definition

See ComponentGroupRef

779

Page 780: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ComponentRef]

Description

The identifier of the Component element to reference.

Derived By

Type string

Referenced By

● Element ComponentRef

Definition

See ComponentRef

780

Page 781: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ComponentSearch]

Derived By

Type string

Referenced By

● Element ComponentSearch

Definition

See ComponentSearch

781

Page 782: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Control]

Description

Combined with the Dialog Id to make up the primary key of the Control table.

Derived By

Type string

Referenced By

● Element Control

Definition

See Control

782

Page 783: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element CopyFile]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element CopyFile

Definition

See CopyFile

783

Page 784: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element CustomAction]

Description

The identifier of the custom action.

Derived By

Type string

Referenced By

● Element CustomAction

Definition

See CustomAction

784

Page 785: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element CustomActionRef]

Description

The identifier of the CustomAction to reference.

Derived By

Type string

Referenced By

● Element CustomActionRef

Definition

See CustomActionRef

785

Page 786: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element CustomTable]

Description

Identifier for the custom table.

Derived By

Type string

Referenced By

● Element CustomTable

Definition

See CustomTable

786

Page 787: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Dialog]

Description

Unique identifier for the dialog.

Derived By

Type string

Referenced By

● Element Dialog

Definition

See Dialog

787

Page 788: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element DialogRef]

Description

The identifier of the Dialog to reference.

Derived By

Type string

Referenced By

● Element DialogRef

Definition

See DialogRef

788

Page 789: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element DigitalCertificate]

Description

Identifier for a certificate file.

Derived By

Type string

Referenced By

● Element DigitalCertificate

Definition

See DigitalCertificate

789

Page 790: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Directory]

Description

This value is the unique identifier of the directory entry.

Derived By

Type string

Referenced By

● Element Directory

Definition

See Directory

790

Page 791: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element DirectoryRef]

Description

The identifier of the Directory element to reference.

Derived By

Type string

Referenced By

● Element DirectoryRef

Definition

See DirectoryRef

791

Page 792: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element DirectorySearch]

Description

Unique identifier for the directory search.

Derived By

Type string

Referenced By

● Element DirectorySearch

Definition

See DirectorySearch

792

Page 793: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element DirectorySearchRef]

Description

Id of the search being referred to.

Derived By

Type string

Referenced By

● Element DirectorySearchRef

Definition

See DirectorySearchRef

793

Page 794: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element EmbeddedChainer]

Description

Unique identifier for embedded chainer.

Derived By

Type string

Referenced By

● Element EmbeddedChainer

Definition

See EmbeddedChainer

794

Page 795: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element EmbeddedChainerRef]

Derived By

Type string

Referenced By

● Element EmbeddedChainerRef

Definition

See EmbeddedChainerRef

795

Page 796: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element EmbeddedUI]

Description

Unique identifier for embedded UI.

Derived By

Type string

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

796

Page 797: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element EmbeddedUIResource]

Description

Identifier for the embedded UI resource.

Derived By

Type string

Referenced By

● Element EmbeddedUIResource

Definition

See EmbeddedUIResource

797

Page 798: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element EnsureTable]

Description

The name of the table.

Derived By

Type string

Referenced By

● Element EnsureTable

Definition

See EnsureTable

798

Page 799: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Environment]

Description

Unique identifier for environment entry.

Derived By

Type string

Referenced By

● Element Environment

Definition

See Environment

799

Page 800: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Error]

Description

Number of the error for which a message is being provided.

Derived By

Type integer

Referenced By

● Element Error

Remarks

See MSI SDK for error definitions.

Definition

See Error

800

Page 801: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Extension]

Description

This is simply the file extension, like "doc" or "xml". Do not include the preceding period.

Derived By

Type string

Referenced By

● Element Extension

Definition

See Extension

801

Page 802: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Feature]

Description

Unique identifier of the feature.

Derived By

Type string

Referenced By

● Element Feature

Definition

See Feature

802

Page 803: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element FeatureGroup]

Description

Identifier for the FeatureGroup.

Derived By

Type string

Referenced By

● Element FeatureGroup

Definition

See FeatureGroup

803

Page 804: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element FeatureGroupRef]

Description

The identifier of the FeatureGroup to reference.

Derived By

Type string

Referenced By

● Element FeatureGroupRef

Definition

See FeatureGroupRef

804

Page 805: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element FeatureRef]

Description

The identifier of the Feature element to reference.

Derived By

Type string

Referenced By

● Element FeatureRef

Definition

See FeatureRef

805

Page 806: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element File]

Description

The unique identifier for this File element.

Derived By

Type string

Referenced By

● Element File

Remarks

If you omit Id, it defaults to the file name portion of the Source attribute, if specified. May be referenced as aProperty by specifying [#value].

Definition

See File

806

Page 807: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element FileSearch]

Description

Unique identifier for the file search and external key into the Signature table.

Derived By

Type string

Referenced By

● Element FileSearch

Remarks

This attribute is required if FileSearch is nested under a DirectorySearch or DirectorySearchRef element.

Definition

See FileSearch

807

Page 808: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element FileSearchRef]

Description

Specify the Id to the FileSearch to reference.

Derived By

Type string

Referenced By

● Element FileSearchRef

Definition

See FileSearchRef

808

Page 809: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Fragment]

Description

Optional identifier for a Fragment.

Derived By

Type string

Referenced By

● Element Fragment

Remarks

Should only be set by advanced users to tag sections.

Definition

See Fragment

809

Page 810: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Icon]

Description

The Id cannot by longer than 55 characters.

Derived By

Type string

Referenced By

● Element Icon

Remarks

In order to prevent errors in cases where the Id is modularized, it should not be longer than 18 characters.

Definition

See Icon

810

Page 811: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element IconRef]

Description

The identifier of the Icon element to reference.

Derived By

Type string

Referenced By

● Element IconRef

Definition

See IconRef

811

Page 812: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element IgnoreTable]

Description

The name of the table in the merge module that is not to be merged into the .msi file.

Derived By

Type string

Referenced By

● Element IgnoreTable

Definition

See IgnoreTable

812

Page 813: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element IniFile]

Description

Identifier for ini file.

Derived By

Type string

Referenced By

● Element IniFile

Definition

See IniFile

813

Page 814: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element IniFileSearch]

Description

External key into the Signature table.

Derived By

Type string

Referenced By

● Element IniFileSearch

Definition

See IniFileSearch

814

Page 815: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Instance]

Description

The identity of the instance transform.

Derived By

Type string

Referenced By

● Element Instance

Remarks

This value will define the name by which the instance should be referred to on the command line. In addition,the value of the this attribute will determine what the value of the property specified in Property attribute onInstanceTransforms will change to for each instance.

Definition

See Instance

815

Page 816: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Interface]

Description

GUID identifier for COM Interface.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Interface

Definition

See Interface

816

Page 817: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Media]

Description

Disk identifier for Media table.

Derived By

Type integer

Referenced By

● Element Media

Remarks

This number must be equal to or greater than 1.

Definition

See Media

817

Page 818: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Merge]

Description

The unique identifier for the Merge element in the source code.

Derived By

Type string

Referenced By

● Element Merge

Remarks

Referenced by the MergeRef/@Id.

Definition

See Merge

818

Page 819: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element MergeRef]

Description

The unique identifier for the Merge element to be referenced.

Derived By

Type string

Referenced By

● Element MergeRef

Definition

See MergeRef

819

Page 820: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Module]

Description

The name of the merge module (not the file name).

Derived By

Type string

Referenced By

● Element Module

Definition

See Module

820

Page 821: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ODBCDataSource]

Description

Identifier of the data source.

Derived By

Type string

Referenced By

● Element ODBCDataSource

Definition

See ODBCDataSource

821

Page 822: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ODBCDriver]

Description

Identifier for the driver.

Derived By

Type string

Referenced By

● Element ODBCDriver

Definition

See ODBCDriver

822

Page 823: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ODBCTranslator]

Description

Identifier for the translator.

Derived By

Type string

Referenced By

● Element ODBCTranslator

Definition

See ODBCTranslator

823

Page 824: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Package]

Description

The package code GUID for a product or merge module.

Derived By

Type AutogenGuid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Package

Remarks

When compiling a product, this attribute should not be set in order to allow the package code to be generatedfor each build. When compiling a merge module, this attribute must be set to the modularization guid.

Definition

See Package

824

Page 825: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Patch]

Description

Patch code for this patch.

Derived By

Type AutogenGuid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Patch

Definition

See Patch

825

Page 826: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element PatchBaseline]

Description

Identifier for a set of product versions.

Derived By

Type string

Referenced By

● Element PatchBaseline

Definition

See PatchBaseline

826

Page 827: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element PatchCreation]

Description

PatchCreation identifier; this is the primary key for identifying patches.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element PatchCreation

Definition

See PatchCreation

827

Page 828: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element PatchFamily]

Description

Identifier which indicates a sequence family to which this patch belongs.

Derived By

Type string

Referenced By

● Element PatchFamily

Definition

See PatchFamily

828

Page 829: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element PatchFamilyRef]

Description

The identifier of the CustomAction to reference.

Derived By

Type string

Referenced By

● Element PatchFamilyRef

Definition

See PatchFamilyRef

829

Page 830: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Product]

Description

The product code GUID for the product.

Derived By

Type AutogenGuid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Product

Definition

See Product

830

Page 831: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ProgId]

Derived By

Type string

Referenced By

● Element ProgId

Definition

See ProgId

831

Page 832: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Property]

Description

Unique identifier for Property.

Derived By

Type string

Referenced By

● Element Property

Definition

See Property

832

Page 833: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element PropertyRef]

Description

Identifier of Property to reference.

Derived By

Type string

Referenced By

● Element PropertyRef

Definition

See PropertyRef

833

Page 834: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Registry]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element Registry

Remarks

If this attribute is not specified, an identifier will be generated by hashing the parent Component identifier, Root,Key, and Name.

Definition

See Registry

834

Page 835: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RegistryKey]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element RegistryKey

Remarks

If this attribute is not specified, an identifier will be generated by hashing the parent Component identifier, Root,Key, and Name.

Definition

See RegistryKey

835

Page 836: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RegistrySearch]

Description

Signature to be used for the file, directory or registry key being searched for.

Derived By

Type string

Referenced By

● Element RegistrySearch

Definition

See RegistrySearch

836

Page 837: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RegistrySearchRef]

Description

Specify the Id of the RegistrySearch to reference.

Derived By

Type string

Referenced By

● Element RegistrySearchRef

Definition

See RegistrySearchRef

837

Page 838: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RegistryValue]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element RegistryValue

Remarks

If this attribute is not specified, an identifier will be generated by hashing the parent Component identifier, Root,Key, and Name.

Definition

See RegistryValue

838

Page 839: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RemoveFile]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element RemoveFile

Definition

See RemoveFile

839

Page 840: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RemoveFolder]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element RemoveFolder

Definition

See RemoveFolder

840

Page 841: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RemoveRegistryKey]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element RemoveRegistryKey

Remarks

If this attribute is not specified, an identifier will be generated by hashing the parent Component identifier, Root,Key, and Name.

Definition

See RemoveRegistryKey

841

Page 842: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element RemoveRegistryValue]

Description

Primary key used to identify this particular entry.

Derived By

Type string

Referenced By

● Element RemoveRegistryValue

Remarks

If this attribute is not specified, an identifier will be generated by hashing the parent Component identifier, Root,Key, and Name.

Definition

See RemoveRegistryValue

842

Page 843: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ReplacePatch]

Description

Patch GUID to be unregistered if it exists on the machine targeted by this patch.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element ReplacePatch

Definition

See ReplacePatch

843

Page 844: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ReserveCost]

Description

A primary key that uniquely identifies this ReserveCost entry.

Derived By

Type string

Referenced By

● Element ReserveCost

Definition

See ReserveCost

844

Page 845: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ServiceControl]

Derived By

Type string

Referenced By

● Element ServiceControl

Definition

See ServiceControl

845

Page 846: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ServiceDependency]

Derived By

Type string

Referenced By

● Element ServiceDependency

Remarks

The value of this attribute should be one of the following:

1. The name (not the display name) of a previously installed service.

2. A foreign key referring to another ServiceInstall/@Id.

3. A group of services (in which case the Group attribute should be set to 'yes').

Definition

See ServiceDependency

846

Page 847: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element ServiceInstall]

Description

Unique identifier for this service.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

847

Page 848: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element SetDirectory]

Description

This attribute specifies a reference to a Directory element with matching Id attribute.

Derived By

Type string

Referenced By

● Element SetDirectory

Remarks

The path of the Directory will be set to the Value attribute.

Definition

See SetDirectory

848

Page 849: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element SetProperty]

Description

This attribute specifies the Property to set to the Value.

Derived By

Type string

Referenced By

● Element SetProperty

Definition

See SetProperty

849

Page 850: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element SFPFile]

Description

Primary Key to File Table.

Derived By

Type string

Referenced By

● Element SFPFile

Definition

See SFPFile

850

Page 851: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Shortcut]

Description

Unique identifier for the shortcut.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

This value will serve as the primary key for the row.

Definition

See Shortcut

851

Page 852: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element TargetFile]

Description

Foreign key into the File table.

Derived By

Type string

Referenced By

● Element TargetFile

Definition

See TargetFile

852

Page 853: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element TargetImage]

Description

Identifier for the target image.

Derived By

Type string

Referenced By

● Element TargetImage

Definition

See TargetImage

853

Page 854: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element TargetProductCode]

Description

The product code for a product that can receive this patch (or '*' for all products).

Derived By

Type string

Referenced By

● Element TargetProductCode

Definition

See TargetProductCode

854

Page 855: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element TextStyle]

Derived By

Type string

Referenced By

● Element TextStyle

Definition

See TextStyle

855

Page 856: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element TypeLib]

Description

The GUID that identifes the type library.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element TypeLib

Definition

See TypeLib

856

Page 857: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element UI]

Derived By

Type string

Referenced By

● Element UI

Definition

See UI

857

Page 858: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element UIRef]

Derived By

Type string

Referenced By

● Element UIRef

Definition

See UIRef

858

Page 859: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element UIText]

Derived By

Type string

Referenced By

● Element UIText

Definition

See UIText

859

Page 860: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Upgrade]

Description

This value specifies the upgrade code for the products that are to be detected by the FindRelatedProductsaction.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Upgrade

Definition

See Upgrade

860

Page 861: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element UpgradeImage]

Description

Identifier to connect target images with upgraded image.

Derived By

Type string

Referenced By

● Element UpgradeImage

Definition

See UpgradeImage

861

Page 862: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element Verb]

Description

The verb for the command.

Derived By

Type string

Referenced By

● Element Verb

Definition

See Verb

862

Page 863: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Id [element WixVariable]

Description

The name of the variable.

Derived By

Type string

Referenced By

● Element WixVariable

Definition

See WixVariable

863

Page 864: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Ignore [element UpgradeFile]

Description

If yes, the file is ignored during patching, and the next two attributes are ignored.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeFile

Definition

See UpgradeFile

864

Page 865: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreActionData [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_ACTIONDATA messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

865

Page 866: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreActionStart [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_ACTIONSTART messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

866

Page 867: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreAddExistingRow [element Validate]

Description

Ignore errors when adding existing rows.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

867

Page 868: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreAddExistingTable [element Validate]

Description

Ignore errors when adding existing tables.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

868

Page 869: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreChangingCodePage [element Validate]

Description

Ignore errors when changing the database code page.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'no'.

Definition

See Validate

869

Page 870: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreCommonData [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_COMMONDATA messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

870

Page 871: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreDeleteMissingRow [element Validate]

Description

Ignore errors when deleting missing rows.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

871

Page 872: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreDeleteMissingTable [element Validate]

Description

Ignore errors when deleting missing tables.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

872

Page 873: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreError [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_ERROR messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

873

Page 874: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreFatalExit [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_FATALEXIT messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

874

Page 875: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreFilesInUse [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_FILESINUSE messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

875

Page 876: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreInfo [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_INFO messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

876

Page 877: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreInitialize [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_INITIALIZE messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

877

Page 878: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreMissingFiles [element TargetImage]

Description

Files missing from the target image are ignored by the installer.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TargetImage

Definition

See TargetImage

878

Page 879: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreOutOfDiskSpace [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_OUTOFDISKSPACE messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

879

Page 880: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreParent [element FeatureGroupRef]

Description

Normally feature group references that end up nested under a parent element create a connection to thatparent.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element FeatureGroupRef

Remarks

This behavior is undesirable when trying to simply reference to a FeatureGroup in a different Fragment. Specify'yes' to have this feature group reference not create a connection to its parent. The default is 'no'.

Definition

See FeatureGroupRef

880

Page 881: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreParent [element FeatureRef]

Description

Normally feature references that are nested under a parent element create a connection to that parent.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element FeatureRef

Remarks

This behavior is undesirable when trying to simply reference a Feature in a different Fragment. Specify 'yes' tohave this feature reference not create a connection to its parent. The default is 'no'.

Definition

See FeatureRef

881

Page 882: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreProgress [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_PROGRESS messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

882

Page 883: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreRemoveFailure [element UpgradeVersion]

Description

Set to "yes" to continue installation upon failure to remove a product or application.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

883

Page 884: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreResolveSource [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_RESOLVESOURCE messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

884

Page 885: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreRMFilesInUse [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_RMFILESINUSE messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

885

Page 886: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreShowDialog [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_SHOWDIALOG messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

886

Page 887: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreTerminate [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_TERMINATE messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

887

Page 888: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreUpdateMissingRow [element Validate]

Description

Ignore errors when updating missing rows.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

888

Page 889: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreUser [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_USER messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

889

Page 890: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IgnoreWarning [element EmbeddedUI]

Description

Embedded UI will not recieve any INSTALLLOGMODE_WARNING messages.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

890

Page 891: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Image [element Control]

Description

This attribute is only valid for RadioButton, PushButton, and Icon Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

891

Page 892: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Impersonate [element CustomAction]

Description

This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate theuser context of the installing user when executing this custom action.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CustomAction

Remarks

Typically the value should be 'yes', except when the custom action needs elevated privileges to apply changesto the machine.

Definition

See CustomAction

892

Page 893: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IncludeMaximum [element UpgradeVersion]

Description

Set to "yes" to make the range of versions detected include the value specified in Maximum.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

893

Page 894: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: IncludeMinimum [element UpgradeVersion]

Description

Set to "no" to make the range of versions detected exclude the value specified in Minimum.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeVersion

Remarks

This attribute is "yes" by default.

Definition

See UpgradeVersion

894

Page 895: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Indirect [element Control]

Description

Specifies whether the value displayed or changed by this control is referenced indirectly.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Remarks

If this bit is set, the control displays or changes the value of the property that has the identifier listed in theProperty column of the Control table.

Definition

See Control

895

Page 896: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Insertable [element Class]

Description

Specifies the CLISD may be insertable.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Definition

See Class

896

Page 897: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: InstallDefault [element Feature]

Description

This attribute determines the default install/run location of a feature.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

followParent Forces the feature to follow the same installation state as its parentfeature.

local Favors installing this feature locally by setting themsidbFeatureAttributesFavorLocal attribute.

source Favors running this feature from source by setting themsidbFeatureAttributesFavorSource attribute.

Referenced By

● Element Feature

Remarks

This attribute cannot be specified if the value of the FollowParent attribute is 'yes' since that would ask theinstaller to force this feature to follow the parent installation state and simultaneously favor a particularinstallation state just for this feature.

Definition

See Feature

897

Page 898: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: InstallerVersion [element Package]

Description

The minimum version of the Windows Installer required to install this package.

Derived By

Type integer

Referenced By

● Element Package

Remarks

Take the major version of the required Windows Installer and multiply by a 100 then add the minor version ofthe Windows Installer. For example, "200" would represent Windows Installer 2.0 and "405" would representWindows Installer 4.5.

Definition

See Package

898

Page 899: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: InstallPrivileges [element Package]

Description

Use this attribute to specify the priviliges required to install the package on Windows Vista and above.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

limited Set this value to declare that the package does not require elevatedprivileges to install.

elevated Set this value to declare that the package requires elevated privilegesto install.This is the default value.

Referenced By

● Element Package

Definition

See Package

899

Page 900: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: InstallScope [element Package]

Description

Use this attribute to specify the installation scope of this package: per-machine or per-user.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

perMachine Set this value to declare that the package is a per-machine installationand requires elevated privileges to install.Sets the ALLUSERS property to 1.

perUser Set this value to declare that the package is a per-user installation anddoes not require elevated privileges to install.Sets the package's InstallPrivileges attribute to "limited."

Referenced By

● Element Package

Definition

See Package

900

Page 901: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Integer [element Control]

Description

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.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

901

Page 902: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Interactive [element ServiceInstall]

Description

Whether or not the service interacts with the desktop.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

902

Page 903: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Italic [element TextStyle]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TextStyle

Definition

See TextStyle

903

Page 904: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: JScriptCall [element CustomAction]

Description

This attribute specifies the name of the JScript function to execute in a script.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

The script must be provided in a Binary element identified by the BinaryKey attribute described above. In otherwords, this attribute must be specified in conjunction with the BinaryKey attribute.

Definition

See CustomAction

904

Page 905: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeepModeless [element Dialog]

Description

Keep modeless dialogs alive when this dialog is created through DoAction.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

905

Page 906: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element IniFile]

Description

The localizable .ini file key within the section.

Derived By

Type string

Referenced By

● Element IniFile

Definition

See IniFile

906

Page 907: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element IniFileSearch]

Description

The key value within the section.

Derived By

Type string

Referenced By

● Element IniFileSearch

Definition

See IniFileSearch

907

Page 908: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element Registry]

Description

The localizable key for the registry value.

Derived By

Type string

Referenced By

● Element Registry

Definition

See Registry

908

Page 909: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element RegistryKey]

Description

The localizable key for the registry value.

Derived By

Type string

Referenced By

● Element RegistryKey

Remarks

If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specifiedit will be appended to the path of the parent.

Definition

See RegistryKey

909

Page 910: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element RegistrySearch]

Description

Key for the registry value.

Derived By

Type string

Referenced By

● Element RegistrySearch

Definition

See RegistrySearch

910

Page 911: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element RegistryValue]

Description

The localizable key for the registry value.

Derived By

Type string

Referenced By

● Element RegistryValue

Remarks

If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specifiedit will be appended to the path of the parent.

Definition

See RegistryValue

911

Page 912: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element RemoveRegistryKey]

Description

The localizable key for the registry value.

Derived By

Type string

Referenced By

● Element RemoveRegistryKey

Definition

See RemoveRegistryKey

912

Page 913: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Key [element RemoveRegistryValue]

Description

The localizable key for the registry value.

Derived By

Type string

Referenced By

● Element RemoveRegistryValue

Remarks

If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specifiedit will be appended to the path of the parent.

Definition

See RemoveRegistryValue

913

Page 914: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyColumn [element Column]

Description

Column in the table in KeyTable attribute.

Derived By

Type integer

Referenced By

● Element Column

Definition

See Column

914

Page 915: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyNoOrphan [element Configuration]

Description

Does not merge rule according to rules in MSI SDK.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Configuration

Definition

See Configuration

915

Page 916: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyPath [element Component]

Description

If this attribute's value is set to 'yes', then the Directory of this Component is used as the KeyPath.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

To set a Registry key or File as the KeyPath of a component, set the KeyPath attribute to 'yes' on one of thosechild elements.

Definition

See Component

916

Page 917: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyPath [element File]

Description

Set to yes in order to force this file to be the key path for the parent component.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

917

Page 918: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyPath [element ODBCDataSource]

Description

Set 'yes' to force this file to be key path for parent Component

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ODBCDataSource

Definition

See ODBCDataSource

918

Page 919: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyPath [element Registry]

Description

Set this attribute to 'yes' to make this registry key the KeyPath of the parent component.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Registry

Remarks

Only one resource (registry, file, etc) can be the KeyPath of a component.

Definition

See Registry

919

Page 920: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyPath [element RegistryValue]

Description

Set this attribute to 'yes' to make this registry key the KeyPath of the parent component.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element RegistryValue

Remarks

Only one resource (registry, file, etc) can be the KeyPath of a component.

Definition

See RegistryValue

920

Page 921: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: KeyTable [element Column]

Description

Table in which this column is an external key.

Derived By

Type string

Referenced By

● Element Column

Remarks

Can be semicolon delimited.

Definition

See Column

921

Page 922: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Keywords [element Package]

Description

Optional keywords for browsing.

Derived By

Type string

Referenced By

● Element Package

Definition

See Package

922

Page 923: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Keywords [element PatchInformation]

Description

Optional keywords for browsing

Derived By

Type string

Referenced By

● Element PatchInformation

Definition

See PatchInformation

923

Page 924: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Language [element Merge]

Description

Specifies the decimal LCID or localization token for the language to merge the Module in as.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Merge

Definition

See Merge

924

Page 925: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Language [element Module]

Description

The decimal language ID (LCID) of the merge module.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Module

Definition

See Module

925

Page 926: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Language [element Product]

Description

The decimal language ID (LCID) for the product.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Product

Definition

See Product

926

Page 927: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Language [element TypeLib]

Description

The language of the type library.

Derived By

Type integer

Referenced By

● Element TypeLib

Remarks

This must be a non-negative integer.

Definition

See TypeLib

927

Page 928: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Language [element UpgradeVersion]

Description

Specifies the set of languages detected by FindRelatedProducts.

Derived By

Type string

Referenced By

● Element UpgradeVersion

Remarks

Enter a list of numeric language identifiers (LANGID) separated by commas (,). Leave this value null to specifyall languages. Set ExcludeLanguages to "yes" in order detect all languages, excluding the languages listed inthis value.

Definition

See UpgradeVersion

928

Page 929: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Languages [element FileSearch]

Description

The languages supported by the file.

Derived By

Type string

Referenced By

● Element FileSearch

Definition

See FileSearch

929

Page 930: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Languages [element Package]

Description

The list of language IDs (LCIDs) supported in the package.

Derived By

Type string

Referenced By

● Element Package

Definition

See Package

930

Page 931: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Languages [element PatchInformation]

Description

List of language IDs supported in package

Derived By

Type string

Referenced By

● Element PatchInformation

Definition

See PatchInformation

931

Page 932: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Layout [element Media]

Description

This attribute specifies the root directory for the uncompressed files that are a part of this Media element.

Derived By

Type string

Referenced By

● Element Media

Remarks

By default, the src will be the output directory for the final image. The default value ensures the bindergeneratesan installable image. If a relative path is specified in the src attribute, the value will be appended to the image'soutput directory. If an absolute path is provided, that path will be used without modification. The latter twooptions are provided to ease the layout of an image onto multiple medias (CDs/DVDs).

Definition

See Media

932

Page 933: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LeftScroll [element Control]

Description

Set this attribute to "yes" to cause the scroll bar to display on the left side of the Control.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

933

Page 934: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LeftScroll [element Dialog]

Description

Used to align the scroll bar on the left.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

934

Page 935: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Length [element IgnoreRange]

Description

Length of the range.

Derived By

Type int

Referenced By

● Element IgnoreRange

Definition

See IgnoreRange

935

Page 936: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Length [element ProtectRange]

Description

Length of the range.

Derived By

Type int

Referenced By

● Element ProtectRange

Definition

See ProtectRange

936

Page 937: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Level [element Condition]

Description

Used only under Feature elements and is required.

Derived By

Type integer

Referenced By

● Element Condition

Remarks

Allows modifying the level of a Feature based on the result of this condition.

Definition

See Condition

937

Page 938: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Level [element Feature]

Description

Sets the install level of this feature.

Derived By

Type integer

Referenced By

● Element Feature

Remarks

A value of 0 will disable the feature. Processing the Condition Table can modify the level value (this is set viathe Condition child element).

Definition

See Feature

938

Page 939: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LoadOrderGroup [element ServiceInstall]

Description

The load ordering group that this service should be a part of.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

939

Page 940: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Localizable [element Column]

Description

Whether this column can be localized.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Column

Definition

See Column

940

Page 941: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LocalService [element AppId]

Description

Set this value to the name of a service to allow the object to be installed as a Win32 service.

Derived By

Type string

Referenced By

● Element AppId

Definition

See AppId

941

Page 942: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Location [element Component]

Derived By

Restricting NMTOKEN

Enumeration

Value Description

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 (itcannot be run from the user's computer).

either Allows the component to run from source or locally.

Referenced By

● Element Component

Definition

See Component

942

Page 943: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element Directory]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Directory

Definition

See Directory

943

Page 944: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element File]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element File

Definition

See File

944

Page 945: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element FileSearch]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element FileSearch

Definition

See FileSearch

945

Page 946: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element IniFile]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element IniFile

Definition

See IniFile

946

Page 947: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element IniFileSearch]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element IniFileSearch

Definition

See IniFileSearch

947

Page 948: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element RemoveFile]

Derived By

Type WildCardLongFileNameType

Restrictions

● Value must match the following pattern: [^\\\

Referenced By

● Element RemoveFile

Definition

See RemoveFile

948

Page 949: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongName [element Shortcut]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Shortcut

Definition

See Shortcut

949

Page 950: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: LongSource [element Directory]

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Directory

Definition

See Directory

950

Page 951: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MajorVersion [element TypeLib]

Description

The major version of the type library.

Derived By

Type integer

Referenced By

● Element TypeLib

Remarks

The value should be an integer from 0 - 255.

Definition

See TypeLib

951

Page 952: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Manufacturer [element Package]

Description

The vendor releasing the package.

Derived By

Type string

Referenced By

● Element Package

Definition

See Package

952

Page 953: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Manufacturer [element Patch]

Description

Vendor releasing the package

Derived By

Type string

Referenced By

● Element Patch

Definition

See Patch

953

Page 954: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Manufacturer [element PatchInformation]

Description

Vendor releasing the package

Derived By

Type string

Referenced By

● Element PatchInformation

Definition

See PatchInformation

954

Page 955: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Manufacturer [element Product]

Description

The manufacturer of the product.

Derived By

Type string

Referenced By

● Element Product

Definition

See Product

955

Page 956: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ManufacturerName [element PatchMetadata]

Description

Name of the manufacturer.

Derived By

Type string

Referenced By

● Element PatchMetadata

Definition

See PatchMetadata

956

Page 957: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Mask [element FileTypeMask]

Description

Hex value that is AND'd against the bytes in the file at Offset.

Derived By

Type HexType

Restrictions

● Value must match the following pattern: [0-9A-Fa-f]*

Referenced By

● Element FileTypeMask

Definition

See FileTypeMask

957

Page 958: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MaxDate [element FileSearch]

Description

The maximum modification date and time of the file.

Derived By

Type dateTime

Referenced By

● Element FileSearch

Remarks

Formatted as YYYY-MM-DDTHH:mm:ss, where YYYY is the year, MM is month, DD is day, 'T' is literal, HH ishour, mm is minute and ss is second.

Definition

See FileSearch

958

Page 959: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Maximum [element UpgradeVersion]

Description

Specifies the upper boundary of the range of product versions detected by FindRelatedProducts.

Derived By

Type string

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

959

Page 960: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MaxSize [element FileSearch]

Description

The maximum size of the file.

Derived By

Type int

Referenced By

● Element FileSearch

Definition

See FileSearch

960

Page 961: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MaxValue [element Column]

Description

Maximum value for a numeric value, date or version in this column.

Derived By

Type integer

Referenced By

● Element Column

Definition

See Column

961

Page 962: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MaxVersion [element FileSearch]

Description

The maximum version of the file.

Derived By

Type string

Referenced By

● Element FileSearch

Definition

See FileSearch

962

Page 963: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MediaSrcProp [element Family]

Description

Entered into the Source field of the new Media table entry of the upgraded image.

Derived By

Type string

Referenced By

● Element Family

Definition

See Family

963

Page 964: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Message [element Condition]

Description

Used only under Fragment or Product elements and is required.

Derived By

Type string

Referenced By

● Element Condition

Remarks

Set the value to the text to display when the condition fails and the installation must be terminated.

Definition

See Condition

964

Page 965: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MigrateFeatures [element UpgradeVersion]

Description

Set to "yes" to migrate feature states from upgraded products by enabling the logic in the MigrateFeatureStatesaction.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

965

Page 966: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinDate [element FileSearch]

Description

The minimum modification date and time of the file.

Derived By

Type dateTime

Referenced By

● Element FileSearch

Remarks

Formatted as YYYY-MM-DDTHH:mm:ss, where YYYY is the year, MM is month, DD is day, 'T' is literal, HH ishour, mm is minute and ss is second.

Definition

See FileSearch

966

Page 967: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Minimum [element UpgradeVersion]

Description

Specifies the lower bound on the range of product versions to be detected by FindRelatedProducts.

Derived By

Type string

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

967

Page 968: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinorUpdateTargetRTM [element Patch]

Description

Indicates that the patch targets the RTM version of the product or the most recent major upgrade patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Remarks

Author this optional property in minor update patches that contain sequencing information to indicate that thepatch removes all patches up to the RTM version of the product, or up to the most recent major upgrade patch.This property is available beginning with Windows Installer 3.1.

Definition

See Patch

968

Page 969: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinorUpdateTargetRTM [element PatchMetadata]

Description

Indicates that the patch targets the RTM version of the product or the most recent major upgrade patch.

Derived By

Type string

Referenced By

● Element PatchMetadata

Remarks

Author this optional property in minor update patches that contain sequencing information to indicate that thepatch removes all patches up to the RTM version of the product, or up to the most recent major upgrade patch.This property is available beginning with Windows Installer 3.1.

Definition

See PatchMetadata

969

Page 970: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinorVersion [element TypeLib]

Description

The minor version of the type library.

Derived By

Type integer

Referenced By

● Element TypeLib

Remarks

The value should be an integer from 0 - 255.

Definition

See TypeLib

970

Page 971: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinSize [element FileSearch]

Description

The minimum size of the file.

Derived By

Type int

Referenced By

● Element FileSearch

Definition

See FileSearch

971

Page 972: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinValue [element Column]

Description

Minimum value for a numeric value, date or version in this column.

Derived By

Type integer

Referenced By

● Element Column

Definition

See Column

972

Page 973: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MinVersion [element FileSearch]

Description

The minimum version of the file.

Derived By

Type string

Referenced By

● Element FileSearch

Definition

See FileSearch

973

Page 974: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Modeless [element Dialog]

Description

Used to set the dialog as modeless.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

974

Page 975: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Modularize [element Column]

Description

How this column should be modularized, if at all.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

None Column should not be modularized. This is the default value.

Column Column should be modularized.

Condition Column is a condition and should be modularized.

Icon When the column is an primary or foreign key to the Icon table itshould be modularized special.

Property Any Properties in the column should be modularized.

SemicolonDelimited Semi-colon list of keys, all of which need to be modularized.

Referenced By

● Element Column

Definition

See Column

975

Page 976: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MoreInfoURL [element Patch]

Description

A URL that provides information specific to this patch.

Derived By

Type string

Referenced By

● Element Patch

Remarks

In Add/Remove Programs from XP SP2 on.

Definition

See Patch

976

Page 977: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: MoreInfoURL [element PatchMetadata]

Description

A URL that provides information specific to this patch.

Derived By

Type string

Referenced By

● Element PatchMetadata

Remarks

In Add/Remove Programs from XP SP2 on.

Definition

See PatchMetadata

977

Page 978: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Multiline [element Control]

Description

This attribute is only valid for Edit Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

978

Page 979: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Configuration]

Description

Defines the name of the configurable item.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

979

Page 980: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element ConfigurationData]

Description

Key into the ModuleConfiguration table.

Derived By

Type string

Referenced By

● Element ConfigurationData

Definition

See ConfigurationData

980

Page 981: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Directory]

Description

The name of the directory.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Directory

Remarks

Do not specify this attribute (or the LongName attribute) if this directory represents the same directory as theparent (see the Windows Installer SDK's Directory table topic for more information about the "." operator).

In prior versions of the WiX toolset, this attribute specified the short directory name. This attribute's value maynow be either a short or long directory name. If a short directory name is specified, the ShortName attributemay not be specified. If a long directory name is specified, the LongName attribute may not be specified. Also, ifthis value is a long directory name, the ShortName attribute may be omitted to allow WiX to attempt to generatea unique short directory name. However, if this name collides with another directory or you wish to manuallyspecify the short directory name, then the ShortName attribute may be specified.

Definition

See Directory

981

Page 982: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element EmbeddedUI]

Description

The name for the embedded UI DLL when it is extracted from the Product and executed. (Windows Installerdoes not support the typical short filename and long filename combination for embedded UI files as it does forother kinds of files.)

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element EmbeddedUI

Remarks

If this attribute is not specified the Id attribute will be used.

Definition

See EmbeddedUI

982

Page 983: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element EmbeddedUIResource]

Description

The name for the resource when it is extracted from the Product for use by the embedded UI DLL. (WindowsInstaller does not support the typical short filename and long filename combination for embedded UI files as itdoes for other kinds of files.)

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element EmbeddedUIResource

Remarks

If this attribute is not specified the Id attribute will be used.

Definition

See EmbeddedUIResource

983

Page 984: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Environment]

Description

Name of the environment variable.

Derived By

Type string

Referenced By

● Element Environment

Definition

See Environment

984

Page 985: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Family]

Description

Identifier for the family.

Derived By

Type string

Referenced By

● Element Family

Definition

See Family

985

Page 986: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element File]

Description

In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's value may now beeither a short or long file name.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element File

Remarks

If a short file name is specified, the ShortName attribute may not be specified. If a long file name is specified,the LongName attribute may not be specified. Also, if this value is a long file name, the ShortName attributemay be omitted to allow WiX to attempt to generate a unique short file name. However, if this name collideswith another file or you wish to manually specify the short file name, then the ShortName attribute may bespecified. Finally, if this attribute is omitted then its default value is the file name portion of the Source attribute,if one is specified, or the value of the Id attribute, if the Source attribute is omitted or doesn't contain a file name.

Definition

See File

986

Page 987: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element FileSearch]

Description

In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's value may now beeither a short or long file name.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element FileSearch

Remarks

If a short file name is specified, the ShortName attribute may not be specified. If a long file name is specified,the LongName attribute may not be specified. If you wish to manually specify the short file name, then theShortName attribute may be specified.

Definition

See FileSearch

987

Page 988: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element IgnoreModularization]

Description

The name of the item to ignore modularization for.

Derived By

Type string

Referenced By

● Element IgnoreModularization

Definition

See IgnoreModularization

988

Page 989: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element IniFile]

Description

In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now beeither a short or long name.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element IniFile

Remarks

If a short name is specified, the ShortName attribute may not be specified. If a long name is specified, theLongName attribute may not be specified. Also, if this value is a long name, the ShortName attribute may beomitted to allow WiX to attempt to generate a unique short name. However, if this name collides with anotherfile or you wish to manually specify the short name, then the ShortName attribute may be specified.

Definition

See IniFile

989

Page 990: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element IniFileSearch]

Description

In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now beeither a short or long name.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element IniFileSearch

Remarks

If a short name is specified, the ShortName attribute may not be specified. If a long name is specified, theLongName attribute may not be specified. Also, if this value is a long name, the ShortName attribute may beomitted to allow WiX to attempt to generate a unique short name. However, if you wish to manually specify theshort name, then the ShortNameattribute may be specified.

Definition

See IniFileSearch

990

Page 991: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Interface]

Description

Name for COM Interface.

Derived By

Type string

Referenced By

● Element Interface

Definition

See Interface

991

Page 992: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element ODBCDataSource]

Description

Name for the data source.

Derived By

Type string

Referenced By

● Element ODBCDataSource

Definition

See ODBCDataSource

992

Page 993: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element ODBCDriver]

Description

Name for the driver.

Derived By

Type string

Referenced By

● Element ODBCDriver

Definition

See ODBCDriver

993

Page 994: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element ODBCTranslator]

Description

Name for the translator.

Derived By

Type string

Referenced By

● Element ODBCTranslator

Definition

See ODBCTranslator

994

Page 995: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element PatchProperty]

Description

Name of the patch property.

Derived By

Type string

Referenced By

● Element PatchProperty

Definition

See PatchProperty

995

Page 996: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Product]

Description

The descriptive name of the product.

Derived By

Type string

Referenced By

● Element Product

Definition

See Product

996

Page 997: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Registry]

Description

The localizable registry value name.

Derived By

Type string

Referenced By

● Element Registry

Remarks

If this attribute is not provided the default value for the registry key will be set instead. The Windows Installerallows several special values to be set for this attribute. You should not use them in WiX. Instead useappropriate values in the Action attribute to get the desired behavior.

Definition

See Registry

997

Page 998: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element RegistrySearch]

Description

Registry value name.

Derived By

Type string

Referenced By

● Element RegistrySearch

Definition

See RegistrySearch

998

Page 999: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element RegistryValue]

Description

The localizable registry value name.

Derived By

Type string

Referenced By

● Element RegistryValue

Remarks

If this attribute is not provided the default value for the registry key will be set instead. The Windows Installerallows several special values to be set for this attribute. You should not use them in WiX. Instead useappropriate values in the Action attribute to get the desired behavior.

Definition

See RegistryValue

999

Page 1000: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element RemoveFile]

Description

This value should be set to the localizable name of the file(s) to be removed.

Derived By

Type WildCardLongFileNameType

Restrictions

● Value must match the following pattern: [^\\\

Referenced By

● Element RemoveFile

Remarks

All of the files that match the wild card will be removed from the specified directory. The value is a filename thatmay alsocontain the wild card characters "?" for any single character or "*" for zero or more occurrences of anycharacter. In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's valuemay now be either a short or long file name. If a short file name is specified, the ShortName attribute may notbe specified. If a long file name is specified, the LongName attribute may not be specified. Also, if this value is along file name, the ShortName attribute may be omitted toallow WiX to attempt to generate a unique short file name. However, if you wish to manually specify the shortfile name, then the ShortName attribute may be specified.

Definition

See RemoveFile

1000

Page 1001: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element RemoveRegistryValue]

Description

The localizable registry value name.

Derived By

Type string

Referenced By

● Element RemoveRegistryValue

Remarks

If this attribute is not provided the default value for the registry key will be set instead. The Windows Installerallows several special values to be set for this attribute. You should not use them in WiX. Instead useappropriate values in the Action attribute to get the desired behavior.

Definition

See RemoveRegistryValue

1001

Page 1002: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element ServiceControl]

Description

Name of the service.

Derived By

Type string

Referenced By

● Element ServiceControl

Definition

See ServiceControl

1002

Page 1003: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element ServiceInstall]

Description

This column is the string that gives the service name to install.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

1003

Page 1004: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element SFPCatalog]

Description

Filename for catalog file when installed.

Derived By

Type string

Referenced By

● Element SFPCatalog

Definition

See SFPCatalog

1004

Page 1005: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Name [element Shortcut]

Description

In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now beeither a short or long name.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Shortcut

Remarks

If a short name is specified, the ShortName attribute may not be specified. If a long name is specified, theLongName attribute may not be specified. Also, if this value is a long name, the ShortName attribute may beomitted to allow WiX to attempt to generate a unique short name. However, if this name collides with anothershortcut or you wish to manually specify the short name, then the ShortName attribute may be specified.

Definition

See Shortcut

1005

Page 1006: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NeverOverwrite [element Component]

Description

If this attribute is set to 'yes', the installer does not install or reinstall the component if a key path file or a keypath registry entry for the component already exists.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

The application does register itself as a client of the component. Use this flag only for components that arebeing registered by the Registry table. Do not use this flag for components registered by the AppId, Class,Extension, ProgId, MIME, and Verb tables.

Definition

See Component

1006

Page 1007: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NoMinimize [element Dialog]

Description

Used to specify if the dialog can be minimized.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

1007

Page 1008: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NonNullable [element Configuration]

Description

If yes, null is not a valid entry.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Configuration

Definition

See Configuration

1008

Page 1009: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NoOpen [element ProgId]

Description

Specifies that the associated ProgId should not be opened by users.

Derived By

Type string

Referenced By

● Element ProgId

Remarks

The value is presented as a warning to users. An empty string is also valid for this attribute.

Definition

See ProgId

1009

Page 1010: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NoPrefix [element Control]

Description

This attribute is only valid for Text Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1010

Page 1011: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Notify [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1011

Page 1012: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NoWrap [element Control]

Description

This attribute is only valid for Text Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1012

Page 1013: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Nullable [element Column]

Description

Whether this column can be left null.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Column

Definition

See Column

1013

Page 1014: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: NumMethods [element Interface]

Description

Number of methods implemented on COM Interface.

Derived By

Type integer

Referenced By

● Element Interface

Definition

See Interface

1014

Page 1015: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Offset [element FileTypeMask]

Description

Offset into file. If positive, offset is from the beginning; if negative, offset is from the end.

Derived By

Type integer

Referenced By

● Element FileTypeMask

Definition

See FileTypeMask

1015

Page 1016: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Offset [element IgnoreRange]

Description

Offset of the start of the range.

Derived By

Type int

Referenced By

● Element IgnoreRange

Definition

See IgnoreRange

1016

Page 1017: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Offset [element ProtectRange]

Description

Offset of the start of the range.

Derived By

Type int

Referenced By

● Element ProtectRange

Definition

See ProtectRange

1017

Page 1018: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: On [element RemoveFile]

Description

This value determines the time at which the file(s) may be removed.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

install Removes the file only when the parent component is being installed(msiInstallStateLocal or msiInstallStateSource).

uninstall Removes the file only when the parent component is being removed(msiInstallStateAbsent).

both Removes the file when the parent component is being installed orremoved.

Referenced By

● Element RemoveFile

Definition

See RemoveFile

1018

Page 1019: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: On [element RemoveFolder]

Description

This value determines the time at which the folder may be removed.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

install Removes the folder only when the parent component is being installed(msiInstallStateLocal or msiInstallStateSource).

uninstall Removes the folder only when the parent component is being removed(msiInstallStateAbsent).

both Removes the folder when the parent component is being installed orremoved.

Referenced By

● Element RemoveFolder

Definition

See RemoveFolder

1019

Page 1020: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OnExit [element Custom]

Description

Mutually exclusive with Before, After, and Sequence attributes

Derived By

Restricting NMTOKEN

Enumeration

Value Description

success

cancel

error

suspend

Referenced By

● Element Custom

Definition

See Custom

1020

Page 1021: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OnExit [element Show]

Description

mutually exclusive with Before, After, and Sequence attributes

Derived By

Restricting NMTOKEN

Enumeration

Value Description

success

cancel

error

suspend

Referenced By

● Element Show

Definition

See Show

1021

Page 1022: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OnlyDetect [element UpgradeVersion]

Description

Set to "yes" to detect products and applications but do not uninstall.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeVersion

Definition

See UpgradeVersion

1022

Page 1023: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OptimizedInstallMode [element Patch]

Description

If this attribute is set to 'yes' in all the patches to be applied in a transaction, the application of the patch isoptimized if possible.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Remarks

Available beginning with Windows Installer 3.1.

Definition

See Patch

1023

Page 1024: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OptimizedInstallMode [element PatchMetadata]

Description

If this attribute is set to 'yes' in all the patches to be applied in a transaction, the application of the patch isoptimized if possible.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchMetadata

Remarks

Available beginning with Windows Installer 3.1.

Definition

See PatchMetadata

1024

Page 1025: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OptimizePatchSizeForLargeFiles [element Patch]

Description

When this attribute is set, patches for files greater than approximately 4 MB in size may be made smaller.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Patch

Definition

See Patch

1025

Page 1026: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Order [element ExternalFile]

Description

Specifies the order of the external files to use when creating the patch.

Derived By

Type int

Referenced By

● Element ExternalFile

Definition

See ExternalFile

1026

Page 1027: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Order [element Publish]

Description

This attribute should only need to be set if this element is nested under a UI element in order to control theorder in which this publish event will be started.

Derived By

Type string

Referenced By

● Element Publish

Remarks

If this element is nested under a Control element, the default value will be one greater than any previousPublish element's order (the first element's default value is 1).

If this element is nested under a UI element, the default value is always 1 (it does not get a default value basedon any previous Publish elements).

Definition

See Publish

1027

Page 1028: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Order [element TargetImage]

Description

Relative order of the target image.

Derived By

Type int

Referenced By

● Element TargetImage

Definition

See TargetImage

1028

Page 1029: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: OutputPath [element PatchCreation]

Description

The full path, including file name, of the patch package file that is to be generated.

Derived By

Type string

Referenced By

● Element PatchCreation

Remarks

See PatchOutputPath for more information.

Definition

See PatchCreation

1029

Page 1030: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Overridable [element Custom]

Description

If "yes", the sequencing of this action may be overridden by sequencing elsewhere.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Custom

Definition

See Custom

1030

Page 1031: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Overridable [element Show]

Description

If "yes", the sequencing of this dialog may be overridden by sequencing elsewhere.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Show

Definition

See Show

1031

Page 1032: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Overridable [element WixVariable]

Description

Set this value to 'yes' in order to make the variable's value overridable either by another WixVariable entry orvia the command-line option -d<name>=<value> for light.exe.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element WixVariable

Remarks

If the same variable is declared overridable in multiple places it will cause an error (since WiX won't know whichvalue is correct). The default value is 'no'.

Definition

See WixVariable

1032

Page 1033: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Overridable [type ActionModuleSequenceType]

Description

If "yes", the sequencing of this action may be overridden by sequencing elsewhere.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Complex Type ActionModuleSequenceType

Definition

See ActionModuleSequenceType

1033

Page 1034: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Parent [element DirectorySearchRef]

Description

This attribute is the signature of the parent directory of the file or directory in the Signature_ column.

Derived By

Type string

Referenced By

● Element DirectorySearchRef

Remarks

If this field is null, and the Path column does not expand to a full path, then all the fixed drives of the user'ssystem are searched by using the Path. This field is a key into one of the following tables: the RegLocator, theIniLocator, the CompLocator, or the DrLocator tables.

Definition

See DirectorySearchRef

1034

Page 1035: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Part [element Environment]

Derived By

Restricting NMTOKEN

Enumeration

Value Description

all This value is the entire environmental variable. This is the default.

first This value is prefixed.

last This value is appended.

Referenced By

● Element Environment

Definition

See Environment

1035

Page 1036: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Password [element Control]

Description

This attribute is only valid for Edit Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1036

Page 1037: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Password [element ServiceInstall]

Description

The password for the account. Valid only when the account has a password.

Derived By

Type string

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

1037

Page 1038: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PatchAllowIgnoreOnError [element File]

Description

Set to indicate that the patch is non-vital.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

1038

Page 1039: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PatchFamily [element PatchSequence]

Description

Identifier which indicates a sequence family to which this patch belongs.

Derived By

Type string

Referenced By

● Element PatchSequence

Definition

See PatchSequence

1039

Page 1040: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PatchGroup [element File]

Description

This attribute must be set for patch-added files.

Derived By

Type integer

Referenced By

● Element File

Remarks

Each patch should be assigned a different patch group number. Patch groups numbers must be greater 0 andshould be assigned consecutively. For example, the first patch should use PatchGroup='1', the second patchwill have PatchGroup='2', etc...

Definition

See File

1040

Page 1041: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PatchIgnore [element File]

Description

Prevents the updating of the file that is in fact changed in the upgraded image relative to the target images.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

1041

Page 1042: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PatchUninstall [element CustomAction]

Description

This attribute specifies that the Windows Installer, execute the custom action only when a patch is beinguninstalled.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CustomAction

Remarks

These custom actions should also be conditioned using the MSIPATCHREMOVE property to ensure properdown level (less than Windows Installer 4.5) behavior.

Definition

See CustomAction

1042

Page 1043: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PatchWholeFile [element File]

Description

Set if the entire file should be installed rather than creating a binary patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

1043

Page 1044: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Path [element DirectorySearch]

Description

Path on the user's system. Either absolute, or relative to containing directories.

Derived By

Type string

Referenced By

● Element DirectorySearch

Definition

See DirectorySearch

1044

Page 1045: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Path [element DirectorySearchRef]

Description

Path on the user's system. Either absolute, or relative to containing directories.

Derived By

Type string

Referenced By

● Element DirectorySearchRef

Definition

See DirectorySearchRef

1045

Page 1046: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Path [element SymbolPath]

Description

The path.

Derived By

Type string

Referenced By

● Element SymbolPath

Definition

See SymbolPath

1046

Page 1047: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Permanent [element Component]

Description

If this attribute is set to 'yes', the installer does not remove the component during an uninstall.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

The installer registers an extra system client for the component in the Windows Installer registry settings (whichbasically just means that at least one product is always referencing this component). Note that this option differsfrom 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.

Definition

See Component

1047

Page 1048: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Permanent [element Environment]

Description

Specifies that the environment variable should not be removed on uninstall.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Environment

Definition

See Environment

1048

Page 1049: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Platform [element Package]

Description

The platform supported by the package.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

x86 Set this value to declare that the package is an x86 package.

ia64 Set this value to declare that the package is an ia64 package.

x64 Set this value to declare that the package is an x64 package.

intel Deprecated. Use "x86" instead.

intel64 Deprecated. Use "ia64" instead.

Referenced By

● Element Package

Definition

See Package

1049

Page 1050: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Platforms [element Package]

Derived By

Type string

Referenced By

● Element Package

Definition

See Package

1050

Page 1051: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Platforms [element PatchInformation]

Description

List of platforms supported in package

Derived By

Type string

Referenced By

● Element PatchInformation

Definition

See PatchInformation

1051

Page 1052: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Primary [element ComponentGroupRef]

Description

Set this attribute to 'yes' in order to make the parent feature of this component the primary feature for thiscomponent.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ComponentGroupRef

Remarks

Components may belong to multiple features. By designating a feature as the primary feature of a component,you ensure that whenever a component is selected for install-on-demand (IOD), the primary feature will be theone to install it. This attribute should only be set if a component actually nests under multiple features. If acomponent nests under only one feature, that feature is the primary feature for the component. You cannot setmore than one feature as the primary feature of a given component.

Definition

See ComponentGroupRef

1052

Page 1053: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Primary [element ComponentRef]

Description

Set this attribute to 'yes' in order to make the parent feature of this component the primary feature for thiscomponent.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ComponentRef

Remarks

Components may belong to multiple features. By designating a feature as the primary feature of a component,you ensure that whenever a component is selected for install-on-demand (IOD), the primary feature will be theone to install it. This attribute should only be set if a component actually nests under multiple features. If acomponent nests under only one feature, that feature is the primary feature for the component. You cannot setmore than one feature as the primary feature of a given component.

Definition

See ComponentRef

1053

Page 1054: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Primary [element FeatureGroupRef]

Description

Set this attribute to 'yes' in order to make the parent feature of this group the primary feature for anycomponents and merges contained in the group.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element FeatureGroupRef

Remarks

Features may belong to multiple features. By designating a feature as the primary feature of a component ormerge, you ensure that whenever a component is selected for install-on-demand (IOD), the primary feature willbe the one to install it. This attribute should only be set if a component actually nests under multiple features. Ifa component nests under only one feature, that feature is the primary feature for the component. You cannotset more than one feature as the primary feature of a given component.

Definition

See FeatureGroupRef

1054

Page 1055: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Primary [element MergeRef]

Description

Specifies whether the feature containing this MergeRef is the primary feature for advertising the mergemodule's components.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element MergeRef

Definition

See MergeRef

1055

Page 1056: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PrimaryKey [element Column]

Description

Whether this column is a primary key.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Column

Definition

See Column

1056

Page 1057: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProcessorArchitecture [element File]

Description

Specifies the architecture for this assembly.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

msil The file is a .NET Framework assembly that is processor-neutral.

x86 The file is a .NET Framework assembly for the x86 processor.

x64 The file is a .NET Framework assembly for the x64 processor.

ia64 The file is a .NET Framework assembly for the ia64 processor.

Referenced By

● Element File

Remarks

This attribute should only be used on .NET Framework 2.0 assemblies.

Definition

See File

1057

Page 1058: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductCode [element Instance]

Description

The ProductCode for this instance.

Derived By

Type string

Referenced By

● Element Instance

Definition

See Instance

1058

Page 1059: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductCode [element PatchFamily]

Description

Specifies the ProductCode of the product that this family applies to.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element PatchFamily

Definition

See PatchFamily

1059

Page 1060: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductCode [element PatchSequence]

Description

Specifies the ProductCode of the product that this family applies to.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element PatchSequence

Remarks

This attribute cannot the specified if the TargetImage attribute is specified.

Definition

See PatchSequence

1060

Page 1061: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductId [element Validate]

Description

Requires that the upgrade ProductCode match the target ProductCode.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

1061

Page 1062: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductLanguage [element Validate]

Description

Requires that the upgrade ProductLanguage match the target ProductLanguage.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'no'.

Definition

See Validate

1062

Page 1063: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductName [element Instance]

Description

The ProductName for this instance.

Derived By

Type string

Referenced By

● Element Instance

Definition

See Instance

1063

Page 1064: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductVersion [element Validate]

Description

Determines how many fields in the ProductVersion to check.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

Major Checks the major version.

Minor Checks the major and minor versions.

Update Checks the major, minor, and update versions.

Referenced By

● Element Validate

Remarks

The default is 'Update'.

Definition

See Validate

1064

Page 1065: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProductVersionOperator [element Validate]

Description

Determines how the target and upgrade ProductVersions are compared.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

Lesser Upgrade ProductVersion < target ProductVersion.

LesserOrEqual Upgrade ProductVersion <= target ProductVersion.

Equal Upgrade ProductVersion = target ProductVersion.

GreaterOrEqual Upgrade ProductVersion >= target ProductVersion.

Greater Upgrade ProductVersion > target ProductVersion.

Referenced By

● Element Validate

Remarks

The default is 'Equal'.

Definition

See Validate

1065

Page 1066: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Programmable [element Class]

Description

Specifies the CLSID may be programmable.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Definition

See Class

1066

Page 1067: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProgressBlocks [element Control]

Description

This attribute is only valid for ProgressBar Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1067

Page 1068: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element ComboBox]

Description

Property tied to this group

Derived By

Type string

Referenced By

● Element ComboBox

Definition

See ComboBox

1068

Page 1069: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element Control]

Description

The name of a defined property to be linked to this control.

Derived By

Type string

Referenced By

● Element Control

Remarks

This column is required for active controls.

Definition

See Control

1069

Page 1070: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element CustomAction]

Description

This attribute specifies a reference to a Property element with matching Id attribute that specifies the Propertyto be used or updated on execution of this custom action.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

This attribute is typically used with the Value attribute to create a type 51 custom action that parses the text inValue and places it into the specified Property. This attribute is also used with the ExeCommand attribute tocreate a type 50 custom action that uses the value of the given property to specify the path to the executable.Type 51 custom actions are often useful to pass values to a deferred custom action.

See http://msdn.microsoft.com/library/aa370543.aspx for more information.

Definition

See CustomAction

1070

Page 1071: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element CustomProperty]

Description

The name of the metadata property.

Derived By

Type string

Referenced By

● Element CustomProperty

Definition

See CustomProperty

1071

Page 1072: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element InstanceTransforms]

Description

The Id of the Property who's value should change for each instance.

Derived By

Type string

Referenced By

● Element InstanceTransforms

Definition

See InstanceTransforms

1072

Page 1073: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element ListBox]

Description

Property tied to this group

Derived By

Type string

Referenced By

● Element ListBox

Definition

See ListBox

1073

Page 1074: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element ListView]

Description

Property tied to this group

Derived By

Type string

Referenced By

● Element ListView

Definition

See ListView

1074

Page 1075: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element Publish]

Description

Set this attribute's value to a property name to set that property.

Derived By

Type string

Referenced By

● Element Publish

Remarks

Either this attribute or the Event attribute must be set, but not both at the same time.

Definition

See Publish

1075

Page 1076: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element RadioButtonGroup]

Description

Property tied to this group.

Derived By

Type string

Referenced By

● Element RadioButtonGroup

Definition

See RadioButtonGroup

1076

Page 1077: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element RemoveFile]

Description

Overrides the directory of the parent component with the value of the specified property.

Derived By

Type string

Referenced By

● Element RemoveFile

Remarks

The property should have a value that resolves to the full path of the source directory. The property does nothave to exist in the installer database at creation time; it could be created at installation time by a customaction, on the command line, etc. This attribute cannot be specified in conjunction with the Directory attribute.

Definition

See RemoveFile

1077

Page 1078: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element RemoveFolder]

Description

Overrides the directory of the parent component with the value of the specified property.

Derived By

Type string

Referenced By

● Element RemoveFolder

Remarks

The property should have a value that resolves to the full path of the source directory. The property does nothave to exist in the installer database at creation time; it could be created at installation time by a customaction, on the command line, etc. This attribute cannot be specified in conjunction with the Directory attribute.

Definition

See RemoveFolder

1078

Page 1079: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Property [element UpgradeVersion]

Description

When the FindRelatedProducts action detects a related product installed on the system, it appends the productcode to the property specified in this field.

Derived By

Type string

Referenced By

● Element UpgradeVersion

Remarks

Windows Installer documentation for the Upgrade table states that the property specified in this field must be apublic property and must be added to the SecureCustomProperties property. WiX automatically appends theproperty specified in this field to the SecureCustomProperties property when creating an MSI. EachUpgradeVersion must have a unique Property value. After the FindRelatedProducts action is run, the value ofthis property is a list product codes, separated by semicolons (;), detected on the system.

Definition

See UpgradeVersion

1079

Page 1080: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PropertySource [element EmbeddedChainer]

Description

Reference to a Property that resolves to the full path to the chainer executeable.

Derived By

Type string

Referenced By

● Element EmbeddedChainer

Remarks

Mutually exclusive with the BinarySource and FileSource attributes.

Definition

See EmbeddedChainer

1080

Page 1081: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProxyStubClassId [element Interface]

Description

GUID CLSID for proxy stub to COM Interface.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Interface

Definition

See Interface

1081

Page 1082: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ProxyStubClassId32 [element Interface]

Description

GUID CLSID for 32-bit proxy stub to COM Interface.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Interface

Definition

See Interface

1082

Page 1083: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: PushLike [element Control]

Description

This attribute is only valid for RadioButton and Checkbox Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1083

Page 1084: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Qualifier [element Category]

Description

A text string that qualifies the value in the Id attribute.

Derived By

Type string

Referenced By

● Element Category

Remarks

A qualifier is used to distinguish multiple forms of the same Component, such as a Component that isimplemented in multiple languages.

Definition

See Category

1084

Page 1085: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RAMDisk [element Control]

Description

This attribute is only valid for Volume and Directory Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1085

Page 1086: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Read [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1086

Page 1087: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ReadAttributes [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1087

Page 1088: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ReadExtendedAttributes [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1088

Page 1089: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ReadOnly [element File]

Description

Set to yes in order to have the file's read-only attribute set when it is installed on the target machine.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

1089

Page 1090: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ReadOnly [element Package]

Description

The value of this attribute conveys whether the package should be opened as read-only.

Derived By

Type YesNoDefaultType

Enumeration

Value Description

default

no

yes

Referenced By

● Element Package

Remarks

A database editing tool should not modify a read-only enforced database and should issue a warning atattempts to modify a read-only recommended database.

Definition

See Package

1090

Page 1091: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ReadOnly [element PatchInformation]

Description

The value of this attribute conveys whether the package should be opened as read-only.

Derived By

Type YesNoDefaultType

Enumeration

Value Description

default

no

yes

Referenced By

● Element PatchInformation

Remarks

A database editing tool should not modify a read-only enforced database and should issue a warning atattempts to modify a read-only recommended database.

Definition

See PatchInformation

1091

Page 1092: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ReadPermission [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1092

Page 1093: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Red [element TextStyle]

Description

0 to 255

Derived By

Type integer

Referenced By

● Element TextStyle

Definition

See TextStyle

1093

Page 1094: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Registration [element ODBCDataSource]

Description

Scope for which the data source should be registered.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

machine Data source is registered per machine.

user Data source is registered per user.

Referenced By

● Element ODBCDataSource

Definition

See ODBCDataSource

1094

Page 1095: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RelativePath [element Class]

Description

When the value is "yes", the bare file name can be used for COM servers.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Remarks

The installer registers the file name only instead of the complete path. This enables the server in the currentdirectory to take precedence and allows multiple copies of the same component.

Definition

See Class

1095

Page 1096: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Remote [element Control]

Description

This attribute is only valid for Volume and Directory Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1096

Page 1097: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RemoteServerName [element AppId]

Description

Set this value to the name of the remote server to configure the client to request the object be run at a particularmachine whenever an activation function is called for which a COSERVERINFO structure is not specified.

Derived By

Type string

Referenced By

● Element AppId

Definition

See AppId

1097

Page 1098: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Removable [element Control]

Description

This attribute is only valid for Volume and Directory Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1098

Page 1099: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Remove [element ServiceControl]

Description

Specifies whether the service should be removed on install, uninstall or both.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

install The service will be deleted by the DeleteServices action during install.

uninstall The service will be deleted by the DeleteServices action duringuninstall.

both The service will be deleted by the DeleteServices action during installand uninstall.

Referenced By

● Element ServiceControl

Definition

See ServiceControl

1099

Page 1100: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RemoveFeatures [element UpgradeVersion]

Description

The installer sets the REMOVE property to features specified in this column.

Derived By

Type string

Referenced By

● Element UpgradeVersion

Remarks

The features to be removed can be determined at run time. The Formatted string entered in this field mustevaluate to a comma-delimited list of feature names. For example: [Feature1],[Feature2],[Feature3]. Nofeatures are removed if the field contains formatted text that evaluates to an empty string. The installer setsREMOVE=ALL only if the Remove field is empty.

Definition

See UpgradeVersion

1100

Page 1101: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RequiredId [element Dependency]

Description

Identifier of the merge module required by the merge module.

Derived By

Type string

Referenced By

● Element Dependency

Definition

See Dependency

1101

Page 1102: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RequiredLanguage [element Dependency]

Description

Numeric language ID of the merge module in RequiredID.

Derived By

Type integer

Referenced By

● Element Dependency

Definition

See Dependency

1102

Page 1103: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RequiredVersion [element Dependency]

Description

Version of the merge module in RequiredID.

Derived By

Type string

Referenced By

● Element Dependency

Definition

See Dependency

1103

Page 1104: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RequiredVersion [element Wix]

Description

Required version of the WiX toolset to compile this input file.

Derived By

Type VersionType

Restrictions

● Value must match the following pattern: (\d{1,5}\.){3}\d{1,5}

Referenced By

● Element Wix

Definition

See Wix

1104

Page 1105: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ResourceId [element TypeLib]

Description

The resource id of a typelib.

Derived By

Type integer

Referenced By

● Element TypeLib

Remarks

The value is appended to the end of the typelib path in the registry.

Definition

See TypeLib

1105

Page 1106: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Restricted [element TypeLib]

Description

Value of 'yes' means the type library is restricted, and should not be displayed to users.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TypeLib

Remarks

This attribute can only be set if Advertise='no'.

Definition

See TypeLib

1106

Page 1107: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Return [element CustomAction]

Description

Set this attribute to set the return behavior of the custom action.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

asyncNoWait Indicates that the custom action will run asyncronously and executionmay continue after the installer terminates.

asyncWait Indicates that the custom action will run asynchronously but theinstaller will wait for the return code at sequence end.

check Indicates that the custom action will run synchronously and the returncode will be checked for success. This is the default.

ignore Indicates that the custom action will run synchronously and the returncode will not be checked.

Referenced By

● Element CustomAction

Definition

See CustomAction

1107

Page 1108: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RightAligned [element Control]

Description

Set this attribute to "yes" to cause the Control to be right aligned.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1108

Page 1109: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RightAligned [element Dialog]

Description

Align text on the right.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

1109

Page 1110: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RightToLeft [element Control]

Description

Set this attribute to "yes" to cause the Control to display from right to left.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1110

Page 1111: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RightToLeft [element Dialog]

Description

Used to specify if the text in the dialog should be displayed in right to left reading order.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

1111

Page 1112: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Root [element Registry]

Description

The predefined root key for the registry value.

Derived By

Type RegistryRootType

Enumeration

Value Description

HKMU A per-user installation will make the operation occur underHKEY_CURRENT_USER.A per-machine installation will make the operation occur underHKEY_LOCAL_MACHINE.

HKCR Operation occurs under HKEY_CLASSES_ROOT. When usingWindows 2000 or later, the installer writes or removes the valuefrom the HKCU\Software\Classes hive during per-user installations.When using Windows 2000 or later operating systems,the installer writes or removes the value from theHKLM\Software\Classes hive during per-machine installations.

HKCU Operation occurs under HKEY_CURRENT_USER. It is recommendedto set the KeyPath='yes' attribute when setting this value for writingvaluesin order to ensure that the installer writes the necessary registry entrieswhen there are multiple users on the same computer.

HKLM Operation occurs under HKEY_LOCAL_MACHINE.

HKU Operation occurs under HKEY_USERS.

Referenced By

● Element Registry

Definition

See Registry

1112

Page 1113: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Root [element RegistryKey]

Description

The predefined root key for the registry value.

Derived By

Type RegistryRootType

Enumeration

Value Description

HKMU A per-user installation will make the operation occur underHKEY_CURRENT_USER.A per-machine installation will make the operation occur underHKEY_LOCAL_MACHINE.

HKCR Operation occurs under HKEY_CLASSES_ROOT. When usingWindows 2000 or later, the installer writes or removes the valuefrom the HKCU\Software\Classes hive during per-user installations.When using Windows 2000 or later operating systems,the installer writes or removes the value from theHKLM\Software\Classes hive during per-machine installations.

HKCU Operation occurs under HKEY_CURRENT_USER. It is recommendedto set the KeyPath='yes' attribute when setting this value for writingvaluesin order to ensure that the installer writes the necessary registry entrieswhen there are multiple users on the same computer.

HKLM Operation occurs under HKEY_LOCAL_MACHINE.

HKU Operation occurs under HKEY_USERS.

Referenced By

● Element RegistryKey

Definition

See RegistryKey

1113

Page 1114: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Root [element RegistrySearch]

Description

Root key for the registry value.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

HKCR HKEY_CLASSES_ROOT

HKCU HKEY_CURRENT_USER

HKLM HKEY_LOCAL_MACHINE

HKU HKEY_USERS

Referenced By

● Element RegistrySearch

Definition

See RegistrySearch

1114

Page 1115: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Root [element RegistryValue]

Description

The predefined root key for the registry value.

Derived By

Type RegistryRootType

Enumeration

Value Description

HKMU A per-user installation will make the operation occur underHKEY_CURRENT_USER.A per-machine installation will make the operation occur underHKEY_LOCAL_MACHINE.

HKCR Operation occurs under HKEY_CLASSES_ROOT. When usingWindows 2000 or later, the installer writes or removes the valuefrom the HKCU\Software\Classes hive during per-user installations.When using Windows 2000 or later operating systems,the installer writes or removes the value from theHKLM\Software\Classes hive during per-machine installations.

HKCU Operation occurs under HKEY_CURRENT_USER. It is recommendedto set the KeyPath='yes' attribute when setting this value for writingvaluesin order to ensure that the installer writes the necessary registry entrieswhen there are multiple users on the same computer.

HKLM Operation occurs under HKEY_LOCAL_MACHINE.

HKU Operation occurs under HKEY_USERS.

Referenced By

● Element RegistryValue

Definition

See RegistryValue

1115

Page 1116: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Root [element RemoveRegistryKey]

Description

The predefined root key for the registry value.

Derived By

Type RegistryRootType

Enumeration

Value Description

HKMU A per-user installation will make the operation occur underHKEY_CURRENT_USER.A per-machine installation will make the operation occur underHKEY_LOCAL_MACHINE.

HKCR Operation occurs under HKEY_CLASSES_ROOT. When usingWindows 2000 or later, the installer writes or removes the valuefrom the HKCU\Software\Classes hive during per-user installations.When using Windows 2000 or later operating systems,the installer writes or removes the value from theHKLM\Software\Classes hive during per-machine installations.

HKCU Operation occurs under HKEY_CURRENT_USER. It is recommendedto set the KeyPath='yes' attribute when setting this value for writingvaluesin order to ensure that the installer writes the necessary registry entrieswhen there are multiple users on the same computer.

HKLM Operation occurs under HKEY_LOCAL_MACHINE.

HKU Operation occurs under HKEY_USERS.

Referenced By

● Element RemoveRegistryKey

Definition

See RemoveRegistryKey

1116

Page 1117: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Root [element RemoveRegistryValue]

Description

The predefined root key for the registry value.

Derived By

Type RegistryRootType

Enumeration

Value Description

HKMU A per-user installation will make the operation occur underHKEY_CURRENT_USER.A per-machine installation will make the operation occur underHKEY_LOCAL_MACHINE.

HKCR Operation occurs under HKEY_CLASSES_ROOT. When usingWindows 2000 or later, the installer writes or removes the valuefrom the HKCU\Software\Classes hive during per-user installations.When using Windows 2000 or later operating systems,the installer writes or removes the value from theHKLM\Software\Classes hive during per-machine installations.

HKCU Operation occurs under HKEY_CURRENT_USER. It is recommendedto set the KeyPath='yes' attribute when setting this value for writingvaluesin order to ensure that the installer writes the necessary registry entrieswhen there are multiple users on the same computer.

HKLM Operation occurs under HKEY_LOCAL_MACHINE.

HKU Operation occurs under HKEY_USERS.

Referenced By

● Element RemoveRegistryValue

Definition

See RemoveRegistryValue

1117

Page 1118: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Row [element Substitution]

Description

Specifies the primary keys of the target row in the table named in the Table column.

Derived By

Type string

Referenced By

● Element Substitution

Remarks

If multiple keys, separated by semicolons.

Definition

See Substitution

1118

Page 1119: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RunAsInteractiveUser [element AppId]

Description

Set this value to 'yes' to configure a class to run under the identity of the user currently logged on andconnected to the interactive desktop when activated by a remote client without being written as a Win32service.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element AppId

Definition

See AppId

1119

Page 1120: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RunFromSource [element ReserveCost]

Description

The number of bytes of disk space to reserve if the component is installed to run from source.

Derived By

Type integer

Referenced By

● Element ReserveCost

Definition

See ReserveCost

1120

Page 1121: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: RunLocal [element ReserveCost]

Description

The number of bytes of disk space to reserve if the component is installed to run locally.

Derived By

Type integer

Referenced By

● Element ReserveCost

Definition

See ReserveCost

1121

Page 1122: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SafeForInitializing [element Class]

Description

May only be specified if the value of the Advertise attribute is "no".

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Definition

See Class

1122

Page 1123: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SafeForScripting [element Class]

Description

May only be specified if the value of the Advertise attribute is "no".

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Definition

See Class

1123

Page 1124: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Script [element CustomAction]

Description

Creates a type 37 or 38 custom action.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

jscript

vbscript

Referenced By

● Element CustomAction

Remarks

The text of the element should contain the script to be embedded in the package.

Definition

See CustomAction

1124

Page 1125: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Section [element IniFile]

Description

The localizable .ini file section.

Derived By

Type string

Referenced By

● Element IniFile

Definition

See IniFile

1125

Page 1126: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Section [element IniFileSearch]

Description

The localizable .ini file section.

Derived By

Type string

Referenced By

● Element IniFileSearch

Definition

See IniFileSearch

1126

Page 1127: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Secure [element Property]

Description

Denotes that the Property can be passed to the server side when doing a managed installation with elevatedprivileges.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Property

Remarks

See the SecureCustomProperties Property for more information.

Definition

See Property

1127

Page 1128: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SelfRegCost [element File]

Description

The cost of registering the file in bytes.

Derived By

Type integer

Referenced By

● Element File

Remarks

This must be a non-negative number. Including this attribute will cause an entry to be generated for the file inthe SelfReg table.

Definition

See File

1128

Page 1129: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Separator [element Environment]

Description

Optional attribute to change the separator used between values.

Derived By

Type string

Referenced By

● Element Environment

Remarks

By default a semicolon is used.

Definition

See Environment

1129

Page 1130: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [element Custom]

Description

The sequence number for this action.

Derived By

Type integer

Referenced By

● Element Custom

Remarks

Mutually exclusive with Before, After, and OnExit attributes

Definition

See Custom

1130

Page 1131: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [element PatchSequence]

Description

Used to populate the sequence column of the MsiPatchSequence table in the final MSP file.

Derived By

Type string

Referenced By

● Element PatchSequence

Remarks

Specified in x.x.x.x format. See documentation for Sequence column of MsiPatchSequence table in MSI SDK.

Definition

See PatchSequence

1131

Page 1132: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [element SetDirectory]

Description

Controls which sequences the Directory assignment is sequenced in.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

both Schedules the assignment in the InstallUISequence and theInstallExecuteSequence.

execute Schedules the assignment only in the the InstallExecuteSequence.

ui Schedules the assignment only in the the InstallUISequence.

Referenced By

● Element SetDirectory

Remarks

The default is both.

Definition

See SetDirectory

1132

Page 1133: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [element SetProperty]

Description

Controls which sequences the Property assignment is sequenced in.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

both Schedules the assignment in the InstallUISequence and theInstallExecuteSequence.

execute Schedules the assignment only in the the InstallExecuteSequence.

ui Schedules the assignment only in the the InstallUISequence.

Referenced By

● Element SetProperty

Remarks

The default is both.

Definition

See SetProperty

1133

Page 1134: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [element Show]

Derived By

Type integer

Referenced By

● Element Show

Definition

See Show

1134

Page 1135: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [element Verb]

Description

The sequence of the commands.

Derived By

Type integer

Referenced By

● Element Verb

Remarks

Only verbs for which the Sequence is specified are used to prepare an ordered list for the default value of theshell key. The Verb with the lowest value in this column becomes the default verb. Used only for Advertisedverbs.

Definition

See Verb

1135

Page 1136: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [type ActionModuleSequenceType]

Description

A value used to indicate the position of this action in a sequence.

Derived By

Type integer

Referenced By

● Complex Type ActionModuleSequenceType

Definition

See ActionModuleSequenceType

1136

Page 1137: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sequence [type ActionSequenceType]

Description

A value used to indicate the position of this action in a sequence.

Derived By

Type integer

Referenced By

● Complex Type ActionSequenceType

Definition

See ActionSequenceType

1137

Page 1138: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SequenceStart [element Family]

Description

Sequence number for the starting file.

Derived By

Type int

Referenced By

● Element Family

Definition

See Family

1138

Page 1139: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Server [element Class]

Description

May only be specified if the value of the Advertise attribute is "no".

Derived By

Type string

Referenced By

● Element Class

Remarks

File Id of the COM server file. If this element is nested under a File element, this value defaults to the value ofthe parent File/@Id.

Definition

See Class

1139

Page 1140: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ServiceParameters [element AppId]

Description

Set this value to the parameters to be passed to a LocalService on invocation.

Derived By

Type string

Referenced By

● Element AppId

Definition

See AppId

1140

Page 1141: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Set [element Column]

Description

Semicolon delimited list of permissible values.

Derived By

Type string

Referenced By

● Element Column

Definition

See Column

1141

Page 1142: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SetupFile [element ODBCDriver]

Description

Required if not found as child of File element or different from File attribute above

Derived By

Type string

Referenced By

● Element ODBCDriver

Definition

See ODBCDriver

1142

Page 1143: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SetupFile [element ODBCTranslator]

Description

Required if not found as child of File element or different from File attribute above

Derived By

Type string

Referenced By

● Element ODBCTranslator

Definition

See ODBCTranslator

1143

Page 1144: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Shared [element Component]

Description

If this attribute's value is set to 'yes', enables advanced patching semantics for Components that are sharedacross multiple Products.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

Specifically, the Windows Installer will cache the shared files to improve patch uninstall. This functionality isavailable in Windows Installer 4.5 and later.

Definition

See Component

1144

Page 1145: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Shared [element IsolateComponent]

Description

Shared Component for this application Component.

Derived By

Type string

Referenced By

● Element IsolateComponent

Definition

See IsolateComponent

1145

Page 1146: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SharedDllRefCount [element Component]

Description

If this attribute's value is set to 'yes', the installer increments the reference count in the shared DLL registry ofthe component's key file.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

If this bit is not set, the installer increments the reference count only if the reference count already exists.

Definition

See Component

1146

Page 1147: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element Directory]

Description

The short name of the directory in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Directory

Remarks

This attribute should only be set if there is a conflict between generated short directory names or the user wantsto manually specify the short directory name.

Definition

See Directory

1147

Page 1148: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element File]

Description

The short file name of the file in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element File

Remarks

This attribute should only be set if there is a conflict between generated short file names or the user wants tomanually specify the short file name.

Definition

See File

1148

Page 1149: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element FileSearch]

Description

The short file name of the file in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element FileSearch

Remarks

There is a Windows Installer bug which prevents the FileSearch functionality from working if both a short andlong file name are specified. Since the Name attribute allows either a short or long name to be specified, it isthe only attribute related to file names which should be specified.

Definition

See FileSearch

1149

Page 1150: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element IniFile]

Description

The short name of the in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element IniFile

Remarks

This attribute should only be set if there is a conflict between generated short names or the user wants tomanually specify the short name.

Definition

See IniFile

1150

Page 1151: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element IniFileSearch]

Description

The short name of the file in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element IniFileSearch

Remarks

This attribute should only be set if the user wants to manually specify the short name.

Definition

See IniFileSearch

1151

Page 1152: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element RemoveFile]

Description

The short file name of the file in 8.3 format.

Derived By

Type WildCardShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\

Referenced By

● Element RemoveFile

Remarks

This attribute should only be set if you want to manually specify the short file name.

Definition

See RemoveFile

1152

Page 1153: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortName [element Shortcut]

Description

The short name of the shortcut in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Shortcut

Remarks

This attribute should only be set if there is a conflict between generated short names or the user wants tomanually specify the short name.

Definition

See Shortcut

1153

Page 1154: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortNames [element Package]

Description

Set to 'yes' to have short filenames in the source.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Package

Definition

See Package

1154

Page 1155: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortNames [element PatchInformation]

Description

Short filenames on source

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchInformation

Definition

See PatchInformation

1155

Page 1156: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortPath [element Class]

Description

Specifies whether or not to use the short path for the COM server.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Class

Remarks

This can only apply when Adverstise is set to 'no'. The default is 'no' meaning that it will use the long file namefor the COM server.

Definition

See Class

1156

Page 1157: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShortSourceName [element Directory]

Description

The short name of the directory on the source media in 8.3 format.

Derived By

Type ShortFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Directory

Remarks

This attribute should only be set if there is a conflict between generated short directory names or the user wantsto manually specify the short source directory name.

Definition

See Directory

1157

Page 1158: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Show [element Shortcut]

Derived By

Restricting NMTOKEN

Enumeration

Value Description

normal The shortcut target will be displayed using the SW_SHOWNORMALattribute.

minimized The shortcut target will be displayed using theSW_SHOWMINNOACTIVE attribute.

maximized The shortcut target will be displayed using the SW_SHOWMAXIMIZEDattribute.

Referenced By

● Element Shortcut

Definition

See Shortcut

1158

Page 1159: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ShowRollbackCost [element Control]

Description

This attribute is only valid for VolumeCostList Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1159

Page 1160: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Size [element TextStyle]

Derived By

Type string

Referenced By

● Element TextStyle

Definition

See TextStyle

1160

Page 1161: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SkipAssignment [element OptimizeCustomActions]

Description

Skip property (type 51) and directory (type 35) assignment custom actions.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element OptimizeCustomActions

Definition

See OptimizeCustomActions

1161

Page 1162: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SkipDeferred [element OptimizeCustomActions]

Description

Skip custom actions that run within the script.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element OptimizeCustomActions

Definition

See OptimizeCustomActions

1162

Page 1163: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SkipImmediate [element OptimizeCustomActions]

Description

Skip immediate custom actions that are not property or directory assignment custom actions.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element OptimizeCustomActions

Definition

See OptimizeCustomActions

1163

Page 1164: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sorted [element Control]

Description

This attribute is only valid for Listbox, ListView, and ComboBox Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Remarks

Set the value of this attribute to "yes" to have entries appear in the order specified under the Control. If theattribute value is "no" or absent the entries in the control will appear in alphabetical order.

Definition

See Control

1164

Page 1165: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Source [element ExternalFile]

Description

Full path of the external file.

Derived By

Type string

Referenced By

● Element ExternalFile

Definition

See ExternalFile

1165

Page 1166: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Source [element File]

Description

Specifies the path to the File in the build process.

Derived By

Type string

Referenced By

● Element File

Remarks

This attribute must be set if no source information can be gathered from parent directories.

Definition

See File

1166

Page 1167: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Source [element Media]

Description

Optional property that identifies the source of the embedded cabinet.

Derived By

Type string

Referenced By

● Element Media

Remarks

If a cabinet is specified for a patch, this property should be defined and unique to each patch so that theembedded cabinet containing patched and new files can be located in the patch package. If the cabinet is notembedded - this is not typical - the cabinet can be found in the directory referenced in this column. If empty, theexternal cabinet must be located in the SourceDir directory.

Definition

See Media

1167

Page 1168: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceDirectory [element CopyFile]

Description

This attribute cannot be specified if the element is nested under a File element or the FileId attribute isspecified.

Derived By

Type string

Referenced By

● Element CopyFile

Remarks

Set this value to the source directory from which to copy or move an existing file on the target machine. ThisDirectory must exist in the installer database at creation time. This attribute cannot be specified in conjunctionwith SourceProperty.

Definition

See CopyFile

1168

Page 1169: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element Binary]

Description

Path to the binary file.

Derived By

Type string

Referenced By

● Element Binary

Definition

See Binary

1169

Page 1170: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element DigitalCertificate]

Description

The path to the certificate file.

Derived By

Type string

Referenced By

● Element DigitalCertificate

Definition

See DigitalCertificate

1170

Page 1171: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element DigitalSignature]

Description

The path to signature's optional hash file.

Derived By

Type string

Referenced By

● Element DigitalSignature

Definition

See DigitalSignature

1171

Page 1172: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element EmbeddedUI]

Description

Path to the binary file that is the embedded UI.

Derived By

Type string

Referenced By

● Element EmbeddedUI

Remarks

This must be a DLL that exports the following three entry points: InitializeEmbeddedUI, EmbeddedUIHandlerand ShutdownEmbeddedUI.

Definition

See EmbeddedUI

1172

Page 1173: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element EmbeddedUIResource]

Description

Path to the binary file that is the embedded UI resource.

Derived By

Type string

Referenced By

● Element EmbeddedUIResource

Definition

See EmbeddedUIResource

1173

Page 1174: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element Icon]

Description

Path to the icon file.

Derived By

Type string

Referenced By

● Element Icon

Definition

See Icon

1174

Page 1175: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element Merge]

Description

Path to the source location of the merge module.

Derived By

Type string

Referenced By

● Element Merge

Definition

See Merge

1175

Page 1176: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element SFPCatalog]

Description

Path to catalog file in binary.

Derived By

Type string

Referenced By

● Element SFPCatalog

Definition

See SFPCatalog

1176

Page 1177: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element TargetImage]

Description

Full path to the location of the msi file for the target image.

Derived By

Type string

Referenced By

● Element TargetImage

Definition

See TargetImage

1177

Page 1178: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element Text]

Description

Instructs the text to be imported from a file instead of the element value during the binding process.

Derived By

Type string

Referenced By

● Element Text

Definition

See Text

1178

Page 1179: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceFile [element UpgradeImage]

Description

Full path to location of msi file for upgraded image.

Derived By

Type string

Referenced By

● Element UpgradeImage

Definition

See UpgradeImage

1179

Page 1180: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceList [element PatchCreation]

Description

Used to locate the .msp file for the patch if the cached copy is unavailable.

Derived By

Type string

Referenced By

● Element PatchCreation

Remarks

See PatchSourceList for more information.

Definition

See PatchCreation

1180

Page 1181: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceName [element CopyFile]

Description

This attribute cannot be specified if the element is nested under a File element or the FileId attribute isspecified.

Derived By

Type WildCardLongFileNameType

Restrictions

● Value must match the following pattern: [^\\\

Referenced By

● Element CopyFile

Remarks

Set this value to the localizable name of the file(s) to be copied or moved. All of the files that match the wildcard will be removed from the specified directory. The value is a filename that may also contain the wild cardcharacters "?" for any single character or "*" for zero or more occurrences of any character. If this attribute isnot specified (and this element is not nested under a File element or specify a FileId attribute) then theSourceProperty attribute should be set to the name of a property that will resolve to the full path of the sourcefilename. If the value of this attribute contains a "*" wildcard and the DestinationName attribute is specified, allmoved or copied files retain the file names from their sources.

Definition

See CopyFile

1181

Page 1182: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceName [element Directory]

Description

The name of the directory on the source media.

Derived By

Type LongFileNameType

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Element Directory

Remarks

If this attribute is note specified, the Windows Installer will default to the Name attribute. In prior versions of theWiX toolset, this attribute specified the short source directory name. This attribute's value may now be either ashort or long directory name. If a short directory name is specified, the ShortSourceName attribute may not bespecified. If a long directory name is specified, the LongSource attribute may not be specified. Also, if this valueis a long directory name, the ShortSourceName attribute may be omitted to allow WiX to attempt to generate aunique short directory name. However, if this name collides with another directory or you wish to manuallyspecify the short directory name, then the ShortSourceName attribute may be specified.

Definition

See Directory

1182

Page 1183: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourcePatch [element UpgradeImage]

Description

Modified copy of the upgraded installation database that contains additional authoring specific to patching.

Derived By

Type string

Referenced By

● Element UpgradeImage

Definition

See UpgradeImage

1183

Page 1184: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SourceProperty [element CopyFile]

Description

This attribute cannot be specified if the element is nested under a File element or the FileId attribute isspecified.

Derived By

Type string

Referenced By

● Element CopyFile

Remarks

Set this value to a property that will have a value that resolves to the full path of the source directory (or full pathincluding file name if SourceName is not specified). The property does not have to exist in the installerdatabase at creation time; it could be created at installation time by a custom action, on the command line, etc.This attribute cannot be specified in conjunction with SourceDirectory.

Definition

See CopyFile

1184

Page 1185: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element Binary]

Derived By

Type string

Referenced By

● Element Binary

Definition

See Binary

1185

Page 1186: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element Directory]

Derived By

Type string

Referenced By

● Element Directory

Definition

See Directory

1186

Page 1187: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element DirectoryRef]

Derived By

Type string

Referenced By

● Element DirectoryRef

Definition

See DirectoryRef

1187

Page 1188: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element ExternalFile]

Derived By

Type string

Referenced By

● Element ExternalFile

Definition

See ExternalFile

1188

Page 1189: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element File]

Derived By

Type string

Referenced By

● Element File

Definition

See File

1189

Page 1190: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element Icon]

Derived By

Type string

Referenced By

● Element Icon

Definition

See Icon

1190

Page 1191: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element Media]

Derived By

Type string

Referenced By

● Element Media

Definition

See Media

1191

Page 1192: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element Merge]

Derived By

Type string

Referenced By

● Element Merge

Definition

See Merge

1192

Page 1193: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element TargetImage]

Derived By

Type string

Referenced By

● Element TargetImage

Definition

See TargetImage

1193

Page 1194: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element Text]

Derived By

Type string

Referenced By

● Element Text

Definition

See Text

1194

Page 1195: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: src [element UpgradeImage]

Derived By

Type string

Referenced By

● Element UpgradeImage

Definition

See UpgradeImage

1195

Page 1196: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: srcPatch [element UpgradeImage]

Derived By

Type string

Referenced By

● Element UpgradeImage

Definition

See UpgradeImage

1196

Page 1197: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Start [element ServiceControl]

Description

Specifies whether the service should be started on install, uninstall or both.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

install The service will be started by the StartServices action during install.

uninstall The service will be started by the StartServices action during uninstall.

both The service will be started by the StartServices action during installand uninstall.

Referenced By

● Element ServiceControl

Definition

See ServiceControl

1197

Page 1198: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Start [element ServiceInstall]

Description

Determines when the service should be started.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

auto The service will start during startup of the system.

demand The service will start when the service control manager calls theStartService function.

disabled The service can no longer be started.

boot The service is a device driver that will be started by the operatingsystem boot loader. This value is not currently supported by theWindows Installer.

system The service is a device driver that will be started by the IoInitSystemfunction. This value is not currently supported by the WindowsInstaller.

Referenced By

● Element ServiceInstall

Remarks

The Windows Installer does not support boot or system.

Definition

See ServiceInstall

1198

Page 1199: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Stop [element ServiceControl]

Description

Specifies whether the service should be stopped on install, uninstall or both.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

install The service will be stopped by the StopServices action during install.

uninstall The service will be stopped by the StopServices action during uninstall.

both The service will be stopped by the StopServices action during installand uninstall.

Referenced By

● Element ServiceControl

Definition

See ServiceControl

1199

Page 1200: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Strike [element TextStyle]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TextStyle

Definition

See TextStyle

1200

Page 1201: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SummaryCodepage [element Package]

Description

The code page integer value or web name for summary info strings only.

Derived By

Type string

Referenced By

● Element Package

Remarks

See remarks for more information.

Definition

See Package

1201

Page 1202: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SummaryCodepage [element PatchInformation]

Description

The code page integer value or web name for summary info strings only.

Derived By

Type string

Referenced By

● Element PatchInformation

Remarks

See remarks for more information.

Definition

See PatchInformation

1202

Page 1203: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Sunken [element Control]

Description

Set this attribute to "yes" to cause the Control to be sunken.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1203

Page 1204: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Supersede [element PatchFamily]

Description

Set this value to 'yes' to indicate that this patch will supersede all previous patches in this patch family.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchFamily

Remarks

The default value is 'no'.

Definition

See PatchFamily

1204

Page 1205: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Supersede [element PatchSequence]

Description

Set this value to 'yes' to indicate that this patch will supersede all previous patches in this patch family.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchSequence

Remarks

The default value is 'no'.

Definition

See PatchSequence

1205

Page 1206: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SupportBasicUI [element EmbeddedUI]

Description

Set yes to allow the Windows Installer to display the embedded UI during basic UI level installation.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element EmbeddedUI

Definition

See EmbeddedUI

1206

Page 1207: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Suppress [type ActionModuleSequenceType]

Description

If yes, this action will not occur.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Complex Type ActionModuleSequenceType

Definition

See ActionModuleSequenceType

1207

Page 1208: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Suppress [type ActionSequenceType]

Description

If yes, this action will not occur.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Complex Type ActionSequenceType

Definition

See ActionSequenceType

1208

Page 1209: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SuppressModularization [element Binary]

Description

Use to suppress modularization of this Binary identifier in merge modules.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Binary

Definition

See Binary

1209

Page 1210: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SuppressModularization [element CustomAction]

Description

Use to suppress modularization of this custom action name in merge modules.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CustomAction

Remarks

This should only be necessary for table-driven custom actions because the table name which they interact withcannot be modularized, so there can only be one instance of the table.

Definition

See CustomAction

1210

Page 1211: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SuppressModularization [element Property]

Description

Use to suppress modularization of this property identifier in merge modules.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Property

Remarks

Using this functionality is strongly discouraged; it should only be necessary as a workaround of last resort inrare scenarios.

Definition

See Property

1211

Page 1212: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SymbolFlags [element PatchCreation]

Description

An 8-digit hex integer representing the combination of patch symbol usage flags to use when creating a binaryfile patch.

Derived By

Type int

Referenced By

● Element PatchCreation

Remarks

See ApiPatchingSymbolFlags for more information.

Definition

See PatchCreation

1212

Page 1213: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Synchronize [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1213

Page 1214: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: System [element Environment]

Description

Specifies that the environment variable should be added to the system environment space.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Environment

Remarks

The default is 'no' which indicates the environment variable is added to the user environment space.

Definition

See Environment

1214

Page 1215: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: System [element File]

Description

Set to yes in order to have the file's system attribute set when it is installed on the target machine.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Definition

See File

1215

Page 1216: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: SystemModal [element Dialog]

Description

Used to set the dialog as system modal.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

1216

Page 1217: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Table [element Substitution]

Description

Specifies the name of the table being modified in the module database.

Derived By

Type string

Referenced By

● Element Substitution

Definition

See Substitution

1217

Page 1218: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TabSkip [element Control]

Description

Set this attribute to "yes" to cause this Control to be skipped in the tab sequence.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1218

Page 1219: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TakeOwnership [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1219

Page 1220: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Target [element PatchSequence]

Derived By

Type string

Referenced By

● Element PatchSequence

Definition

See PatchSequence

1220

Page 1221: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Target [element Shortcut]

Description

This attribute can only be set if this Shortcut element is nested under a Component element.

Derived By

Type string

Referenced By

● Element Shortcut

Remarks

When nested under a Component element, this attribute's value will default to the parent directory. Thisattribute's value is the target for a non-advertised shortcut. This attribute is not valid for advertised shortcuts. Ifyou specify this value, its value should be a property identifier enclosed by square brackets ([ ]), that isexpanded into the file or a folder pointed to by the shortcut.

Definition

See Shortcut

1221

Page 1222: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Target [element Verb]

Derived By

Type string

Referenced By

● Element Verb

Definition

See Verb

1222

Page 1223: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TargetFile [element Verb]

Description

Either this attribute or the TargetProperty attribute must be specified for a non-advertised verb.

Derived By

Type string

Referenced By

● Element Verb

Remarks

The value should be the identifier of the target file to be executed for the verb.

Definition

See Verb

1223

Page 1224: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TargetImage [element PatchSequence]

Description

Specifies the TargetImage that this family applies to.

Derived By

Type string

Referenced By

● Element PatchSequence

Remarks

This attribute cannot the specified if the ProductCode attribute is specified.

Definition

See PatchSequence

1224

Page 1225: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TargetProductName [element Patch]

Description

Name of the application or target product suite.

Derived By

Type string

Referenced By

● Element Patch

Definition

See Patch

1225

Page 1226: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TargetProductName [element PatchMetadata]

Description

Name of the application or target product suite.

Derived By

Type string

Referenced By

● Element PatchMetadata

Definition

See PatchMetadata

1226

Page 1227: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TargetProperty [element Verb]

Description

Either this attribute or the TargetFile attribute must be specified for a non-advertised verb.

Derived By

Type string

Referenced By

● Element Verb

Remarks

The value should be the identifier of the property which will resolve to the path to the target file to be executedfor the verb.

Definition

See Verb

1227

Page 1228: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Template [element ProgressText]

Description

used to format ActionData messages from action processing

Derived By

Type string

Referenced By

● Element ProgressText

Definition

See ProgressText

1228

Page 1229: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TerminalServerAware [element CustomAction]

Description

This attribute specifies controls whether the custom action will impersonate the installing user duringper-machine installs on Terminal Server machines.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CustomAction

Remarks

Deferred execution custom actions that do not specify this attribute, or explicitly set it 'no', will run with no userimpersonation on Terminal Server machines during per-machine installations. This attribute is only applicablewhen installing on the Windows Server 2003 family.

Definition

See CustomAction

1229

Page 1230: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Text [element Control]

Description

A localizable string used to set the initial text contained in a control.

Derived By

Type string

Referenced By

● Element Control

Remarks

This attribute can contain a formatted string that is processed at install time to insert the values of propertiesusing [PropertyName] syntax. Also supported are environment variables, file installation paths, and componentinstallation directories; see Formatted for details.

Definition

See Control

1230

Page 1231: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Text [element ListItem]

Description

The localizable, visible text to be assigned to the item.

Derived By

Type string

Referenced By

● Element ListItem

Remarks

If not specified, this will default to the value of the Value attribute.

Definition

See ListItem

1231

Page 1232: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Text [element RadioButton]

Description

Text displayed with the radio button.

Derived By

Type string

Referenced By

● Element RadioButton

Remarks

This attribute is mutually exclusive with the Bitmap and Icon attributes.

Definition

See RadioButton

1232

Page 1233: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ThreadingModel [element Class]

Description

Threading model for the CLSID.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

apartment

free

both

neutral

single

rental

Referenced By

● Element Class

Definition

See Class

1233

Page 1234: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Title [element Dialog]

Description

The title of the dialog box.

Derived By

Type string

Referenced By

● Element Dialog

Definition

See Dialog

1234

Page 1235: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Title [element Feature]

Description

Short string of text identifying the feature.

Derived By

Type string

Referenced By

● Element Feature

Remarks

This string is listed as an item by the SelectionTree control of the Selection Dialog.

Definition

See Feature

1235

Page 1236: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ToolTip [element Control]

Description

The string used for the Tooltip.

Derived By

Type string

Referenced By

● Element Control

Definition

See Control

1236

Page 1237: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: ToolTip [element RadioButton]

Derived By

Type string

Referenced By

● Element RadioButton

Definition

See RadioButton

1237

Page 1238: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TrackDiskSpace [element Dialog]

Description

Have the dialog periodically call the installer to check if available disk space has changed.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Dialog

Definition

See Dialog

1238

Page 1239: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Transitive [element Component]

Description

If this attribute is set to 'yes', the installer reevaluates the value of the statement in the Condition upon areinstall.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

If the value was previously False and has changed to True, the installer installs the component. If the value waspreviously True and haschanged to False, the installer removes the component even if the component has other products as clients.

Definition

See Component

1239

Page 1240: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Transparent [element Control]

Description

This attribute is only valid for Text Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1240

Page 1241: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Traverse [element Permission]

Description

For a directory, the right to traverse the directory.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Remarks

By default, users are assigned the BYPASS_TRAVERSE_CHECKING privilege, which ignores theFILE_TRAVERSE access right. Only valid under a 'CreateFolder' parent.

Definition

See Permission

1241

Page 1242: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TrueType [element File]

Description

Causes an entry to be generated for the file in the Font table with no FontTitle specified.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Remarks

This attribute is intended to be used to register the file as a TrueType font.

Definition

See File

1242

Page 1243: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element Column]

Description

The type of this column.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

binary Column contains a path to a file that will be inserted into the column asa binary object.If this value is set, the Category attribute must also be set with a valueof 'Binary' to pass ICE validation.

int Column contains an integer or datetime value (the MinValue andMaxValue attributes should also be set).

string Column contains a non-localizable string value.

Referenced By

● Element Column

Definition

See Column

1243

Page 1244: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element ComponentSearch]

Description

Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

directory The key path of the component is a directory.

file The key path of the component is a file. This is the default value.

Referenced By

● Element ComponentSearch

Definition

See ComponentSearch

1244

Page 1245: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element Configuration]

Description

Specifies the type of the data being changed.

Derived By

Type string

Referenced By

● Element Configuration

Definition

See Configuration

1245

Page 1246: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element Control]

Description

The type of the control.

Derived By

Type string

Referenced By

● Element Control

Remarks

Could be one of the following: Billboard, Bitmap, CheckBox, ComboBox, DirectoryCombo, DirectoryList, Edit,GroupBox, Icon, Line, ListBox, ListView, MaskedEdit, PathEdit, ProgressBar, PushButton, RadioButtonGroup,ScrollableText, SelectionTree, Text, VolumeCostList, VolumeSelectCombo

Definition

See Control

1246

Page 1247: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element IgnoreModularization]

Description

The type of the item to ignore modularization for.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

Action

Property

Directory

Referenced By

● Element IgnoreModularization

Definition

See IgnoreModularization

1247

Page 1248: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element IniFileSearch]

Description

Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

directory A directory location.

file A file location. This is the default value.

raw A raw .ini value.

Referenced By

● Element IniFileSearch

Definition

See IniFileSearch

1248

Page 1249: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element Registry]

Description

Set this attribute to the type of the desired registry key.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

string The value is interpreted and stored as a string (REG_SZ).

integer The value is interpreted and stored as an integer (REG_DWORD).

binary The value is interpreted and stored as a hexadecimal value(REG_BINARY).

expandable The value is interpreted and stored as an expandable string(REG_EXPAND_SZ).

multiString The value is interpreted and stored as a multiple strings(REG_MULTI_SZ).Please note that this value will only result in a multi-string value if thereis more than one registry valueor the Action attribute's value is 'append' or 'prepend'. Otherwise astring value will be created.

Referenced By

● Element Registry

Remarks

This attribute must be specified whenever the Value attribute or a child RegistryValue element is specified. Thisattribute should only be set when the value of the Action attribute does not include the word 'remove'.

Definition

See Registry

1249

Page 1250: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element RegistrySearch]

Description

The value must be 'file' if the last child is a FileSearch element and must be 'directory' if last child is aDirectorySearch element.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

directory Sets a directory path from the registry value.

file Sets a file path from the registry value.

raw Sets the raw value from the registry value. Please note that this valuewill contain a prefix as follows:

Referenced By

● Element RegistrySearch

Definition

See RegistrySearch

1250

Page 1251: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element RegistryValue]

Description

Set this attribute to the type of the desired registry key.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

string The value is interpreted and stored as a string (REG_SZ).

integer The value is interpreted and stored as an integer (REG_DWORD).

binary The value is interpreted and stored as a hexadecimal value(REG_BINARY).

expandable The value is interpreted and stored as an expandable string(REG_EXPAND_SZ).

multiString The value is interpreted and stored as a multiple strings(REG_MULTI_SZ).Please note that this value will only result in a multi-string value if thereis more than one registry valueor the Action attribute's value is 'append' or 'prepend'. Otherwise astring value will be created.

Referenced By

● Element RegistryValue

Remarks

This attribute must be specified whenever the Value attribute or a child RegistryValue element is specified. Thisattribute should only be set when the value of the Action attribute does not include the word 'remove'.

Definition

See RegistryValue

1251

Page 1252: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Type [element ServiceInstall]

Description

The Windows Installer does not currently support kernelDriver or systemDriver

Derived By

Restricting NMTOKEN

Enumeration

Value Description

ownProcess A Win32 service that runs its own process.

shareProcess A Win32 service that shares a process.

kernelDriver A kernel driver service. This value is not currently supported by theWindows Installer.

systemDriver A file system driver service. This value is not currently supported bythe Windows Installer.

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

1252

Page 1253: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: TypicalDefault [element Feature]

Description

This attribute determines the default advertise state of the feature.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

advertise Sets the feature to be advertised by setting themsidbFeatureAttributesFavorAdvertise attribute.This value cannot be set if the value of the AllowAdvertise attribute is'no' since that would ask the installer todisallow the advertised state for this feature while at the same timefavoring it.

install Sets the feature to the default non-advertised installation option.

Referenced By

● Element Feature

Definition

See Feature

1253

Page 1254: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Underline [element TextStyle]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element TextStyle

Definition

See TextStyle

1254

Page 1255: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: UninstallWhenSuperseded [element Component]

Description

If this attribute is set to 'yes', the installer will uninstall the Component's files and registry keys when it issuperseded by a patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

This functionality is available in Windows Installer 4.5 and later.

Definition

See Component

1255

Page 1256: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: UpgradeCode [element Product]

Description

The upgrade code GUID for the product.

Derived By

Type Guid

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Element Product

Definition

See Product

1256

Page 1257: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: UpgradeCode [element Validate]

Description

Requires that the upgrade UpgradeCode match the target UpgradeCode.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Validate

Remarks

The default is 'yes'.

Definition

See Validate

1257

Page 1258: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: User [element Permission]

Derived By

Type string

Referenced By

● Element Permission

Definition

See Permission

1258

Page 1259: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: UserLanguage [element Control]

Description

This attribute is only valid for Text Controls.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Control

Definition

See Control

1259

Page 1260: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Validation [element TargetImage]

Description

Product checking to avoid applying irrelevant transforms.

Derived By

Type string

Referenced By

● Element TargetImage

Definition

See TargetImage

1260

Page 1261: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element AssemblyName]

Description

Value associated with the name specified in the Name column.

Derived By

Type string

Referenced By

● Element AssemblyName

Definition

See AssemblyName

1261

Page 1262: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element ConfigurationData]

Description

Value to be passed to configurable merge module.

Derived By

Type string

Referenced By

● Element ConfigurationData

Definition

See ConfigurationData

1262

Page 1263: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element CustomAction]

Description

This attribute specifies a string value to use in the custom action.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

This attribute must be used with the Property attribute to set the property as part of a type 51 custom action orwith the Directory attribute to set a directory path in that table in a type 35 custom action. The value can be aliteral value or derived from a Property element using the Formatted syntax.

Definition

See CustomAction

1263

Page 1264: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element CustomProperty]

Description

Value of the metadata property.

Derived By

Type string

Referenced By

● Element CustomProperty

Definition

See CustomProperty

1264

Page 1265: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element Environment]

Description

The value to set into the environment variable.

Derived By

Type string

Referenced By

● Element Environment

Remarks

If this attribute is not set, the environment variable is removed during installation if it exists on the machine.

Definition

See Environment

1265

Page 1266: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element FileTypeMask]

Description

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.

Derived By

Type HexType

Restrictions

● Value must match the following pattern: [0-9A-Fa-f]*

Referenced By

● Element FileTypeMask

Definition

See FileTypeMask

1266

Page 1267: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element IniFile]

Description

The localizable value to be written or deleted. This attribute must be set if the Action attribute's value is"addLine", "addTag", or "createLine".

Derived By

Type string

Referenced By

● Element IniFile

Definition

See IniFile

1267

Page 1268: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element ListItem]

Description

The value assigned to the associated ComboBox, ListBox, or ListView property if this item is selected.

Derived By

Type string

Referenced By

● Element ListItem

Definition

See ListItem

1268

Page 1269: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element PatchProperty]

Description

Value of the patch property.

Derived By

Type string

Referenced By

● Element PatchProperty

Definition

See PatchProperty

1269

Page 1270: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element Property]

Description

Sets a default value for the property. The value will be overwritten if the Property is used for a search.

Derived By

Type string

Referenced By

● Element Property

Definition

See Property

1270

Page 1271: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element Publish]

Description

If the Property attribute is specified, set the value of this attribute to the new value for the property.

Derived By

Type string

Referenced By

● Element Publish

Remarks

To set a property to null, do not set this attribute (the ControlEvent Argument column will be set to '{}').Otherwise, this attribute's value should be the argument for the event specified in the Event attribute.

Definition

See Publish

1271

Page 1272: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element RadioButton]

Description

Value assigned to the associated control Property when this radio button is selected.

Derived By

Type string

Referenced By

● Element RadioButton

Definition

See RadioButton

1272

Page 1273: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element Registry]

Description

Set this attribute to the localizable registry value. This value is formatted.

Derived By

Type string

Referenced By

● Element Registry

Remarks

The Windows Installer allows several special values to be set for this attribute. You should not use them in WiX.Instead use appropriatevalues in the Type attribute to get the desired behavior. This attribute cannot be specified if the Action attribute'svalue contains the word 'remove'.

Definition

See Registry

1273

Page 1274: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element RegistryValue]

Description

Set this attribute to the localizable registry value.

Derived By

Type string

Referenced By

● Element RegistryValue

Remarks

This value is formatted. The Windows Installer allows several special values to be set for this attribute. Youshould not use them in WiX. Instead use appropriate values in the Type attribute to get the desired behavior.

Definition

See RegistryValue

1274

Page 1275: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element SetDirectory]

Description

This attribute specifies a string value to assign to the Directory.

Derived By

Type string

Referenced By

● Element SetDirectory

Remarks

The value can be a literal value or derived from a Property element using the Formatted syntax.

Definition

See SetDirectory

1275

Page 1276: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element SetProperty]

Description

This attribute specifies a string value to assign to the Property.

Derived By

Type string

Referenced By

● Element SetProperty

Remarks

The value can be a literal value or derived from a Property element using the Formatted syntax.

Definition

See SetProperty

1276

Page 1277: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element Substitution]

Description

Provides a formatting template for the data being substituted into the target field specified by Table, Row, andColumn.

Derived By

Type string

Referenced By

● Element Substitution

Definition

See Substitution

1277

Page 1278: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Value [element WixVariable]

Description

The value of the variable.

Derived By

Type string

Referenced By

● Element WixVariable

Remarks

The value cannot be an empty string because that would make it possible to accidentally set a column to null.

Definition

See WixVariable

1278

Page 1279: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: VBScriptCall [element CustomAction]

Description

This attribute specifies the name of the VBScript Subroutine to execute in a script.

Derived By

Type string

Referenced By

● Element CustomAction

Remarks

The script must be provided in a Binary element identified by the BinaryKey attribute described above. In otherwords, this attribute must be specified in conjunction with the BinaryKey attribute.

Definition

See CustomAction

1279

Page 1280: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Version [element Class]

Description

Version for the CLSID.

Derived By

Type string

Referenced By

● Element Class

Definition

See Class

1280

Page 1281: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Version [element Module]

Description

The major and minor versions of the merge module.

Derived By

Type string

Referenced By

● Element Module

Definition

See Module

1281

Page 1282: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Version [element PatchFamily]

Description

Used to populate the sequence column of the MsiPatchSequence table in the final MSP file.

Derived By

Type string

Referenced By

● Element PatchFamily

Remarks

Specified in x.x.x.x format. See documentation for Sequence column of MsiPatchSequence table in MSI SDK.

Definition

See PatchFamily

1282

Page 1283: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Version [element Product]

Description

The product's version string.

Derived By

Type string

Referenced By

● Element Product

Definition

See Product

1283

Page 1284: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Versioned [element Interface]

Description

Determines whether a Typelib version entry should be created with the other COM Interface registry keys.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Interface

Remarks

Default is 'yes'.

Definition

See Interface

1284

Page 1285: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Vital [element File]

Description

If a file is vital, then installation cannot proceed unless the file is successfully installed.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element File

Remarks

The user will have no option to ignore an error installing this file. If an error occurs, they can merely retry toinstall the file or abort the installation. The default is "yes," unless the -sfdvital switch (candle.exe) orSuppressFileDefaultVital property (.wixproj) is used.

Definition

See File

1285

Page 1286: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Vital [element ServiceInstall]

Description

The overall install should fail if this service fails to install.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ServiceInstall

Definition

See ServiceInstall

1286

Page 1287: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: VolumeLabel [element Family]

Description

Entered into the VolumeLabel field of the new Media table record.

Derived By

Type string

Referenced By

● Element Family

Definition

See Family

1287

Page 1288: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: VolumeLabel [element Media]

Description

The label attributed to the volume.

Derived By

Type string

Referenced By

● Element Media

Remarks

This is the volume label returned by the GetVolumeInformation function. If the SourceDir property refers to aremovable (floppy or CD-ROM) volume, then this volume label is used to verify that the proper disk is in thedrive before attempting to install files. The entry in this column must match the volume label of the physicalmedia.

Definition

See Media

1288

Page 1289: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Wait [element ServiceControl]

Description

Specifies whether or not to wait for the service to complete before continuing.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element ServiceControl

Definition

See ServiceControl

1289

Page 1290: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: WholeFile [element UpgradeFile]

Description

Whether the whole file should be installed, rather than creating a binary patch.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element UpgradeFile

Definition

See UpgradeFile

1290

Page 1291: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: WholeFilesOnly [element PatchCreation]

Description

Use this to set whether changing files should be included in their entirety.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element PatchCreation

Remarks

See IncludeWholeFilesOnly for more information.

Definition

See PatchCreation

1291

Page 1292: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Width [element Column]

Description

Width of this column.

Derived By

Type integer

Referenced By

● Element Column

Definition

See Column

1292

Page 1293: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Width [element Control]

Description

Width of the rectangular boundary of the control.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Control

Remarks

This must be a non-negative number.

Definition

See Control

1293

Page 1294: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Width [element Dialog]

Description

The width of the dialog box in dialog units.

Derived By

Type integer

Referenced By

● Element Dialog

Definition

See Dialog

1294

Page 1295: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Width [element RadioButton]

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element RadioButton

Definition

See RadioButton

1295

Page 1296: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Win64 [element Component]

Description

Set this attribute to 'yes' to mark this as a 64-bit component.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Component

Remarks

This attribute facilitates the installation of packages that include both 32-bit and 64-bit components. If this bit isnot set, the component is registered as a 32-bit component. If this is a 64-bit component replacing a 32-bitcomponent, set this bit and assign a new GUID in the Guid attribute.

Definition

See Component

1296

Page 1297: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Win64 [element CustomAction]

Description

Specifies that a script custom action targets a 64-bit platform.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element CustomAction

Remarks

Valid only when used with the Script, VBScriptCall, and JScriptCall attributes.

Definition

See CustomAction

1297

Page 1298: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Win64 [element RegistrySearch]

Description

Instructs the search to look in the 64-bit registry when the value is 'yes'.

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element RegistrySearch

Remarks

Default is 'no' and search looks in the 32-bit registry.

Definition

See RegistrySearch

1298

Page 1299: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: WorkingDirectory [element Shortcut]

Description

Directory identifier (or Property identifier that resolves to a directory) that resolves to the path of the workingdirectory for the shortcut.

Derived By

Type string

Referenced By

● Element Shortcut

Definition

See Shortcut

1299

Page 1300: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Write [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1300

Page 1301: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: WriteAttributes [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1301

Page 1302: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: WriteExtendedAttributes [element Permission]

Derived By

Type YesNoType

Enumeration

Value Description

no

yes

Referenced By

● Element Permission

Definition

See Permission

1302

Page 1303: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: X [element Control]

Description

Horizontal coordinate of the upper-left corner of the rectangular boundary of the control.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Control

Remarks

This must be a non-negative number.

Definition

See Control

1303

Page 1304: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: X [element Dialog]

Description

Horizontal placement of the dialog box as a percentage of screen width.

Derived By

Type integer

Referenced By

● Element Dialog

Remarks

The default value is 50.

Definition

See Dialog

1304

Page 1305: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: X [element RadioButton]

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element RadioButton

Definition

See RadioButton

1305

Page 1306: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Y [element Control]

Description

Vertical coordinate of the upper-left corner of the rectangular boundary of the control.

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element Control

Remarks

This must be a non-negative number.

Definition

See Control

1306

Page 1307: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Y [element Dialog]

Description

Vertical placement of the dialog box as a percentage of screen height.

Derived By

Type integer

Referenced By

● Element Dialog

Remarks

The default value is 50.

Definition

See Dialog

1307

Page 1308: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Attribute: Y [element RadioButton]

Derived By

Type LocalizableInteger

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Element RadioButton

Definition

See RadioButton

1308

Page 1309: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Complex Types: WiX Database

Complex Types

Name Description

ActionModuleSequenceType

ActionSequenceType

1309

Page 1310: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Complex Type: ActionModuleSequenceType

Derived By

Extending string

Attributes

Name Type Required? Default Description

After string No The name of an action that thisaction should come after.

Before string No The name of an action that thisaction should come before.

Overridable YesNoType No If "yes", the sequencing of this actionmay be overridden by sequencingelsewhere.

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Referenced By

● Element AppSearch

● Element CCPSearch

● Element DisableRollback

● Element FindRelatedProducts

● Element ForceReboot

● Element InstallExecute

● Element InstallExecuteAgain

● Element LaunchConditions

● Element RemoveExistingProducts

● Element ResolveSource

● Element RMCCPSearch

● Element ScheduleReboot

Definition

<xs:complexType name="ActionModuleSequenceType"><xs:simpleContent><xs:extension base="xs:string"><xs:annotation><xs:documentation>Text node specifies the condition of the action.</xs:documentation>

</xs:annotation><xs:attribute name="After" type="xs:string"><xs:annotation><xs:documentation>The name of an action that this action should come after.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Before" type="xs:string"><xs:annotation><xs:documentation>The name of an action that this action should come before.</xs:documentation>

</xs:annotation>

1310

Page 1311: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute><xs:attribute name="Overridable" type="YesNoType"><xs:annotation><xs:documentation>

If "yes", the sequencing of this action may be overridden by sequencing elsewhere.</xs:documentation>

</xs:annotation></xs:attribute><xs:attribute name="Sequence" type="xs:integer"><xs:annotation><xs:documentation>A value used to indicate the position of this action in a

sequence.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Suppress" type="YesNoType"><xs:annotation><xs:documentation>If yes, this action will not occur.</xs:documentation>

</xs:annotation></xs:attribute>

</xs:extension></xs:simpleContent>

</xs:complexType>

1311

Page 1312: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Complex Type: ActionSequenceType

Derived By

Extending string

Attributes

Name Type Required? Default Description

Sequence integer No A value used to indicate the positionof this action in a sequence.

Suppress YesNoType No If yes, this action will not occur.

Referenced By

● Element AllocateRegistrySpace

● Element BindImage

● Element CostFinalize

● Element CostInitialize

● Element CreateFolders

● Element CreateShortcuts

● Element DeleteServices

● Element DuplicateFiles

● Element ExecuteAction

● Element FileCost

● Element InstallAdminPackage

● Element InstallFiles

● Element InstallFinalize

● Element InstallInitialize

● Element InstallODBC

● Element InstallServices

● Element InstallValidate

● Element IsolateComponents

● Element MigrateFeatureStates

● Element MoveFiles

● Element MsiPublishAssemblies

● Element MsiUnpublishAssemblies

● Element PatchFiles

● Element ProcessComponents

● Element PublishComponents

● Element PublishFeatures

● Element PublishProduct

● Element RegisterClassInfo

● Element RegisterComPlus

● Element RegisterExtensionInfo

● Element RegisterFonts

1312

Page 1313: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Element RegisterMIMEInfo

● Element RegisterProduct

● Element RegisterProgIdInfo

● Element RegisterTypeLibraries

● Element RegisterUser

● Element RemoveDuplicateFiles

● Element RemoveEnvironmentStrings

● Element RemoveFiles

● Element RemoveFolders

● Element RemoveIniValues

● Element RemoveODBC

● Element RemoveRegistryValues

● Element RemoveShortcuts

● Element SelfRegModules

● Element SelfUnregModules

● Element SetODBCFolders

● Element StartServices

● Element StopServices

● Element UnpublishComponents

● Element UnpublishFeatures

● Element UnregisterClassInfo

● Element UnregisterComPlus

● Element UnregisterExtensionInfo

● Element UnregisterFonts

● Element UnregisterMIMEInfo

● Element UnregisterProgIdInfo

● Element UnregisterTypeLibraries

● Element ValidateProductID

● Element WriteEnvironmentStrings

● Element WriteIniValues

● Element WriteRegistryValues

Definition

<xs:complexType name="ActionSequenceType"><xs:simpleContent><xs:extension base="xs:string"><xs:attribute name="Sequence" type="xs:integer"><xs:annotation><xs:documentation>A value used to indicate the position of this action in a

sequence.</xs:documentation></xs:annotation>

</xs:attribute><xs:attribute name="Suppress" type="YesNoType"><xs:annotation><xs:documentation>If yes, this action will not occur.</xs:documentation>

</xs:annotation>

1313

Page 1314: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:attribute></xs:extension>

</xs:simpleContent></xs:complexType>

1314

Page 1315: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Types: WiX Database

Simple Types

Name Description

AutogenGuid Values of this type will look like:"01234567-89AB-CDEF-0123-456789ABCDEF" or"{01234567-89AB-CDEF-0123-456789ABCDEF}".

ComponentGuid Values of this type will look like:"01234567-89AB-CDEF-0123-456789ABCDEF" or"{01234567-89AB-CDEF-0123-456789ABCDEF}", but also allows"PUT-GUID-HERE" for use in examples. It's also possible to have anempty value "".

Guid Values of this type will look like:"01234567-89AB-CDEF-0123-456789ABCDEF" or"{01234567-89AB-CDEF-0123-456789ABCDEF}".

HexType This type supports any hexadecimal number.

LocalizableInteger Values of this type must be an integer or the value can be alocalization variable with the format !(loc.Variable) where "Variable" isthe name of the variable.

LongFileNameType Values of this type will look like: "Long File Name.extension".

PatchClassificationType Category of update.

RegistryRootType Values of this type represent possible registry roots.

ShortFileNameType Values of this type will look like: "FileName.ext".

VersionType Values of this type will look like: "x.x.x.x" where x is an integer from 0to 65534.

WildCardLongFileNameType Values of this type will look like: "Long File N?me.extension*".

WildCardShortFileNameType Values of this type will look like: "File?.*".

YesNoDefaultType Values of this type will either be "default", "yes", or "no".

YesNoType Values of this type will either be "yes" or "no".

1315

Page 1316: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: AutogenGuid

Description

Values of this type will look like: "01234567-89AB-CDEF-0123-456789ABCDEF" or"{01234567-89AB-CDEF-0123-456789ABCDEF}".

Derived By

Restricting string

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Attribute Id [element Package]

● Attribute Id [element Patch]

● Attribute Id [element Product]

Remarks

A GUID can be auto-generated by setting the value to "*". Also allows "PUT-GUID-HERE" for use in examples.

Definition

<xs:simpleType name="AutogenGuid"><xs:annotation><xs:documentation>Values of this type will look like: "01234567-89AB-CDEF-0123-456789ABCDEF" or

"{01234567-89AB-CDEF-0123-456789ABCDEF}". A GUID can be auto-generated by setting the value to "*".Also allows "PUT-GUID-HERE" for use in examples.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?|[{

(]?\?{8}\-\?{4}\-\?{4}\-\?{4}\-\?{12}[})]?|PUT\-GUID\-(?:\d+\-)?HERE|([!$])(\(var|\(loc|\(wix)\.[_A-Za-z][0-9A-Za-z_.]*\)|\*" /></xs:restriction>

</xs:simpleType>

1316

Page 1317: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: ComponentGuid

Description

Values of this type will look like: "01234567-89AB-CDEF-0123-456789ABCDEF" or"{01234567-89AB-CDEF-0123-456789ABCDEF}", but also allows "PUT-GUID-HERE" for use in examples. It'salso possible to have an empty value "".

Derived By

Restricting string

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Attribute Guid [element Component]

Definition

<xs:simpleType name="ComponentGuid"><xs:annotation><xs:documentation>Values of this type will look like: "01234567-89AB-CDEF-0123-456789ABCDEF" or

"{01234567-89AB-CDEF-0123-456789ABCDEF}", but also allows "PUT-GUID-HERE" for use in examples. It'salso possible to have an empty value "".</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?|P

UT\-GUID\-(?:\d+\-)?HERE|([!$])(\(var|\(loc|\(wix)\.[_A-Za-z][0-9A-Za-z_.]*\)|\*|^$" /></xs:restriction>

</xs:simpleType>

1317

Page 1318: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: Guid

Description

Values of this type will look like: "01234567-89AB-CDEF-0123-456789ABCDEF" or"{01234567-89AB-CDEF-0123-456789ABCDEF}".

Derived By

Restricting string

Restrictions

● Value must match the following pattern:

[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?

Referenced By

● Attribute AppId [element Class]

● Attribute Class [element MIME]

● Attribute ComponentGuidGenerationSeed [element Directory]

● Attribute Guid [element ComponentSearch]

● Attribute Guid [element Module]

● Attribute Id [element AppId]

● Attribute Id [element Category]

● Attribute Id [element Class]

● Attribute Id [element Interface]

● Attribute Id [element PatchCreation]

● Attribute Id [element ReplacePatch]

● Attribute Id [element TypeLib]

● Attribute Id [element Upgrade]

● Attribute ProductCode [element PatchFamily]

● Attribute ProductCode [element PatchSequence]

● Attribute ProxyStubClassId [element Interface]

● Attribute ProxyStubClassId32 [element Interface]

● Attribute UpgradeCode [element Product]

Remarks

Also allows "PUT-GUID-HERE" for use in examples.

Definition

<xs:simpleType name="Guid"><xs:annotation><xs:documentation>Values of this type will look like: "01234567-89AB-CDEF-0123-456789ABCDEF" or

"{01234567-89AB-CDEF-0123-456789ABCDEF}". Also allows "PUT-GUID-HERE" for use inexamples.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[{(]?[0-9A-Fa-f]{8}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{4}\-?[0-9A-Fa-f]{12}[})]?|P

UT\-GUID\-(?:\d+\-)?HERE|([!$])(\(var|\(loc|\(wix)\.[_A-Za-z][0-9A-Za-z_.]*\)" />

1318

Page 1319: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:restriction></xs:simpleType>

1319

Page 1320: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: HexType

Description

This type supports any hexadecimal number.

Derived By

Restricting string

Restrictions

● Value must match the following pattern: [0-9A-Fa-f]*

Referenced By

● Attribute Mask [element FileTypeMask]

● Attribute Value [element FileTypeMask]

Remarks

Both upper and lower case is acceptable for letters appearing in the number. This type also includes the emptystring: "".

Definition

<xs:simpleType name="HexType"><xs:annotation><xs:documentation>This type supports any hexadecimal number. Both upper and lower case is acceptable

for letters appearing in the number. This type also includes the empty string: "".</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[0-9A-Fa-f]*" />

</xs:restriction></xs:simpleType>

1320

Page 1321: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: LocalizableInteger

Description

Values of this type must be an integer or the value can be a localization variable with the format !(loc.Variable)where "Variable" is the name of the variable.

Derived By

Restricting string

Restrictions

● Value must match the following pattern: [0-9][0-9]*

Referenced By

● Attribute Height [element Control]

● Attribute Height [element RadioButton]

● Attribute Language [element Merge]

● Attribute Language [element Module]

● Attribute Language [element Product]

● Attribute Width [element Control]

● Attribute Width [element RadioButton]

● Attribute X [element Control]

● Attribute X [element RadioButton]

● Attribute Y [element Control]

● Attribute Y [element RadioButton]

Definition

<xs:simpleType name="LocalizableInteger"><xs:annotation><xs:documentation>Values of this type must be an integer or the value can be a localization variable with the

format !(loc.Variable) where "Variable" is the name of the variable.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[0-9][0-9]*|([!$])\((?:loc|bind)\.[_A-Za-z][0-9A-Za-z_.]+\)" />

</xs:restriction></xs:simpleType>

1321

Page 1322: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: LongFileNameType

Description

Values of this type will look like: "Long File Name.extension".

Derived By

Restricting string

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Attribute DestinationLongName [element CopyFile]

● Attribute DestinationName [element CopyFile]

● Attribute LongName [element Directory]

● Attribute LongName [element File]

● Attribute LongName [element FileSearch]

● Attribute LongName [element IniFile]

● Attribute LongName [element IniFileSearch]

● Attribute LongName [element Shortcut]

● Attribute LongSource [element Directory]

● Attribute Name [element Directory]

● Attribute Name [element EmbeddedUI]

● Attribute Name [element EmbeddedUIResource]

● Attribute Name [element File]

● Attribute Name [element FileSearch]

● Attribute Name [element IniFile]

● Attribute Name [element IniFileSearch]

● Attribute Name [element Shortcut]

● Attribute SourceName [element Directory]

Remarks

Legal long names contain no more than 260 characters and must contain at least one non-period character.The following characters are not allowed: \ ? | &gt; : / * " or less-than. The name must be shorter than 260characters. The value could also be a localization variable with the format !(loc.VARIABLE).

Definition

<xs:simpleType name="LongFileNameType"><xs:annotation><xs:documentation>Values of this type will look like: "Long File Name.extension". Legal long names contain

no more than 260 characters and must contain at least one non-period character. The following characters arenot allowed: \ ? | &gt; : / * " or less-than. The name must be shorter than 260 characters. The value could alsobe a localization variable with the format !(loc.VARIABLE).</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[^\\\?|&gt;&lt;:/\*&quot;]{1,259}|([!$])\(loc\.[_A-Za-z][0-9A-Za-z_.]*\)" />

</xs:restriction>

1322

Page 1323: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:simpleType>

1323

Page 1324: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: PatchClassificationType

Description

Category of update.

Derived By

Restricting string

Enumeration

Value Description

Critical Update A broadly released fix for a specific problem addressing a critical,non-security related bug.

Hotfix Hotfixes address a specific customer situation and generally should notbe distributed outside the customer's organization.

Security Rollup A broadly released fix for a specific security-related relatedvulnerability.

Service Pack A cumulative set of all hotfixes, security rollups, critical updates, andupdates, as well as additional fixes and even new features found sincethe release of the product.

Update A broadly released fix for a specific problem addressing a non-critical,non-security related bug.

Update Rollup A cumulative set of hotfixes, security rollups, critical updates, andupdates packaged together which typically targets a specific area of aproduct.

Referenced By

● Attribute Classification [element Patch]

● Attribute Classification [element PatchMetadata]

Definition

<xs:simpleType name="PatchClassificationType"><xs:annotation><xs:documentation>Category of update.</xs:documentation>

</xs:annotation><xs:restriction base="xs:string"><xs:enumeration value="Critical Update"><xs:annotation><xs:documentation>A broadly released fix for a specific problem addressing a critical, non-security related

bug.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="Hotfix"><xs:annotation><xs:documentation>Hotfixes address a specific customer situation and generally should not be distributed

outside the customer's organization.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="Security Rollup"><xs:annotation><xs:documentation>A broadly released fix for a specific security-related related

vulnerability.</xs:documentation>

1324

Page 1325: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

</xs:annotation></xs:enumeration><xs:enumeration value="Service Pack"><xs:annotation><xs:documentation>A cumulative set of all hotfixes, security rollups, critical updates, and updates, as well

as additional fixes and even new features found since the release of the product.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="Update"><xs:annotation><xs:documentation>A broadly released fix for a specific problem addressing a non-critical, non-security

related bug.</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="Update Rollup"><xs:annotation><xs:documentation>A cumulative set of hotfixes, security rollups, critical updates, and updates packaged

together which typically targets a specific area of a product.</xs:documentation></xs:annotation>

</xs:enumeration></xs:restriction>

</xs:simpleType>

1325

Page 1326: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: RegistryRootType

Description

Values of this type represent possible registry roots.

Derived By

Restricting NMTOKEN

Enumeration

Value Description

HKMU A per-user installation will make the operation occur underHKEY_CURRENT_USER.A per-machine installation will make the operation occur underHKEY_LOCAL_MACHINE.

HKCR Operation occurs under HKEY_CLASSES_ROOT. When usingWindows 2000 or later, the installer writes or removes the valuefrom the HKCU\Software\Classes hive during per-user installations.When using Windows 2000 or later operating systems,the installer writes or removes the value from theHKLM\Software\Classes hive during per-machine installations.

HKCU Operation occurs under HKEY_CURRENT_USER. It is recommendedto set the KeyPath='yes' attribute when setting this value for writingvaluesin order to ensure that the installer writes the necessary registry entrieswhen there are multiple users on the same computer.

HKLM Operation occurs under HKEY_LOCAL_MACHINE.

HKU Operation occurs under HKEY_USERS.

Referenced By

● Attribute Root [element Registry]

● Attribute Root [element RegistryKey]

● Attribute Root [element RegistryValue]

● Attribute Root [element RemoveRegistryKey]

● Attribute Root [element RemoveRegistryValue]

Definition

<xs:simpleType name="RegistryRootType"><xs:annotation><xs:documentation>Values of this type represent possible registry roots.</xs:documentation>

</xs:annotation><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="HKMU"><xs:annotation><xs:documentation>

A per-user installation will make the operation occur under HKEY_CURRENT_USER.A per-machine installation will make the operation occur under HKEY_LOCAL_MACHINE.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="HKCR">

1326

Page 1327: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Definition

<xs:annotation><xs:documentation>

Operation occurs under HKEY_CLASSES_ROOT. When using Windows 2000 or later, theinstaller writes or removes the value

from the HKCU\Software\Classes hive during per-user installations. When using Windows 2000or later operating systems,

the installer writes or removes the value from the HKLM\Software\Classes hive duringper-machine installations.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="HKCU"><xs:annotation><xs:documentation>

Operation occurs under HKEY_CURRENT_USER. It is recommended to set the KeyPath='yes'attribute when setting this value for writing values

in order to ensure that the installer writes the necessary registry entries when there are multipleusers on the same computer.

</xs:documentation></xs:annotation>

</xs:enumeration><xs:enumeration value="HKLM"><xs:annotation><xs:documentation>

Operation occurs under HKEY_LOCAL_MACHINE.</xs:documentation>

</xs:annotation></xs:enumeration><xs:enumeration value="HKU"><xs:annotation><xs:documentation>

Operation occurs under HKEY_USERS.</xs:documentation>

</xs:annotation></xs:enumeration>

</xs:restriction></xs:simpleType>

1327

Page 1328: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: ShortFileNameType

Description

Values of this type will look like: "FileName.ext".

Derived By

Restricting string

Restrictions

● Value must match the following pattern: [^\\\?

Referenced By

● Attribute DestinationShortName [element CopyFile]

● Attribute ShortName [element Directory]

● Attribute ShortName [element File]

● Attribute ShortName [element FileSearch]

● Attribute ShortName [element IniFile]

● Attribute ShortName [element IniFileSearch]

● Attribute ShortName [element Shortcut]

● Attribute ShortSourceName [element Directory]

Remarks

Only one period is allowed. The following characters are not allowed: \ ? | &gt; : / * " + , ; = [ ] less-than, orwhitespace. The name cannot be longer than 8 characters and the extension cannot exceed 3 characters. Thevalue could also be a localization variable with the format !(loc.VARIABLE).

Definition

<xs:simpleType name="ShortFileNameType"><xs:annotation><xs:documentation>Values of this type will look like: "FileName.ext". Only one period is allowed. The

following characters are not allowed: \ ? | &gt; : / * " + , ; = [ ] less-than, or whitespace. The name cannot belonger than 8 characters and the extension cannot exceed 3 characters. The value could also be a localizationvariable with the format !(loc.VARIABLE).</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[^\\\?|&gt;&lt;:/\*&quot;\+,;=\[\]\. ]{1,8}(\.[^\\\?|&gt;&lt;:/\*&quot;\+,;=\[\]\.

]{0,3})?|([!$])\(loc\.[_A-Za-z][0-9A-Za-z_.]*\)" /></xs:restriction>

</xs:simpleType>

1328

Page 1329: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: VersionType

Description

Values of this type will look like: "x.x.x.x" where x is an integer from 0 to 65534.

Derived By

Restricting string

Restrictions

● Value must match the following pattern: (\d{1,5}\.){3}\d{1,5}

Referenced By

● Attribute RequiredVersion [element Wix]

Definition

<xs:simpleType name="VersionType"><xs:annotation><xs:documentation>Values of this type will look like: "x.x.x.x" where x is an integer from 0 to

65534.</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="(\d{1,5}\.){3}\d{1,5}" />

</xs:restriction></xs:simpleType>

1329

Page 1330: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: WildCardLongFileNameType

Description

Values of this type will look like: "Long File N?me.extension*".

Derived By

Restricting string

Restrictions

● Value must match the following pattern: [^\\\

Referenced By

● Attribute LongName [element RemoveFile]

● Attribute Name [element RemoveFile]

● Attribute SourceName [element CopyFile]

Remarks

Legal long names contain no more than 260 characters and must contain at least one non-period character.The following characters are not allowed: \ | &gt; : / " or less-than. The name must be shorter than 260characters. The value could also be a localization variable with the format !(loc.VARIABLE).

Definition

<xs:simpleType name="WildCardLongFileNameType"><xs:annotation><xs:documentation>Values of this type will look like: "Long File N?me.extension*". Legal long names contain

no more than 260 characters and must contain at least one non-period character. The following characters arenot allowed: \ | &gt; : / " or less-than. The name must be shorter than 260 characters. The value could also bea localization variable with the format !(loc.VARIABLE).</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[^\\\|&gt;&lt;:/&quot;]{1,259}|([!$])\(loc\.[_A-Za-z][0-9A-Za-z_.]*\)" />

</xs:restriction></xs:simpleType>

1330

Page 1331: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: WildCardShortFileNameType

Description

Values of this type will look like: "File?.*".

Derived By

Restricting string

Restrictions

● Value must match the following pattern: [^\\\

Referenced By

● Attribute ShortName [element RemoveFile]

Remarks

Only one period is allowed. The following characters are not allowed: \ | &gt; : / " + , ; = [ ] less-than, orwhitespace. The name cannot be longer than 8 characters and the extension cannot exceed 3 characters. Thevalue could also be a localization variable with the format !(loc.VARIABLE).

Definition

<xs:simpleType name="WildCardShortFileNameType"><xs:annotation><xs:documentation>Values of this type will look like: "File?.*". Only one period is allowed. The following

characters are not allowed: \ | &gt; : / " + , ; = [ ] less-than, or whitespace. The name cannot be longer than 8characters and the extension cannot exceed 3 characters. The value could also be a localization variable withthe format !(loc.VARIABLE).</xs:documentation></xs:annotation><xs:restriction base="xs:string"><xs:pattern value="[^\\\|&gt;&lt;:/&quot;\+,;=\[\]\. ]{1,16}(\.[^\\\|&gt;&lt;:/&quot;\+,;=\[\]\.

]{0,6})?|([!$])\(loc\.[_A-Za-z][0-9A-Za-z_.]*\)" /></xs:restriction>

</xs:simpleType>

1331

Page 1332: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: YesNoDefaultType

Description

Values of this type will either be "default", "yes", or "no".

Derived By

Restricting NMTOKEN

Enumeration

Value Description

default

no

yes

Referenced By

● Attribute Compressed [element File]

● Attribute ReadOnly [element Package]

● Attribute ReadOnly [element PatchInformation]

Definition

<xs:simpleType name="YesNoDefaultType"><xs:annotation><xs:documentation>Values of this type will either be "default", "yes", or "no".</xs:documentation>

</xs:annotation><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="default" /><xs:enumeration value="no" /><xs:enumeration value="yes" />

</xs:restriction></xs:simpleType>

1332

Page 1333: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Simple Type: YesNoType

Description

Values of this type will either be "yes" or "no".

Derived By

Restricting NMTOKEN

Enumeration

Value Description

no

yes

Referenced By

● Attribute ActivateAtStorage [element AppId]

● Attribute Admin [element Property]

● Attribute AdminImage [element Package]

● Attribute AdminImage [element PatchInformation]

● Attribute Advertise [element AppId]

● Attribute Advertise [element Class]

● Attribute Advertise [element Extension]

● Attribute Advertise [element MIME]

● Attribute Advertise [element ProgId]

● Attribute Advertise [element Shortcut]

● Attribute Advertise [element TypeLib]

● Attribute AllowIgnoreOnError [element UpgradeFile]

● Attribute AllowMajorVersionMismatches [element PatchCreation]

● Attribute AllowProductCodeMismatches [element PatchCreation]

● Attribute AllowRemoval [element Patch]

● Attribute AllowRemoval [element PatchMetadata]

● Attribute ApiPatchingSymbolNoFailuresFlag [element Patch]

● Attribute ApiPatchingSymbolNoImagehlpFlag [element Patch]

● Attribute ApiPatchingSymbolUndecoratedTooFlag [element Patch]

● Attribute Append [element Permission]

● Attribute AssignToProperty [element DirectorySearch]

● Attribute AssignToProperty [element DirectorySearchRef]

● Attribute Bitmap [element Control]

● Attribute Bold [element TextStyle]

● Attribute Cancel [element Control]

● Attribute CDROM [element Control]

● Attribute ChangePermission [element Permission]

● Attribute Checksum [element File]

1333

Page 1334: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Attribute CleanWorkingFolder [element PatchCreation]

● Attribute ComboList [element Control]

● Attribute ComplianceCheck [element Property]

● Attribute Compressed [element Package]

● Attribute Compressed [element PatchInformation]

● Attribute Control [element Class]

● Attribute Control [element TypeLib]

● Attribute CreateChild [element Permission]

● Attribute CreateFile [element Permission]

● Attribute CreateLink [element Permission]

● Attribute CreateSubkeys [element Permission]

● Attribute CustomPalette [element Dialog]

● Attribute Default [element Control]

● Attribute Default [element MIME]

● Attribute Delete [element CopyFile]

● Attribute Delete [element Permission]

● Attribute DeleteChild [element Permission]

● Attribute Disabled [element Control]

● Attribute DisableRegistryReflection [element Component]

● Attribute ElevationShield [element Control]

● Attribute EmbedCab [element Media]

● Attribute EnumerateSubkeys [element Permission]

● Attribute EraseDescription [element ServiceInstall]

● Attribute ErrorDialog [element Dialog]

● Attribute ExcludeLanguages [element UpgradeVersion]

● Attribute Execute [element Permission]

● Attribute FileCompression [element Merge]

● Attribute Fixed [element Control]

● Attribute FixedSize [element Control]

● Attribute Floppy [element Control]

● Attribute FormatSize [element Control]

● Attribute GenericAll [element Permission]

● Attribute GenericExecute [element Permission]

● Attribute GenericRead [element Permission]

● Attribute GenericWrite [element Permission]

● Attribute Group [element ServiceDependency]

● Attribute HasBorder [element Control]

● Attribute HasDiskImage [element TypeLib]

● Attribute Hidden [element Control]

● Attribute Hidden [element Dialog]

● Attribute Hidden [element File]

● Attribute Hidden [element Property]

1334

Page 1335: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Attribute Hidden [element TypeLib]

● Attribute HideTarget [element CustomAction]

● Attribute Icon [element Control]

● Attribute Ignore [element UpgradeFile]

● Attribute IgnoreActionData [element EmbeddedUI]

● Attribute IgnoreActionStart [element EmbeddedUI]

● Attribute IgnoreAddExistingRow [element Validate]

● Attribute IgnoreAddExistingTable [element Validate]

● Attribute IgnoreChangingCodePage [element Validate]

● Attribute IgnoreCommonData [element EmbeddedUI]

● Attribute IgnoreDeleteMissingRow [element Validate]

● Attribute IgnoreDeleteMissingTable [element Validate]

● Attribute IgnoreError [element EmbeddedUI]

● Attribute IgnoreFatalExit [element EmbeddedUI]

● Attribute IgnoreFilesInUse [element EmbeddedUI]

● Attribute IgnoreInfo [element EmbeddedUI]

● Attribute IgnoreInitialize [element EmbeddedUI]

● Attribute IgnoreMissingFiles [element TargetImage]

● Attribute IgnoreOutOfDiskSpace [element EmbeddedUI]

● Attribute IgnoreParent [element FeatureGroupRef]

● Attribute IgnoreParent [element FeatureRef]

● Attribute IgnoreProgress [element EmbeddedUI]

● Attribute IgnoreRemoveFailure [element UpgradeVersion]

● Attribute IgnoreResolveSource [element EmbeddedUI]

● Attribute IgnoreRMFilesInUse [element EmbeddedUI]

● Attribute IgnoreShowDialog [element EmbeddedUI]

● Attribute IgnoreTerminate [element EmbeddedUI]

● Attribute IgnoreUpdateMissingRow [element Validate]

● Attribute IgnoreUser [element EmbeddedUI]

● Attribute IgnoreWarning [element EmbeddedUI]

● Attribute Image [element Control]

● Attribute Impersonate [element CustomAction]

● Attribute IncludeMaximum [element UpgradeVersion]

● Attribute IncludeMinimum [element UpgradeVersion]

● Attribute Indirect [element Control]

● Attribute Insertable [element Class]

● Attribute Integer [element Control]

● Attribute Interactive [element ServiceInstall]

● Attribute Italic [element TextStyle]

● Attribute KeepModeless [element Dialog]

● Attribute KeyNoOrphan [element Configuration]

● Attribute KeyPath [element Component]

1335

Page 1336: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Attribute KeyPath [element File]

● Attribute KeyPath [element ODBCDataSource]

● Attribute KeyPath [element Registry]

● Attribute KeyPath [element RegistryValue]

● Attribute LeftScroll [element Control]

● Attribute LeftScroll [element Dialog]

● Attribute Localizable [element Column]

● Attribute MigrateFeatures [element UpgradeVersion]

● Attribute MinorUpdateTargetRTM [element Patch]

● Attribute Modeless [element Dialog]

● Attribute Multiline [element Control]

● Attribute NeverOverwrite [element Component]

● Attribute NoMinimize [element Dialog]

● Attribute NonNullable [element Configuration]

● Attribute NoPrefix [element Control]

● Attribute Notify [element Permission]

● Attribute NoWrap [element Control]

● Attribute Nullable [element Column]

● Attribute OnlyDetect [element UpgradeVersion]

● Attribute OptimizedInstallMode [element Patch]

● Attribute OptimizedInstallMode [element PatchMetadata]

● Attribute OptimizePatchSizeForLargeFiles [element Patch]

● Attribute Overridable [element Custom]

● Attribute Overridable [element Show]

● Attribute Overridable [element WixVariable]

● Attribute Overridable [type ActionModuleSequenceType]

● Attribute Password [element Control]

● Attribute PatchAllowIgnoreOnError [element File]

● Attribute PatchIgnore [element File]

● Attribute PatchUninstall [element CustomAction]

● Attribute PatchWholeFile [element File]

● Attribute Permanent [element Component]

● Attribute Permanent [element Environment]

● Attribute Primary [element ComponentGroupRef]

● Attribute Primary [element ComponentRef]

● Attribute Primary [element FeatureGroupRef]

● Attribute Primary [element MergeRef]

● Attribute PrimaryKey [element Column]

● Attribute ProductId [element Validate]

● Attribute ProductLanguage [element Validate]

● Attribute Programmable [element Class]

● Attribute ProgressBlocks [element Control]

1336

Page 1337: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Attribute PushLike [element Control]

● Attribute RAMDisk [element Control]

● Attribute Read [element Permission]

● Attribute ReadAttributes [element Permission]

● Attribute ReadExtendedAttributes [element Permission]

● Attribute ReadOnly [element File]

● Attribute ReadPermission [element Permission]

● Attribute RelativePath [element Class]

● Attribute Remote [element Control]

● Attribute Removable [element Control]

● Attribute Restricted [element TypeLib]

● Attribute RightAligned [element Control]

● Attribute RightAligned [element Dialog]

● Attribute RightToLeft [element Control]

● Attribute RightToLeft [element Dialog]

● Attribute RunAsInteractiveUser [element AppId]

● Attribute SafeForInitializing [element Class]

● Attribute SafeForScripting [element Class]

● Attribute Secure [element Property]

● Attribute Shared [element Component]

● Attribute SharedDllRefCount [element Component]

● Attribute ShortNames [element Package]

● Attribute ShortNames [element PatchInformation]

● Attribute ShortPath [element Class]

● Attribute ShowRollbackCost [element Control]

● Attribute SkipAssignment [element OptimizeCustomActions]

● Attribute SkipDeferred [element OptimizeCustomActions]

● Attribute SkipImmediate [element OptimizeCustomActions]

● Attribute Sorted [element Control]

● Attribute Strike [element TextStyle]

● Attribute Sunken [element Control]

● Attribute Supersede [element PatchFamily]

● Attribute Supersede [element PatchSequence]

● Attribute SupportBasicUI [element EmbeddedUI]

● Attribute Suppress [type ActionModuleSequenceType]

● Attribute Suppress [type ActionSequenceType]

● Attribute SuppressModularization [element Binary]

● Attribute SuppressModularization [element CustomAction]

● Attribute SuppressModularization [element Property]

● Attribute Synchronize [element Permission]

● Attribute System [element Environment]

● Attribute System [element File]

1337

Page 1338: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

WiX Database XML Schema

Referenced By

● Attribute SystemModal [element Dialog]

● Attribute TabSkip [element Control]

● Attribute TakeOwnership [element Permission]

● Attribute TerminalServerAware [element CustomAction]

● Attribute TrackDiskSpace [element Dialog]

● Attribute Transitive [element Component]

● Attribute Transparent [element Control]

● Attribute Traverse [element Permission]

● Attribute TrueType [element File]

● Attribute Underline [element TextStyle]

● Attribute UninstallWhenSuperseded [element Component]

● Attribute UpgradeCode [element Validate]

● Attribute UserLanguage [element Control]

● Attribute Versioned [element Interface]

● Attribute Vital [element File]

● Attribute Vital [element ServiceInstall]

● Attribute Wait [element ServiceControl]

● Attribute WholeFile [element UpgradeFile]

● Attribute WholeFilesOnly [element PatchCreation]

● Attribute Win64 [element Component]

● Attribute Win64 [element CustomAction]

● Attribute Win64 [element RegistrySearch]

● Attribute Write [element Permission]

● Attribute WriteAttributes [element Permission]

● Attribute WriteExtendedAttributes [element Permission]

Definition

<xs:simpleType name="YesNoType"><xs:annotation><xs:documentation>Values of this type will either be "yes" or "no".</xs:documentation>

</xs:annotation><xs:restriction base="xs:NMTOKEN"><xs:enumeration value="no" /><xs:enumeration value="yes" />

</xs:restriction></xs:simpleType>

1338

Page 1339: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Index

AAbsent 521

Account 522

Action 523, 524, 525, 526, 527, 528, 529, 530, 531

ActionModuleSequenceType 1310

ActionSequenceType 1312

ActivateAtStorage 532

Admin 533

AdminExecuteSequence 30

AdminImage 534, 535

AdminUISequence 33

Advertise 536, 537, 538, 539, 540, 541, 542

AdvertiseExecuteSequence 35

After 543, 544, 545, 546

AllocateRegistrySpace 38

AllowAdvertise 547

AllowIgnoreOnError 548

AllowMajorVersionMismatches 549

AllowProductCodeMismatches 550

AllowRemoval 551, 552

ApiPatchingSymbolNoFailuresFlag 553

ApiPatchingSymbolNoImagehlpFlag 554

ApiPatchingSymbolUndecoratedTooFlag 555

AppData 39, 556

AppId 40, 558

AppSearch 45

Append 557

Argument 559, 560

Arguments 561, 562

Assembly 563

AssemblyApplication 564

AssemblyManifest 565

AssemblyName 47

AssignToProperty 566, 567

Attribute 568

Attributes 493

AutogenGuid 1316

BBefore 569, 570, 571, 572

Billboard 49

Page 1340: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

BillboardAction 51

Binary 53

BinaryKey 573

BinaryRef 55

BinarySource 574

BindImage 56

BindPath 575

Bitmap 576, 577

Blue 578

Bold 579

CCCPSearch 59

CDROM 584

Cabinet 580

Cancel 581

Category 57, 582

ChangePermission 585

CheckBoxValue 586

Checksum 587

Class 61, 588

Classification 589, 590

CleanWorkingFolder 591

ClientPatchId 592

Codepage 593, 594, 595, 596

Column 69, 597, 598

ComPlusFlags 608

ComboBox 74

ComboList 599

Command 600

CommandLine 601

Comments 602, 603

CompanionFile 604

Company 605, 606

Complex Types 1309

ComplianceCheck 76, 607

ComplianceDrive 78

Component 79

ComponentGroup 87

ComponentGroupRef 89

ComponentGuid 1317

ComponentGuidGenerationSeed 609

ComponentRef 91

ComponentSearch 93

Compressed 610, 611, 612

Page 1341: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

CompressionLevel 613

Condition 95

ConfigurableDirectory 614

Configuration 98

ConfigurationData 100

ContentType 615, 616

Context 617

ContextData 618

Control 101, 619, 620, 621

CopyFile 111

Cost 622

CostFinalize 115

CostInitialize 117

CreateChild 623

CreateFile 624

CreateFolder 118

CreateFolders 120

CreateLink 625

CreateShortcuts 121

CreateSubkeys 626

CreationTimeUTC 627

Custom 122

CustomAction 124

CustomActionRef 132

CustomPalette 628

CustomProperty 133

CustomTable 134

DData 135

Default 629, 630

DefaultLanguage 631

DefaultSize 632

DefaultValue 633

DefaultVersion 634

Delete 635, 636

DeleteChild 637

DeleteServices 136

Dependency 137, 638

Depth 639

Description 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652

DescriptionResourceDll 653

DescriptionResourceId 654

DestinationDirectory 655

DestinationLongName 656

Page 1342: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

DestinationName 657

DestinationProperty 658

DestinationShortName 659

Dialog 138, 660, 661

DialogRef 142

DigitalCertificate 143

DigitalSignature 144

Directory 145, 662, 663, 664, 665, 666, 667, 668, 669

DirectoryRef 149

DirectorySearch 151

DirectorySearchRef 153

DisableRegistryReflection 671

DisableRollback 155

Disabled 670

DiskId 672, 673, 674, 675, 676, 677

DiskPrompt 678, 679

Display 680

DisplayName 681, 682, 683, 684

DisplayResourceDll 685

DisplayResourceId 686

DllEntry 687

DllSurrogate 688

Domain 689

DriverName 690

DuplicateFiles 156

EElements 22

ElevationShield 691

EmbedCab 692

EmbeddedChainer 157

EmbeddedChainerRef 159

EmbeddedUI 160

EmbeddedUIResource 165

EnsureTable 167

EnumerateSubkeys 693

Environment 168

EraseDescription 694

Error 171, 695

ErrorControl 696

ErrorDialog 697

Event 698, 699

ExcludeExceptLanguage 703

ExcludeLanguage 704

ExcludeLanguages 705

Page 1343: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

ExcludedId 700

ExcludedMaxVersion 701

ExcludedMinVersion 702

Exclusion 172

ExeCommand 706

Execute 707, 708

ExecuteAction 174

Extension 175

ExternalFile 177

FFaceName 709

Family 179

Feature 181, 710, 711, 712

FeatureGroup 187

FeatureGroupRef 189

FeatureRef 191

Field 713

File 193, 714, 715, 716, 717, 718

FileCompression 719

FileCost 202

FileId 720

FileKey 721

FileSearch 204

FileSearchRef 207

FileSource 722, 723, 724

FileTypeMask 208

FindRelatedProducts 209

Fixed 725

FixedSize 726

Floppy 727

FontTitle 728

ForceReboot 211

Format 729

FormatSize 730

Fragment 212

GGenericAll 731

GenericExecute 732

GenericRead 733

GenericWrite 734

Green 735

Group 736

Guid 737, 738, 739, 1318

Page 1344: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

HHandler 740

HasBorder 741

HasDiskImage 742

Height 743, 744, 745

Help 746, 747

HelpDirectory 748

HelpKeyword 749

HelpLocation 750

HexType 1320

Hidden 751, 752, 753, 754, 755

HideTarget 756

Hotkey 757

IIcon 216, 758, 759, 760, 761, 762, 763

IconIndex 764, 765, 766

IconRef 218

IconSize 767

Id 768, 769, 770, 771, 772, 773, 774, 775, 776, 777, 778, 779, 780, 781, 782, 783, 784, 785, 786, 787, 788, 789, 790, 791, 792, 793, 794, 795, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811, 812, 813, 814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824, 825, 826, 827, 828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845, 846, 847, 848, 849, 850, 851, 852, 853, 854, 855, 856, 857, 858, 859, 860, 861, 862, 863

Ignore 864

IgnoreActionData 865

IgnoreActionStart 866

IgnoreAddExistingRow 867

IgnoreAddExistingTable 868

IgnoreChangingCodePage 869

IgnoreCommonData 870

IgnoreDeleteMissingRow 871

IgnoreDeleteMissingTable 872

IgnoreError 873

IgnoreFatalExit 874

IgnoreFilesInUse 875

IgnoreInfo 876

IgnoreInitialize 877

IgnoreMissingFiles 878

IgnoreModularization 219

IgnoreOutOfDiskSpace 879

IgnoreParent 880, 881

IgnoreProgress 882

IgnoreRMFilesInUse 885

IgnoreRange 221

IgnoreRemoveFailure 883

IgnoreResolveSource 884

IgnoreShowDialog 886

IgnoreTable 222

Page 1345: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

IgnoreTerminate 887

IgnoreUpdateMissingRow 888

IgnoreUser 889

IgnoreWarning 890

Image 891

Impersonate 892

Include 223

IncludeMaximum 893

IncludeMinimum 894

Indirect 895

IniFile 224

IniFileSearch 227

Insertable 896

InstallAdminPackage 230

InstallDefault 897

InstallExecute 231

InstallExecuteAgain 232

InstallExecuteSequence 233

InstallFiles 244

InstallFinalize 245

InstallInitialize 246

InstallODBC 247

InstallPrivileges 899

InstallScope 900

InstallServices 248

InstallUISequence 249

InstallValidate 252

InstallerVersion 898

Instance 253

InstanceTransforms 254

Integer 901

Interactive 902

Interface 255

IsolateComponent 257

IsolateComponents 258

Italic 903

JJScriptCall 904

KKeepModeless 905

Key 906, 907, 908, 909, 910, 911, 912, 913

KeyColumn 914

KeyNoOrphan 915

KeyPath 916, 917, 918, 919, 920

Page 1346: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

KeyTable 921

Keywords 922, 923

LLanguage 924, 925, 926, 927, 928

Languages 929, 930, 931

LaunchConditions 260

Layout 932

LeftScroll 933, 934

Length 935, 936

Level 937, 938

ListBox 262

ListItem 264

ListView 266

LoadOrderGroup 939

LocalService 941

Localizable 940

LocalizableInteger 1321

Location 942

LongFileNameType 1322

LongName 943, 944, 945, 946, 947, 948, 949

LongSource 950

MMIME 276

MajorVersion 951

Manufacturer 952, 953, 954, 955

ManufacturerName 956

Mask 957

MaxDate 958

MaxSize 960

MaxValue 961

MaxVersion 962

Maximum 959

Media 268

MediaSrcProp 963

Merge 271

MergeRef 273

Message 964

MigrateFeatureStates 275

MigrateFeatures 965

MinDate 966

MinSize 971

MinValue 972

MinVersion 973

Minimum 967

Page 1347: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

MinorUpdateTargetRTM 968, 969

MinorVersion 970

Modeless 974

Modularize 975

Module 278

MoreInfoURL 976, 977

MoveFiles 282

MsiPublishAssemblies 283

MsiUnpublishAssemblies 284

MultiStringValue 285

Multiline 978

NName 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994, 995, 996, 997, 998, 999, 1000, 1001, 1002, 1003, 1004, 1005

NeverOverwrite 1006

NoMinimize 1007

NoOpen 1009

NoPrefix 1010

NoWrap 1012

NonNullable 1008

Notify 1011

Nullable 1013

NumMethods 1014

OODBCDataSource 286

ODBCDriver 288

ODBCTranslator 290

Offset 1015, 1016, 1017

On 1018, 1019

OnExit 1020, 1021

OnlyDetect 1022

OptimizeCustomActions 292

OptimizePatchSizeForLargeFiles 1025

OptimizedInstallMode 1023, 1024

Order 1026, 1027, 1028

OutputPath 1029

Overridable 1030, 1031, 1032, 1033

PPackage 293

Parent 1034

Part 1035

Password 1036, 1037

Patch 298

PatchAllowIgnoreOnError 1038

Page 1348: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

PatchBaseline 303

PatchCertificates 304

PatchClassificationType 1324

PatchCreation 305

PatchFamily 309, 1039

PatchFamilyRef 312

PatchFiles 313

PatchGroup 1040

PatchIgnore 1041

PatchInformation 314

PatchMetadata 317

PatchProperty 320

PatchSequence 321

PatchUninstall 1042

PatchWholeFile 1043

Path 1044, 1045, 1046

Permanent 1047, 1048

Permission 323

Platform 1049

Platforms 1050, 1051

Primary 1052, 1053, 1054, 1055

PrimaryKey 1056

ProcessComponents 327

ProcessorArchitecture 1057

Product 328

ProductCode 1058, 1059, 1060

ProductId 1061

ProductLanguage 1062

ProductName 1063

ProductVersion 1064

ProductVersionOperator 1065

ProgId 333

Programmable 1066

ProgressBlocks 1067

ProgressText 335

Property 336, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079

PropertyRef 340

PropertySource 1080

ProtectFile 341

ProtectRange 342

ProxyStubClassId 1081

ProxyStubClassId32 1082

Publish 343

PublishComponents 346

Page 1349: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

PublishFeatures 347

PublishProduct 348

PushLike 1083

QQualifier 1084

RRAMDisk 1085

RMCCPSearch 403

RadioButton 349

RadioButtonGroup 351

Read 1086

ReadAttributes 1087

ReadExtendedAttributes 1088

ReadOnly 1089, 1090, 1091

ReadPermission 1092

Red 1093

RegisterClassInfo 353

RegisterComPlus 354

RegisterExtensionInfo 355

RegisterFonts 356

RegisterMIMEInfo 357

RegisterProduct 358

RegisterProgIdInfo 359

RegisterTypeLibraries 360

RegisterUser 361

Registration 1094

Registry 362

RegistryKey 367

RegistryRootType 1326

RegistrySearch 370

RegistrySearchRef 374

RegistryValue 375

RelativePath 1095

Remote 1096

RemoteServerName 1097

Removable 1098

Remove 1099

RemoveDuplicateFiles 380

RemoveEnvironmentStrings 381

RemoveExistingProducts 382

RemoveFeatures 1100

RemoveFile 383

RemoveFiles 386

RemoveFolder 387

Page 1350: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

RemoveFolders 390

RemoveIniValues 391

RemoveODBC 392

RemoveRegistryKey 393

RemoveRegistryValue 395

RemoveRegistryValues 397

RemoveShortcuts 398

ReplacePatch 399

RequiredId 1101

RequiredLanguage 1102

RequiredVersion 1103, 1104

ReserveCost 400

ResolveSource 402

ResourceId 1105

Restricted 1106

Return 1107

RightAligned 1108, 1109

RightToLeft 1110, 1111

Root 1112, 1113, 1114, 1115, 1116, 1117

Row 405, 1118

RunAsInteractiveUser 1119

RunFromSource 1120

RunLocal 1121

SSFPCatalog 427

SFPFile 429

SafeForInitializing 1122

SafeForScripting 1123

ScheduleReboot 406

Script 1124

Section 1125, 1126

Secure 1127

SelfRegCost 1128

SelfRegModules 407

SelfUnregModules 408

Separator 1129

Sequence 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137

SequenceStart 1138

Server 1139

ServiceArgument 409

ServiceControl 410

ServiceDependency 414

ServiceInstall 415

ServiceParameters 1140

Page 1351: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Set 1141

SetDirectory 420

SetODBCFolders 423

SetProperty 424

SetupFile 1142, 1143

Shared 1144, 1145

SharedDllRefCount 1146

ShortFileNameType 1328

ShortName 1147, 1148, 1149, 1150, 1151, 1152, 1153

ShortNames 1154, 1155

ShortPath 1156

ShortSourceName 1157

Shortcut 430

Show 436, 1158

ShowRollbackCost 1159

Simple Types 1315

Size 1160

SkipAssignment 1161

SkipDeferred 1162

SkipImmediate 1163

Sorted 1164

Source 1165, 1166, 1167

SourceDirectory 1168

SourceFile 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179

SourceList 1180

SourceName 1181, 1182

SourcePatch 1183

SourceProperty 1184

src 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195

srcPatch 1196

Start 1197, 1198

StartServices 438

Stop 1199

StopServices 439

Strike 1200

Subscribe 440

Substitution 441

SummaryCodepage 1201, 1202

Sunken 1203

Supersede 1204, 1205

SupportBasicUI 1206

Suppress 1207, 1208

SuppressModularization 1209, 1210, 1211

SymbolFlags 1212

Page 1352: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

SymbolPath 443

Synchronize 1213

System 1214, 1215

SystemModal 1216

TTabSkip 1218

Table 1217

TakeOwnership 1219

Target 1220, 1221, 1222

TargetFile 444, 1223

TargetImage 445, 1224

TargetProductCode 447

TargetProductName 1225, 1226

TargetProperty 1227

Template 1228

TerminalServerAware 1229

Text 448, 1230, 1231, 1232

TextStyle 449

ThreadingModel 1233

Title 1234, 1235

ToolTip 1236, 1237

TrackDiskSpace 1238

Transitive 1239

Transparent 1240

Traverse 1241

TrueType 1242

Type 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252

TypeLib 451

TypicalDefault 1253

UUI 455

UIRef 458

UIText 459

Underline 1254

UninstallWhenSuperseded 1255

UnpublishComponents 460

UnpublishFeatures 461

UnregisterClassInfo 462

UnregisterComPlus 463

UnregisterExtensionInfo 464

UnregisterFonts 465

UnregisterMIMEInfo 466

UnregisterProgIdInfo 467

UnregisterTypeLibraries 468

Page 1353: WiX Database XML Schema -   · PDF fileComboList [element Control ... WiX Database XML Schema

Upgrade 469

UpgradeCode 1256, 1257

UpgradeFile 471

UpgradeImage 473

UpgradeVersion 475

User 1258

UserLanguage 1259

VVBScriptCall 1279

Validate 478

ValidateProductID 481

Validation 1260

Value 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278

Verb 483

Version 1280, 1281, 1282, 1283

VersionType 1329

Versioned 1284

Vital 1285, 1286

VolumeLabel 1287, 1288

WWait 1289

WholeFile 1290

WholeFilesOnly 1291

WiX Database XML Schema 21

Width 1292, 1293, 1294, 1295

WildCardLongFileNameType 1330

WildCardShortFileNameType 1331

Win64 1296, 1297, 1298

Wix 486

WixVariable 488

WorkingDirectory 1299

Write 1300

WriteAttributes 1301

WriteEnvironmentStrings 490

WriteExtendedAttributes 1302

WriteIniValues 491

WriteRegistryValues 492

XX 1303, 1304, 1305

YY 1306, 1307, 1308

YesNoDefaultType 1332

YesNoType 1333