summaryrefslogtreecommitdiff
path: root/src/xsd/bal.xsd
diff options
context:
space:
mode:
authorRob Mensching <rob@firegiant.com>2025-02-14 12:53:59 -0800
committerRob Mensching <rob@firegiant.com>2025-03-18 15:55:06 -0700
commit777b28beb32b2013e9feb77a9a18af397265f4ba (patch)
treea4700ebafdb4ad80be301a6814a490e7b189b202 /src/xsd/bal.xsd
parent1f48dfeb5bc15bb9d3e90ac6b236dbff77819561 (diff)
downloadwix-777b28beb32b2013e9feb77a9a18af397265f4ba.tar.gz
wix-777b28beb32b2013e9feb77a9a18af397265f4ba.tar.bz2
wix-777b28beb32b2013e9feb77a9a18af397265f4ba.zip
Migrate XSDs from web project
This is the new home for the XSDs. Closer to the code to hopefully be kept better up to date as changes happen to the language.
Diffstat (limited to 'src/xsd/bal.xsd')
-rw-r--r--src/xsd/bal.xsd745
1 files changed, 745 insertions, 0 deletions
diff --git a/src/xsd/bal.xsd b/src/xsd/bal.xsd
new file mode 100644
index 00000000..ff4142ad
--- /dev/null
+++ b/src/xsd/bal.xsd
@@ -0,0 +1,745 @@
1<?xml version="1.0" encoding="utf-8"?>
2<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
3
4
5<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
6 xmlns:xse="http://wixtoolset.org/schemas/XmlSchemaExtension"
7 xmlns:html="http://www.w3.org/1999/xhtml"
8 xmlns:wxs="http://wixtoolset.org/schemas/v4/wxs"
9 targetNamespace="http://wixtoolset.org/schemas/v4/wxs/bal"
10 xmlns="http://wixtoolset.org/schemas/v4/wxs/bal">
11 <xs:annotation>
12 <xs:documentation>
13 The source code schema for the WiX Toolset Bootstrapper Applications Extension.
14 </xs:documentation>
15 </xs:annotation>
16
17 <xs:import namespace="http://wixtoolset.org/schemas/v4/wxs" />
18
19 <xs:element name="Condition">
20 <xs:annotation>
21 <xs:documentation>
22 Conditions for a bundle using WixStdBA.
23 </xs:documentation>
24 <xs:appinfo>
25 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
26 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
27 </xs:appinfo>
28 </xs:annotation>
29 <xs:complexType>
30 <xs:choice minOccurs="0" maxOccurs="unbounded">
31 <xs:any namespace="##other" processContents="lax">
32 <xs:annotation>
33 <xs:documentation>
34 Extensibility point in the WiX XML Schema. Schema extensions can register additional
35 elements at this point in the schema.
36 </xs:documentation>
37 </xs:annotation>
38 </xs:any>
39 </xs:choice>
40 <xs:attribute name="Message" type="xs:string" use="required">
41 <xs:annotation>
42 <xs:documentation>
43 Set the value to the text to display when the condition fails and the installation must be terminated.
44 </xs:documentation>
45 </xs:annotation>
46 </xs:attribute>
47 <xs:attribute name="Condition" type="xs:string" use="required">
48 <xs:annotation>
49 <xs:documentation>
50 The condition that must evaluate to true for the installation to continue.
51 </xs:documentation>
52 </xs:annotation>
53 </xs:attribute>
54 <xs:anyAttribute namespace="##other" processContents="lax">
55 <xs:annotation>
56 <xs:documentation>
57 Extensibility point in the WiX XML Schema. Schema extensions can register additional
58 attributes at this point in the schema.
59 </xs:documentation>
60 </xs:annotation>
61 </xs:anyAttribute>
62 </xs:complexType>
63 </xs:element>
64
65 <xs:element name="WixInternalUIBootstrapperApplication">
66 <xs:annotation>
67 <xs:documentation>
68 Uses WixInternalUIBootstrapperApplication as the Bootstrapper Application for a Bundle.
69 WixInternalUIBootstrapperApplication has no UI itself, it relies on the splash screen, prereq BA, and MSI UI.
70
71 wixiuiba is not a typical BA because it has very specific requirements for the packages in the chain.
72 There can only be one non-permanent package in the chain, and it needs to be the last package.
73 The only exception is that multiple non-permanent packages can be specified with bal:PrimaryPackageType with a specific architecture.
74 Each primary package must be an MsiPackage that contains UI for install and maintenance.
75
76 If there are permanent packages, then they are always installed through the same prereq BA that is used for the managed BA hosts before executing the primary package.
77
78 Due to Windows limitations, a splash screen should be provided so that the elevation prompt and MSI UI is automatically given focus.
79 </xs:documentation>
80 <xs:appinfo>
81 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplication" />
82 </xs:appinfo>
83 </xs:annotation>
84 <xs:complexType>
85 <xs:choice minOccurs="0" maxOccurs="unbounded">
86 <xs:any namespace="##other" processContents="lax">
87 <xs:annotation>
88 <xs:documentation>
89 Extensibility point in the WiX XML Schema. Schema extensions can register additional
90 elements at this point in the schema.
91 </xs:documentation>
92 </xs:annotation>
93 </xs:any>
94 </xs:choice>
95 <xs:attribute name="LogoFile" type="xs:string">
96 <xs:annotation>
97 <xs:documentation>Source file of the logo graphic.</xs:documentation>
98 </xs:annotation>
99 </xs:attribute>
100 <xs:attribute name="ThemeFile" type="xs:string">
101 <xs:annotation>
102 <xs:documentation>Source file of the theme XML.</xs:documentation>
103 </xs:annotation>
104 </xs:attribute>
105 <xs:attribute name="LocalizationFile" type="xs:string">
106 <xs:annotation>
107 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
108 </xs:annotation>
109 </xs:attribute>
110 <xs:attribute name="Theme">
111 <xs:annotation>
112 <xs:documentation>The built-in theme to use.</xs:documentation>
113 </xs:annotation>
114 <xs:simpleType>
115 <xs:restriction base="xs:NMTOKEN">
116 <xs:enumeration value="none" />
117 <xs:enumeration value="standard" />
118 </xs:restriction>
119 </xs:simpleType>
120 </xs:attribute>
121 <xs:anyAttribute namespace="##other" processContents="lax">
122 <xs:annotation>
123 <xs:documentation>
124 Extensibility point in the WiX XML Schema. Schema extensions can register additional
125 attributes at this point in the schema.
126 </xs:documentation>
127 </xs:annotation>
128 </xs:anyAttribute>
129 </xs:complexType>
130 </xs:element>
131
132 <xs:element name="WixStandardBootstrapperApplication">
133 <xs:annotation>
134 <xs:documentation>
135 Uses WixStandardBootstrapperApplication as the Bootstrapper Application for a Bundle.
136 </xs:documentation>
137 <xs:appinfo>
138 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplication" />
139 </xs:appinfo>
140 </xs:annotation>
141 <xs:complexType>
142 <xs:choice minOccurs="0" maxOccurs="unbounded">
143 <xs:any namespace="##other" processContents="lax">
144 <xs:annotation>
145 <xs:documentation>
146 Extensibility point in the WiX XML Schema. Schema extensions can register additional
147 elements at this point in the schema.
148 </xs:documentation>
149 </xs:annotation>
150 </xs:any>
151 </xs:choice>
152 <xs:attribute name="LaunchTarget" type="xs:string">
153 <xs:annotation>
154 <xs:documentation>
155 If set, the success page will show a Launch button the user can use to launch the application being installed.
156 The string value can be formatted using Burn variables enclosed in brackets,
157 to refer to installation directories and so forth.
158 </xs:documentation>
159 </xs:annotation>
160 </xs:attribute>
161 <xs:attribute name="LaunchTargetElevatedId" type="xs:string">
162 <xs:annotation>
163 <xs:documentation>
164 Id of the target ApprovedExeForElevation element.
165 If set with LaunchTarget, WixStdBA will launch the application through the Engine's LaunchApprovedExe method instead of through ShellExecute.
166 </xs:documentation>
167 </xs:annotation>
168 </xs:attribute>
169 <xs:attribute name="LaunchArguments" type="xs:string">
170 <xs:annotation>
171 <xs:documentation>
172 If set, WixStdBA will supply these arguments when launching the application specified by the LaunchTarget attribute.
173 The string value can be formatted using Burn variables enclosed in brackets,
174 to refer to installation directories and so forth.
175 </xs:documentation>
176 </xs:annotation>
177 </xs:attribute>
178 <xs:attribute name="LaunchHidden" type="wxs:YesNoTypeUnion">
179 <xs:annotation>
180 <xs:documentation>
181 If set to "yes", WixStdBA will launch the application specified by the LaunchTarget attribute with the SW_HIDE flag.
182 This attribute is ignored when the LaunchTargetElevatedId attribute is specified.
183 </xs:documentation>
184 </xs:annotation>
185 </xs:attribute>
186 <xs:attribute name="LaunchWorkingFolder" type="xs:string">
187 <xs:annotation>
188 <xs:documentation>
189 WixStdBA will use this working folder when launching the specified application.
190 The string value can be formatted using Burn variables enclosed in brackets,
191 to refer to installation directories and so forth.
192 This attribute is ignored when the LaunchTargetElevatedId attribute is specified.
193 </xs:documentation>
194 </xs:annotation>
195 </xs:attribute>
196 <xs:attribute name="LicenseFile" type="xs:string">
197 <xs:annotation>
198 <xs:documentation>Source file of the RTF license file. Cannot be used simultaneously with LicenseUrl.</xs:documentation>
199 </xs:annotation>
200 </xs:attribute>
201 <xs:attribute name="LicenseUrl" type="xs:string">
202 <xs:annotation>
203 <xs:documentation>URL target of the license link. Cannot be used simultaneously with LicenseFile. This attribute can be empty to hide the license link completely.</xs:documentation>
204 </xs:annotation>
205 </xs:attribute>
206 <xs:attribute name="LogoFile" type="xs:string">
207 <xs:annotation>
208 <xs:documentation>Source file of the logo graphic.</xs:documentation>
209 </xs:annotation>
210 </xs:attribute>
211 <xs:attribute name="LogoSideFile" type="xs:string">
212 <xs:annotation>
213 <xs:documentation>Source file of the side logo graphic.</xs:documentation>
214 </xs:annotation>
215 </xs:attribute>
216 <xs:attribute name="ThemeFile" type="xs:string">
217 <xs:annotation>
218 <xs:documentation>Source file of the theme XML.</xs:documentation>
219 </xs:annotation>
220 </xs:attribute>
221 <xs:attribute name="LocalizationFile" type="xs:string">
222 <xs:annotation>
223 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
224 </xs:annotation>
225 </xs:attribute>
226 <xs:attribute name="SuppressOptionsUI" type="wxs:YesNoTypeUnion">
227 <xs:annotation>
228 <xs:documentation>If set to "yes", the Options button will not be shown and the user will not be able to choose an installation directory.</xs:documentation>
229 </xs:annotation>
230 </xs:attribute>
231 <xs:attribute name="SuppressDowngradeFailure" type="wxs:YesNoTypeUnion">
232 <xs:annotation>
233 <xs:documentation>
234 If set to "yes", attempting to installer a downgraded version of a bundle will be treated as a successful do-nothing operation.
235 The default behavior (or when explicitly set to "no") is to treat downgrade attempts as failures.
236 </xs:documentation>
237 </xs:annotation>
238 </xs:attribute>
239 <xs:attribute name="SuppressRepair" type="wxs:YesNoTypeUnion">
240 <xs:annotation>
241 <xs:documentation>If set to "yes", the Repair button will not be shown in the maintenance-mode UI.</xs:documentation>
242 </xs:annotation>
243 </xs:attribute>
244 <xs:attribute name="ShowVersion" type="wxs:YesNoTypeUnion">
245 <xs:annotation>
246 <xs:documentation>If set to "yes", the application version will be displayed on the UI.</xs:documentation>
247 </xs:annotation>
248 </xs:attribute>
249 <xs:attribute name="SupportCacheOnly" type="wxs:YesNoTypeUnion">
250 <xs:annotation>
251 <xs:documentation>If set to "yes", the bundle can be pre-cached using the /cache command line argument.</xs:documentation>
252 </xs:annotation>
253 </xs:attribute>
254 <xs:attribute name="Theme" use="required">
255 <xs:annotation>
256 <xs:documentation>The built-in theme to use.</xs:documentation>
257 </xs:annotation>
258 <xs:simpleType>
259 <xs:restriction base="xs:NMTOKEN">
260 <xs:enumeration value="hyperlinkLargeLicense" />
261 <xs:enumeration value="hyperlinkLicense" />
262 <xs:enumeration value="hyperlinkSidebarLicense" />
263 <xs:enumeration value="none" />
264 <xs:enumeration value="rtfLargeLicense" />
265 <xs:enumeration value="rtfLicense" />
266 </xs:restriction>
267 </xs:simpleType>
268 </xs:attribute>
269 <xs:anyAttribute namespace="##other" processContents="lax">
270 <xs:annotation>
271 <xs:documentation>
272 Extensibility point in the WiX XML Schema. Schema extensions can register additional
273 attributes at this point in the schema.
274 </xs:documentation>
275 </xs:annotation>
276 </xs:anyAttribute>
277 </xs:complexType>
278 </xs:element>
279
280 <xs:element name="WixManagedBootstrapperApplicationHost">
281 <xs:annotation>
282 <xs:documentation>
283 Uses WixManagedBootstrapperApplicationHost as the Bootstrapper Application for a Bundle.
284
285 _Available in WiX v4. Deprecated in WiX v5; use WixPrerequisiteBootstrapperApplication instead._
286 </xs:documentation>
287 <xs:appinfo>
288 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplication" />
289 </xs:appinfo>
290 </xs:annotation>
291 <xs:complexType>
292 <xs:choice minOccurs="0" maxOccurs="unbounded">
293 <xs:any namespace="##other" processContents="lax">
294 <xs:annotation>
295 <xs:documentation>
296 Extensibility point in the WiX XML Schema. Schema extensions can register additional
297 elements at this point in the schema.
298 </xs:documentation>
299 </xs:annotation>
300 </xs:any>
301 </xs:choice>
302 <xs:attribute name="AlwaysInstallPrereqs" type="xs:string">
303 <xs:annotation>
304 <xs:documentation>
305 When not set or set to "no", the prereq BA is only used when the .NET Framework runtime can't be loaded.
306 When set to "yes", the prereq BA will always run before the .NET Framework runtime is attempted to be loaded.
307 If set to "yes" and all prereq packages are already installed, then the prereq BA's UI is not shown.
308 </xs:documentation>
309 </xs:annotation>
310 </xs:attribute>
311 <xs:attribute name="LogoFile" type="xs:string">
312 <xs:annotation>
313 <xs:documentation>Source file of the logo graphic.</xs:documentation>
314 </xs:annotation>
315 </xs:attribute>
316 <xs:attribute name="ThemeFile" type="xs:string">
317 <xs:annotation>
318 <xs:documentation>Source file of the theme XML.</xs:documentation>
319 </xs:annotation>
320 </xs:attribute>
321 <xs:attribute name="LocalizationFile" type="xs:string">
322 <xs:annotation>
323 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
324 </xs:annotation>
325 </xs:attribute>
326 <xs:attribute name="Theme">
327 <xs:annotation>
328 <xs:documentation>The built-in theme to use. The default is "standard".</xs:documentation>
329 </xs:annotation>
330 <xs:simpleType>
331 <xs:restriction base="xs:NMTOKEN">
332 <xs:enumeration value="none" />
333 <xs:enumeration value="standard" />
334 </xs:restriction>
335 </xs:simpleType>
336 </xs:attribute>
337 <xs:anyAttribute namespace="##other" processContents="lax">
338 <xs:annotation>
339 <xs:documentation>
340 Extensibility point in the WiX XML Schema. Schema extensions can register additional
341 attributes at this point in the schema.
342 </xs:documentation>
343 </xs:annotation>
344 </xs:anyAttribute>
345 </xs:complexType>
346 </xs:element>
347
348 <xs:element name="ManagedBootstrapperApplicationPrereqInformation">
349 <xs:annotation>
350 <xs:documentation>
351 Adds license information for a prereq package, should only be used when unable to add the license attributes to the package directly.
352
353 _Available in WiX v4. Deprecated in WiX v5; use BootstrapperApplicationPrerequisiteInformation instead._
354 </xs:documentation>
355 <xs:appinfo>
356 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
357 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
358 </xs:appinfo>
359 </xs:annotation>
360 <xs:complexType>
361 <xs:choice minOccurs="0" maxOccurs="unbounded">
362 <xs:any namespace="##other" processContents="lax">
363 <xs:annotation>
364 <xs:documentation>
365 Extensibility point in the WiX XML Schema. Schema extensions can register additional
366 elements at this point in the schema.
367 </xs:documentation>
368 </xs:annotation>
369 </xs:any>
370 </xs:choice>
371 <xs:attribute name="PackageId" type="xs:string" use="required">
372 <xs:annotation>
373 <xs:documentation>Id of the target package.</xs:documentation>
374 </xs:annotation>
375 </xs:attribute>
376 <xs:attribute name="LicenseFile" type="xs:string">
377 <xs:annotation>
378 <xs:documentation>Source file of the license. May not be used with LicenseUrl.</xs:documentation>
379 </xs:annotation>
380 </xs:attribute>
381 <xs:attribute name="LicenseUrl" type="xs:string">
382 <xs:annotation>
383 <xs:documentation>Source url of the license. May not be used with LicenseFile.</xs:documentation>
384 </xs:annotation>
385 </xs:attribute>
386 <xs:anyAttribute namespace="##other" processContents="lax">
387 <xs:annotation>
388 <xs:documentation>
389 Extensibility point in the WiX XML Schema. Schema extensions can register additional
390 attributes at this point in the schema.
391 </xs:documentation>
392 </xs:annotation>
393 </xs:anyAttribute>
394 </xs:complexType>
395 </xs:element>
396
397 <xs:element name="WixDotNetCoreBootstrapperApplicationHost">
398 <xs:annotation>
399 <xs:documentation>
400 Uses WixDotNetCoreBootstrapperApplicationHost as the Bootstrapper Application for a Bundle.
401
402 _Available in WiX v4. Deprecated in WiX v5; use WixPrerequisiteBootstrapperApplication instead._
403 </xs:documentation>
404 <xs:appinfo>
405 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplication" />
406 </xs:appinfo>
407 </xs:annotation>
408 <xs:complexType>
409 <xs:choice minOccurs="0" maxOccurs="unbounded">
410 <xs:any namespace="##other" processContents="lax">
411 <xs:annotation>
412 <xs:documentation>
413 Extensibility point in the WiX XML Schema. Schema extensions can register additional
414 elements at this point in the schema.
415 </xs:documentation>
416 </xs:annotation>
417 </xs:any>
418 </xs:choice>
419 <xs:attribute name="AlwaysInstallPrereqs" type="wxs:YesNoTypeUnion">
420 <xs:annotation>
421 <xs:documentation>
422 When not set or set to "no", the prereq BA is only used when the .NET Core runtime can't be loaded.
423 When set to "yes", the prereq BA will always run before the .NET Core runtime is attempted to be loaded.
424 If set to "yes" and all prereq packages are already installed, then the prereq BA's UI is not shown.
425 </xs:documentation>
426 </xs:annotation>
427 </xs:attribute>
428 <xs:attribute name="LogoFile" type="xs:string">
429 <xs:annotation>
430 <xs:documentation>Source file of the logo graphic.</xs:documentation>
431 </xs:annotation>
432 </xs:attribute>
433 <xs:attribute name="ThemeFile" type="xs:string">
434 <xs:annotation>
435 <xs:documentation>Source file of the theme XML.</xs:documentation>
436 </xs:annotation>
437 </xs:attribute>
438 <xs:attribute name="LocalizationFile" type="xs:string">
439 <xs:annotation>
440 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
441 </xs:annotation>
442 </xs:attribute>
443 <xs:attribute name="SelfContainedDeployment" type="wxs:YesNoTypeUnion">
444 <xs:annotation>
445 <xs:documentation>
446 Whether the .NET Core BA was published as self-contained (SCD).
447 </xs:documentation>
448 </xs:annotation>
449 </xs:attribute>
450 <xs:attribute name="Theme">
451 <xs:annotation>
452 <xs:documentation>The built-in theme to use. The default value is "standard".</xs:documentation>
453 </xs:annotation>
454 <xs:simpleType>
455 <xs:restriction base="xs:NMTOKEN">
456 <xs:enumeration value="none" />
457 <xs:enumeration value="standard" />
458 </xs:restriction>
459 </xs:simpleType>
460 </xs:attribute>
461 <xs:anyAttribute namespace="##other" processContents="lax">
462 <xs:annotation>
463 <xs:documentation>
464 Extensibility point in the WiX XML Schema. Schema extensions can register additional
465 attributes at this point in the schema.
466 </xs:documentation>
467 </xs:annotation>
468 </xs:anyAttribute>
469 </xs:complexType>
470 </xs:element>
471
472 <xs:element name="WixPrerequisiteBootstrapperApplication">
473 <xs:annotation>
474 <xs:documentation>
475 Uses WixPrerequisiteBootstrapperApplication as a secondary Bootstrapper Application for a Bundle,
476 to bootstrap the prerequisites needed for a primary bootstrapper application.
477
478 _Available in WiX v5._
479 </xs:documentation>
480 <xs:appinfo>
481 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplication" />
482 </xs:appinfo>
483 </xs:annotation>
484 <xs:complexType>
485 <xs:choice minOccurs="0" maxOccurs="unbounded">
486 <xs:any namespace="##other" processContents="lax">
487 <xs:annotation>
488 <xs:documentation>
489 Extensibility point in the WiX XML Schema. Schema extensions can register additional
490 elements at this point in the schema.
491 </xs:documentation>
492 </xs:annotation>
493 </xs:any>
494 </xs:choice>
495 <xs:attribute name="LogoFile" type="xs:string">
496 <xs:annotation>
497 <xs:documentation>Source file of the logo graphic.</xs:documentation>
498 </xs:annotation>
499 </xs:attribute>
500 <xs:attribute name="ThemeFile" type="xs:string">
501 <xs:annotation>
502 <xs:documentation>Source file of the theme XML.</xs:documentation>
503 </xs:annotation>
504 </xs:attribute>
505 <xs:attribute name="LocalizationFile" type="xs:string">
506 <xs:annotation>
507 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
508 </xs:annotation>
509 </xs:attribute>
510 <xs:attribute name="Theme">
511 <xs:annotation>
512 <xs:documentation>The built-in theme to use. The default is "standard".</xs:documentation>
513 </xs:annotation>
514 <xs:simpleType>
515 <xs:restriction base="xs:NMTOKEN">
516 <xs:enumeration value="none" />
517 <xs:enumeration value="standard" />
518 </xs:restriction>
519 </xs:simpleType>
520 </xs:attribute>
521 <xs:anyAttribute namespace="##other" processContents="lax">
522 <xs:annotation>
523 <xs:documentation>
524 Extensibility point in the WiX XML Schema. Schema extensions can register additional
525 attributes at this point in the schema.
526 </xs:documentation>
527 </xs:annotation>
528 </xs:anyAttribute>
529 </xs:complexType>
530 </xs:element>
531
532 <xs:element name="BootstrapperApplicationPrerequisiteInformation">
533 <xs:annotation>
534 <xs:documentation>
535 Adds license information for a prereq package, should only be used when unable to add the license attributes to the package directly.
536
537 _Available in WiX v5._
538 </xs:documentation>
539 <xs:appinfo>
540 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
541 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
542 </xs:appinfo>
543 </xs:annotation>
544 <xs:complexType>
545 <xs:choice minOccurs="0" maxOccurs="unbounded">
546 <xs:any namespace="##other" processContents="lax">
547 <xs:annotation>
548 <xs:documentation>
549 Extensibility point in the WiX XML Schema. Schema extensions can register additional
550 elements at this point in the schema.
551 </xs:documentation>
552 </xs:annotation>
553 </xs:any>
554 </xs:choice>
555 <xs:attribute name="PackageId" type="xs:string" use="required">
556 <xs:annotation>
557 <xs:documentation>Id of the target package.</xs:documentation>
558 </xs:annotation>
559 </xs:attribute>
560 <xs:attribute name="LicenseFile" type="xs:string">
561 <xs:annotation>
562 <xs:documentation>Source file of the license. May not be used with LicenseUrl.</xs:documentation>
563 </xs:annotation>
564 </xs:attribute>
565 <xs:attribute name="LicenseUrl" type="xs:string">
566 <xs:annotation>
567 <xs:documentation>Source url of the license. May not be used with LicenseFile.</xs:documentation>
568 </xs:annotation>
569 </xs:attribute>
570 <xs:anyAttribute namespace="##other" processContents="lax">
571 <xs:annotation>
572 <xs:documentation>
573 Extensibility point in the WiX XML Schema. Schema extensions can register additional
574 attributes at this point in the schema.
575 </xs:documentation>
576 </xs:annotation>
577 </xs:anyAttribute>
578 </xs:complexType>
579 </xs:element>
580
581 <xs:attribute name="BAFactoryAssembly" type="wxs:YesNoTypeUnion">
582 <xs:annotation>
583 <xs:documentation>
584 When set to "yes", WixDotNetCoreBootstrapperApplicationHost will load the DLL and instantiate the type with the BootstrapperApplicationFactoryAttribute.
585 The DLL must have been built referencing the WixToolset.Dnc.HostGenerator source generator NuGet package.
586 The .NET Core project must have been published, not just built.
587 Only one payload may be marked with this attribute set to "yes".
588
589 _Available in WiX v4. Deprecated in WiX v5. Move the Payload/@SourceFile attribute to be the BootstrapperApplication/@SourceFile attribute and remove the Payload element._
590 </xs:documentation>
591 <xs:appinfo>
592 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Payload" />
593 </xs:appinfo>
594 </xs:annotation>
595 </xs:attribute>
596
597 <xs:attribute name="BAFunctions" type="wxs:YesNoTypeUnion">
598 <xs:annotation>
599 <xs:documentation>
600 When set to "yes", WixStdBA will load the DLL and work with it to handle BA messages.
601 Only one payload may be marked with this attribute set to "yes".
602 </xs:documentation>
603 <xs:appinfo>
604 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Payload" />
605 </xs:appinfo>
606 </xs:annotation>
607 </xs:attribute>
608
609 <xs:attribute name="CommandLineVariables">
610 <xs:annotation>
611 <xs:documentation>
612 This value determines whether case sensitivity is used to match overridable variables specified on the command line. The default is "caseSensitive".
613 </xs:documentation>
614 <xs:appinfo>
615 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
616 </xs:appinfo>
617 </xs:annotation>
618 <xs:simpleType>
619 <xs:restriction base="xs:NMTOKEN">
620 <xs:enumeration value="caseSensitive" />
621 <xs:enumeration value="caseInsensitive" />
622 </xs:restriction>
623 </xs:simpleType>
624 </xs:attribute>
625
626 <xs:attribute name="DisplayInternalUICondition" type="xs:string">
627 <xs:annotation>
628 <xs:documentation>
629 Specifies whether the bundle will show the UI authored into the msi package. If not specified or the condition evaluates
630 to false, all information is routed to the bootstrapper application to provide a unified installation experience.
631 Otherwise, the UI authored into the msi package will be displayed on top of any bootstrapper application UI.
632 WixStdBA doesn't support EmbeddedUI.
633 </xs:documentation>
634 <xs:appinfo>
635 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
636 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
637 </xs:appinfo>
638 </xs:annotation>
639 </xs:attribute>
640
641 <xs:attribute name="Overridable" type="wxs:YesNoTypeUnion">
642 <xs:annotation>
643 <xs:documentation>
644 When set to "yes", lets the user override the variable's default value by specifying another value on the command line,
645 in the form Variable=Value. Otherwise, WixStdBA won't overwrite the default value and will log
646 "Ignoring attempt to set non-overridable variable: 'BAR'."
647 </xs:documentation>
648 <xs:appinfo>
649 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Variable" />
650 </xs:appinfo>
651 </xs:annotation>
652 </xs:attribute>
653
654 <xs:attribute name="PrereqLicenseFile" type="xs:string">
655 <xs:annotation>
656 <xs:documentation>
657 Source file of the RTF license file.
658 There may only be one package in the bundle that has either the PrereqLicenseFile attribute or the PrereqLicenseUrl attribute.
659 </xs:documentation>
660 <xs:appinfo>
661 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
662 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
663 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
664 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
665 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
666 </xs:appinfo>
667 </xs:annotation>
668 </xs:attribute>
669
670 <xs:attribute name="PrereqLicenseUrl" type="xs:string">
671 <xs:annotation>
672 <xs:documentation>
673 URL target of the license link.
674 There may only be one package in the bundle that has either the PrereqLicenseFile attribute or the PrereqLicenseUrl attribute.
675 </xs:documentation>
676 <xs:appinfo>
677 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
678 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
679 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
680 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
681 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
682 </xs:appinfo>
683 </xs:annotation>
684 </xs:attribute>
685
686 <xs:attribute name="PrereqPackage" type="wxs:YesNoTypeUnion">
687 <xs:annotation>
688 <xs:documentation>
689 When set to "yes", the Prereq BA will plan the package to be installed if its InstallCondition is "true" or empty.
690 </xs:documentation>
691 <xs:appinfo>
692 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
693 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
694 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
695 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
696 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
697 </xs:appinfo>
698 </xs:annotation>
699 </xs:attribute>
700
701 <xs:attribute name="PrimaryPackageType">
702 <xs:annotation>
703 <xs:documentation>Used by WixInternalUIBootstrapperApplication to determine which package is the primary package. The default value is "default".</xs:documentation>
704 <xs:appinfo>
705 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
706 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
707 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
708 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
709 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
710 </xs:appinfo>
711 </xs:annotation>
712 <xs:simpleType>
713 <xs:restriction base="xs:NMTOKEN">
714 <xs:enumeration value="default">
715 <xs:annotation>
716 <xs:documentation>
717 This package is used unless there is a package for the runtime machine's architecture.
718 </xs:documentation>
719 </xs:annotation>
720 </xs:enumeration>
721 <xs:enumeration value="x86">
722 <xs:annotation>
723 <xs:documentation>
724 This package is used when the runtime machine's OS is x86 (IMAGE_FILE_MACHINE_I386).
725 </xs:documentation>
726 </xs:annotation>
727 </xs:enumeration>
728 <xs:enumeration value="x64">
729 <xs:annotation>
730 <xs:documentation>
731 This package is used when the runtime machine's OS is x64 (IMAGE_FILE_MACHINE_AMD64).
732 </xs:documentation>
733 </xs:annotation>
734 </xs:enumeration>
735 <xs:enumeration value="arm64">
736 <xs:annotation>
737 <xs:documentation>
738 This package is used when the runtime machine's OS is ARM64 (IMAGE_FILE_MACHINE_ARM64).
739 </xs:documentation>
740 </xs:annotation>
741 </xs:enumeration>
742 </xs:restriction>
743 </xs:simpleType>
744 </xs:attribute>
745</xs:schema>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-10 16:04:14 +0000