aboutsummaryrefslogtreecommitdiff
path: root/src/wixext/bal.xsd
diff options
context:
space:
mode:
Diffstat (limited to 'src/wixext/bal.xsd')
-rw-r--r--src/wixext/bal.xsd266
1 files changed, 266 insertions, 0 deletions
diff --git a/src/wixext/bal.xsd b/src/wixext/bal.xsd
new file mode 100644
index 00000000..73f10540
--- /dev/null
+++ b/src/wixext/bal.xsd
@@ -0,0 +1,266 @@
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 targetNamespace="http://wixtoolset.org/schemas/v4/wxs/bal"
9 xmlns="http://wixtoolset.org/schemas/v4/wxs/bal">
10 <xs:annotation>
11 <xs:documentation>
12 The source code schema for the WiX Toolset Burn User Experience Extension.
13 </xs:documentation>
14 </xs:annotation>
15
16 <xs:import namespace="http://wixtoolset.org/schemas/v4/wxs" />
17
18 <xs:element name="Condition">
19 <xs:annotation>
20 <xs:documentation>
21 Conditions for a bundle. The condition is specified in the inner text of the element.
22 </xs:documentation>
23 <xs:appinfo>
24 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
25 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
26 </xs:appinfo>
27 </xs:annotation>
28 <xs:complexType>
29 <xs:simpleContent>
30 <xs:extension base="xs:string">
31 <xs:annotation>
32 <xs:documentation>
33 The condition that must evaluate to true for the installation to continue.
34 </xs:documentation>
35 </xs:annotation>
36 <xs:attribute name="Message" type="xs:string" use="required">
37 <xs:annotation>
38 <xs:documentation>
39 Set the value to the text to display when the condition fails and the installation must be terminated.
40 </xs:documentation>
41 </xs:annotation>
42 </xs:attribute>
43 </xs:extension>
44 </xs:simpleContent>
45 </xs:complexType>
46 </xs:element>
47
48 <xs:element name="WixStandardBootstrapperApplication">
49 <xs:annotation>
50 <xs:documentation>
51 Configures WixStandardBootstrapperApplication for a Bundle.
52 </xs:documentation>
53 <xs:appinfo>
54 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplicationRef" />
55 </xs:appinfo>
56 </xs:annotation>
57 <xs:complexType>
58 <xs:attribute name="LaunchTarget" type="xs:string">
59 <xs:annotation>
60 <xs:documentation>
61 If set, the success page will show a Launch button the user can use to launch the application being installed.
62 The string value can be formatted using Burn variables enclosed in brackets,
63 to refer to installation directories and so forth.
64 </xs:documentation>
65 </xs:annotation>
66 </xs:attribute>
67 <xs:attribute name="LaunchTargetElevatedId" type="xs:string">
68 <xs:annotation>
69 <xs:documentation>
70 Id of the target ApprovedExeForElevation element.
71 If set with LaunchTarget, WixStdBA will launch the application through the Engine's LaunchApprovedExe method instead of through ShellExecute.
72 </xs:documentation>
73 </xs:annotation>
74 </xs:attribute>
75 <xs:attribute name="LaunchArguments" type="xs:string">
76 <xs:annotation>
77 <xs:documentation>
78 If set, WixStdBA will supply these arguments when launching the application specified by the LaunchTarget attribute.
79 The string value can be formatted using Burn variables enclosed in brackets,
80 to refer to installation directories and so forth.
81 </xs:documentation>
82 </xs:annotation>
83 </xs:attribute>
84 <xs:attribute name="LaunchHidden" type="YesNoType">
85 <xs:annotation>
86 <xs:documentation>
87 If set to "yes", WixStdBA will launch the application specified by the LaunchTarget attribute with the SW_HIDE flag.
88 This attribute is ignored when the LaunchTargetElevatedId attribute is specified.
89 </xs:documentation>
90 </xs:annotation>
91 </xs:attribute>
92 <xs:attribute name="LaunchWorkingFolder" type="xs:string">
93 <xs:annotation>
94 <xs:documentation>
95 WixStdBA will use this working folder when launching the specified application.
96 The string value can be formatted using Burn variables enclosed in brackets,
97 to refer to installation directories and so forth.
98 This attribute is ignored when the LaunchTargetElevatedId attribute is specified.
99 </xs:documentation>
100 </xs:annotation>
101 </xs:attribute>
102 <xs:attribute name="LicenseFile" type="xs:string">
103 <xs:annotation>
104 <xs:documentation>Source file of the RTF license file. Cannot be used simultaneously with LicenseUrl.</xs:documentation>
105 </xs:annotation>
106 </xs:attribute>
107 <xs:attribute name="LicenseUrl" type="xs:string">
108 <xs:annotation>
109 <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>
110 </xs:annotation>
111 </xs:attribute>
112 <xs:attribute name="LogoFile" type="xs:string">
113 <xs:annotation>
114 <xs:documentation>Source file of the logo graphic.</xs:documentation>
115 </xs:annotation>
116 </xs:attribute>
117 <xs:attribute name="LogoSideFile" type="xs:string">
118 <xs:annotation>
119 <xs:documentation>Source file of the side logo graphic.</xs:documentation>
120 </xs:annotation>
121 </xs:attribute>
122 <xs:attribute name="ThemeFile" type="xs:string">
123 <xs:annotation>
124 <xs:documentation>Source file of the theme XML.</xs:documentation>
125 </xs:annotation>
126 </xs:attribute>
127 <xs:attribute name="LocalizationFile" type="xs:string">
128 <xs:annotation>
129 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
130 </xs:annotation>
131 </xs:attribute>
132 <xs:attribute name="SuppressOptionsUI" type="YesNoType">
133 <xs:annotation>
134 <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>
135 </xs:annotation>
136 </xs:attribute>
137 <xs:attribute name="SuppressDowngradeFailure" type="YesNoType">
138 <xs:annotation>
139 <xs:documentation>If set to "yes", attempting to installer a downgraded version of a bundle will be treated as a successful do-nothing operation.
140 The default behavior (or when explicitly set to "no") is to treat downgrade attempts as failures. </xs:documentation>
141 </xs:annotation>
142 </xs:attribute>
143 <xs:attribute name="SuppressRepair" type="YesNoType">
144 <xs:annotation>
145 <xs:documentation>If set to "yes", the Repair button will not be shown in the maintenance-mode UI.</xs:documentation>
146 </xs:annotation>
147 </xs:attribute>
148 <xs:attribute name="ShowVersion" type="YesNoType">
149 <xs:annotation>
150 <xs:documentation>If set to "yes", the application version will be displayed on the UI.</xs:documentation>
151 </xs:annotation>
152 </xs:attribute>
153 <xs:attribute name="SupportCacheOnly" type="YesNoType">
154 <xs:annotation>
155 <xs:documentation>If set to "yes", the bundle can be pre-cached using the /cache command line argument.</xs:documentation>
156 </xs:annotation>
157 </xs:attribute>
158 </xs:complexType>
159 </xs:element>
160
161 <xs:element name="WixManagedBootstrapperApplicationHost">
162 <xs:annotation>
163 <xs:documentation>
164 Configures the ManagedBootstrapperApplicationHost for a Bundle.
165 </xs:documentation>
166 <xs:appinfo>
167 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BootstrapperApplicationRef" />
168 </xs:appinfo>
169 </xs:annotation>
170 <xs:complexType>
171 <xs:attribute name="LogoFile" type="xs:string">
172 <xs:annotation>
173 <xs:documentation>Source file of the logo graphic.</xs:documentation>
174 </xs:annotation>
175 </xs:attribute>
176 <xs:attribute name="ThemeFile" type="xs:string">
177 <xs:annotation>
178 <xs:documentation>Source file of the theme XML.</xs:documentation>
179 </xs:annotation>
180 </xs:attribute>
181 <xs:attribute name="LocalizationFile" type="xs:string">
182 <xs:annotation>
183 <xs:documentation>Source file of the theme localization .wxl file.</xs:documentation>
184 </xs:annotation>
185 </xs:attribute>
186 </xs:complexType>
187 </xs:element>
188
189 <xs:attribute name="BAFunctions" type="YesNoType">
190 <xs:annotation>
191 <xs:documentation>
192 When set to "yes", WixStdBA will load the DLL and work with it to handle BA messages.
193 </xs:documentation>
194 <xs:appinfo>
195 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Payload" />
196 </xs:appinfo>
197 </xs:annotation>
198 </xs:attribute>
199
200 <xs:attribute name="Overridable" type="YesNoType">
201 <xs:annotation>
202 <xs:documentation>
203 When set to "yes", lets the user override the variable's default value by specifying another value on the command line,
204 in the form Variable=Value. Otherwise, WixStdBA won't overwrite the default value and will log
205 "Ignoring attempt to set non-overridable variable: 'BAR'."
206 </xs:documentation>
207 <xs:appinfo>
208 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Variable" />
209 </xs:appinfo>
210 </xs:annotation>
211 </xs:attribute>
212
213 <xs:attribute name="PrereqLicenseFile" type="xs:string">
214 <xs:annotation>
215 <xs:documentation>
216 Source file of the RTF license file.
217 There may only be one package in the bundle that has either the PrereqLicenseFile attribute or the PrereqLicenseUrl attribute.
218 </xs:documentation>
219 <xs:appinfo>
220 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
221 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
222 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
223 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
224 </xs:appinfo>
225 </xs:annotation>
226 </xs:attribute>
227
228 <xs:attribute name="PrereqLicenseUrl" type="xs:string">
229 <xs:annotation>
230 <xs:documentation>
231 URL target of the license link.
232 There may only be one package in the bundle that has either the PrereqLicenseFile attribute or the PrereqLicenseUrl attribute.
233 </xs:documentation>
234 <xs:appinfo>
235 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
236 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
237 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
238 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
239 </xs:appinfo>
240 </xs:annotation>
241 </xs:attribute>
242
243 <xs:attribute name="PrereqPackage" type="YesNoType">
244 <xs:annotation>
245 <xs:documentation>
246 When set to "yes", the Prereq BA will plan the package to be installed if its InstallCondition is "true" or empty.
247 </xs:documentation>
248 <xs:appinfo>
249 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
250 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
251 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
252 <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
253 </xs:appinfo>
254 </xs:annotation>
255 </xs:attribute>
256
257 <xs:simpleType name="YesNoType">
258 <xs:annotation>
259 <xs:documentation>Values of this type will either be "yes" or "no".</xs:documentation>
260 </xs:annotation>
261 <xs:restriction base="xs:NMTOKEN">
262 <xs:enumeration value="no"/>
263 <xs:enumeration value="yes"/>
264 </xs:restriction>
265 </xs:simpleType>
266</xs:schema>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-10 16:03:52 +0000