|
1156 | 1156 | <returns></returns> |
1157 | 1157 | </member> |
1158 | 1158 | <member name="T:WixSharp.Bootstrapper.Bundle"> |
1159 | | - <summary> |
1160 | | - Class for defining a WiX standard Burn-based bootstrapper. By default the bootstrapper is using WiX default WiX bootstrapper UI. |
1161 | | - </summary> |
1162 | | - <example>The following is an example of defining a bootstrapper for two msi files and .NET Web setup. |
1163 | | - <code> |
1164 | | - var bootstrapper = |
1165 | | - new Bundle("My Product", |
1166 | | - new PackageGroupRef("NetFx40Web"), |
1167 | | - new MsiPackage("productA.msi"), |
1168 | | - new MsiPackage("productB.msi")); |
1169 | | - |
1170 | | - bootstrapper.AboutUrl = "https://wixsharp.codeplex.com/"; |
1171 | | - bootstrapper.IconFile = "app_icon.ico"; |
1172 | | - bootstrapper.Version = new Version("1.0.0.0"); |
1173 | | - bootstrapper.UpgradeCode = new Guid("6f330b47-2577-43ad-9095-1861bb25889b"); |
1174 | | - bootstrapper.Application.LogoFile = "logo.png"; |
| 1159 | + <summary> |
| 1160 | + Class for defining a WiX standard Burn-based bootstrapper. By default the bootstrapper is using WiX default WiX bootstrapper UI. |
| 1161 | + </summary> |
| 1162 | + <example>The following is an example of defining a bootstrapper for two msi files and .NET Web setup. |
| 1163 | + <code> |
| 1164 | + var bootstrapper = |
| 1165 | + new Bundle("My Product", |
| 1166 | + new PackageGroupRef("NetFx40Web"), |
| 1167 | + new MsiPackage("productA.msi"), |
| 1168 | + new MsiPackage("productB.msi")); |
1175 | 1169 |
|
1176 | | - bootstrapper.Build(); |
1177 | | - </code> |
1178 | | - </example> |
| 1170 | + bootstrapper.AboutUrl = "https://wixsharp.codeplex.com/"; |
| 1171 | + bootstrapper.IconFile = "app_icon.ico"; |
| 1172 | + bootstrapper.Version = new Version("1.0.0.0"); |
| 1173 | + bootstrapper.UpgradeCode = new Guid("6f330b47-2577-43ad-9095-1861bb25889b"); |
| 1174 | + bootstrapper.Application.LogoFile = "logo.png"; |
| 1175 | + |
| 1176 | + bootstrapper.Build(); |
| 1177 | + </code> |
| 1178 | + </example> |
1179 | 1179 | </member> |
1180 | 1180 | <member name="M:WixSharp.Bootstrapper.Bundle.#ctor"> |
1181 | 1181 | <summary> |
|
1193 | 1193 | <summary> |
1194 | 1194 | The disable rollbackSpecifies whether the bundle will attempt to rollback packages executed in the chain. |
1195 | 1195 | If "true" is specified then when a vital package fails to install only that package will rollback and the chain will stop with the error. |
1196 | | - The default is "false" which indicates all packages executed during the chain will be rolldback to their previous state when a vital package fails. |
| 1196 | + The default is "false" which indicates all packages executed during the chain will be rollback to their previous state when a vital package fails. |
1197 | 1197 | </summary> |
1198 | 1198 | </member> |
1199 | 1199 | <member name="F:WixSharp.Bootstrapper.Bundle.DisableSystemRestore"> |
1200 | 1200 | <summary> |
1201 | | - Specifies whether the bundle will attempt to create a system restore point when executing the chain. If "true" is specified then a system restore |
1202 | | - point will not be created. The default is "false" which indicates a system restore point will be created when the bundle is installed, uninstalled, |
| 1201 | + Specifies whether the bundle will attempt to create a system restore point when executing the chain. If "true" is specified then a system restore |
| 1202 | + point will not be created. The default is "false" which indicates a system restore point will be created when the bundle is installed, uninstalled, |
1203 | 1203 | repaired, modified, etc. If the system restore point cannot be created, the bundle will log the issue and continue. |
1204 | 1204 | </summary> |
1205 | 1205 | </member> |
1206 | 1206 | <member name="F:WixSharp.Bootstrapper.Bundle.ParallelCache"> |
1207 | 1207 | <summary> |
1208 | | - Specifies whether the bundle will start installing packages while other packages are still being cached. |
1209 | | - If "true", packages will start executing when a rollback boundary is encountered. The default is "false" |
| 1208 | + Specifies whether the bundle will start installing packages while other packages are still being cached. |
| 1209 | + If "true", packages will start executing when a rollback boundary is encountered. The default is "false" |
1210 | 1210 | which dictates all packages must be cached before any packages will start to be installed. |
1211 | 1211 | </summary> |
1212 | 1212 | </member> |
|
1236 | 1236 | </member> |
1237 | 1237 | <member name="F:WixSharp.Bootstrapper.Bundle.DigitalSignature"> |
1238 | 1238 | <summary> |
1239 | | - Parameters of digitaly sign |
| 1239 | + Parameters of digitally sign |
1240 | 1240 | </summary> |
1241 | 1241 | </member> |
1242 | 1242 | <member name="F:WixSharp.Bootstrapper.Bundle.DisableRemove"> |
1243 | 1243 | <summary> |
1244 | 1244 | Determines whether the bundle can be removed via the Programs and Features (also known as Add/Remove Programs). If the value is |
1245 | 1245 | "yes" then the "Uninstall" button will not be displayed. The default is "no" which ensures there is an "Uninstall" button to remove |
1246 | | - the bundle. If the "DisableModify" attribute is also "yes" or "button" then the bundle will not be displayed in Progams and |
| 1246 | + the bundle. If the "DisableModify" attribute is also "yes" or "button" then the bundle will not be displayed in Programs and |
1247 | 1247 | Features and another mechanism (such as registering as a related bundle addon) must be used to ensure the bundle can be removed. |
1248 | 1248 | </summary> |
1249 | 1249 | </member> |
|
1305 | 1305 | <member name="F:WixSharp.Bootstrapper.Bundle.SuppressWixMbaPrereqVars"> |
1306 | 1306 | <summary> |
1307 | 1307 | The suppress auto insertion of WixMbaPrereq* variables in the bundle definition (WixMbaPrereqPackageId and WixMbaPrereqLicenseUrl). |
1308 | | - <para>BA is relying on two internal variables that reflect .NET version (and licence) that BA requires at runtime. If user defines |
1309 | | - custom Wix# based BA the required variables are inserted automatically, similarly to the standards WiX/Burn BA. However some other |
1310 | | - bundle packages (e.g. new PackageGroupRef("NetFx40Web")) may also define these variables so some duplication/collision is possible. |
| 1308 | + <para>BA is relying on two internal variables that reflect .NET version (and license) that BA requires at runtime. If user defines |
| 1309 | + custom Wix# based BA the required variables are inserted automatically, similarly to the standards WiX/Burn BA. However some other |
| 1310 | + bundle packages (e.g. new PackageGroupRef("NetFx40Web")) may also define these variables so some duplication/collision is possible. |
1311 | 1311 | To avoid this you can suppress variables auto-insertion and define them manually as needed.</para> |
1312 | 1312 | <example>The following is an example of suppressing auto-insertion: |
1313 | 1313 | <code> |
|
1318 | 1318 | Id = "MyProductPackageId", |
1319 | 1319 | DisplayInternalUI = true |
1320 | 1320 | }); |
1321 | | - |
| 1321 | + |
1322 | 1322 | bootstrapper.SuppressWixMbaPrereqVars = true; |
1323 | 1323 | </code> |
1324 | 1324 | </example> |
|
1347 | 1347 | </member> |
1348 | 1348 | <member name="F:WixSharp.Bootstrapper.Bundle.StringVariablesDefinition"> |
1349 | 1349 | <summary> |
1350 | | - The Bundle string variables. |
| 1350 | + The Bundle string variables. |
1351 | 1351 | </summary> |
1352 | 1352 | <para>The variables are defined as a named values map.</para> |
1353 | | - <para>If you need to access the variable value from the Package |
1354 | | - you will need to add the MsiProperty mapped to this variable. |
| 1353 | + <para>If you need to access the variable value from the Package |
| 1354 | + you will need to add the MsiProperty mapped to this variable. |
1355 | 1355 | </para> |
1356 | 1356 | <example> |
1357 | 1357 | <code> |
|
4360 | 4360 | </member> |
4361 | 4361 | <member name="M:WixSharp.Extensions.SamePathAs(System.String,System.String)"> |
4362 | 4362 | <summary> |
4363 | | - Returns true if bothe values represent the same path. |
| 4363 | + Returns true if both values represent the same path. |
4364 | 4364 | </summary> |
4365 | 4365 | <param name="pathA">The path a.</param> |
4366 | 4366 | <param name="pathB">The path b.</param> |
|
4369 | 4369 | <member name="M:WixSharp.Extensions.GetLocation(System.Reflection.Assembly)"> |
4370 | 4370 | <summary> |
4371 | 4371 | Gets the location of the assembly. |
4372 | | - <p>Can discover the original location of the asssembly being loaded from memory in case of a CS-Script assembly. |
| 4372 | + <p>Can discover the original location of the assembly being loaded from memory in case of a CS-Script assembly. |
4373 | 4373 | </p> |
4374 | 4374 | </summary> |
4375 | 4375 | <param name="assembly">The assembly.</param> |
|
4383 | 4383 | <param name="newDir">The new directory.</param> |
4384 | 4384 | <returns></returns> |
4385 | 4385 | </member> |
| 4386 | + <member name="M:WixSharp.Extensions.PathCombine(System.String,System.String)"> |
| 4387 | + <summary> |
| 4388 | + Combines path parts. Encapsulates <see cref="M:System.IO.Path.Combine(System.String,System.String)"/> |
| 4389 | + </summary> |
| 4390 | + <param name="path1">The path1.</param> |
| 4391 | + <param name="path2">The path2.</param> |
| 4392 | + <returns></returns> |
| 4393 | + </member> |
4386 | 4394 | <member name="M:WixSharp.Extensions.PathChangeFileName(System.String,System.String)"> |
4387 | 4395 | <summary> |
4388 | 4396 | The change the file name of the file path. |
|
4406 | 4414 | </summary> |
4407 | 4415 | <param name="path">The path.</param> |
4408 | 4416 | </member> |
| 4417 | + <member name="M:WixSharp.Extensions.ToAbsolutePath(System.String)"> |
| 4418 | + <summary> |
| 4419 | + Converts string value representing path into an absolute path. If string is null or empty it is treated as the CurrentDirectory equivalent. |
| 4420 | + </summary> |
| 4421 | + <param name="path">The path.</param> |
| 4422 | + <returns></returns> |
| 4423 | + </member> |
4409 | 4424 | <member name="M:WixSharp.Extensions.PathGetFileName(System.String)"> |
4410 | 4425 | <summary> |
4411 | 4426 | Identical to <see cref="M:System.IO.Path.GetFileName(System.String)"/>. It is useful for Wix# consuming code as it allows avoiding |
|
4520 | 4535 | </member> |
4521 | 4536 | <member name="M:WixSharp.Extensions.UnEscapeEnvars(System.String)"> |
4522 | 4537 | <summary> |
4523 | | - Unescape '\%' characters in the tokens representing environment variables (e.g. "%ProgramFiles%\My Product"). |
4524 | | - <para>Required for avoiding collisions between environment variables and WiX constants. For example to prevent |
| 4538 | + Unescape '\%' characters in the tokens representing environment variables (e.g. "%ProgramFiles%\My Product"). |
| 4539 | + <para>Required for avoiding collisions between environment variables and WiX constants. For example to prevent |
4525 | 4540 | "%ProgramFiles%\My Product" being later converted into "ProgramFilesFolder\My Product"</para> |
4526 | 4541 | </summary> |
4527 | 4542 | <param name="text"></param> |
4528 | 4543 | <returns></returns> |
4529 | 4544 | </member> |
4530 | 4545 | <member name="M:WixSharp.Extensions.EscapeEnvars(System.String)"> |
4531 | 4546 | <summary> |
4532 | | - Escape '%' characters in the tokens representing environment variables (e.g. "%ProgramFiles%\My Product"). |
4533 | | - <para>Required for avoiding collisions between environment variables and WiX constants. For example to prevent |
| 4547 | + Escape '%' characters in the tokens representing environment variables (e.g. "%ProgramFiles%\My Product"). |
| 4548 | + <para>Required for avoiding collisions between environment variables and WiX constants. For example to prevent |
4534 | 4549 | "%ProgramFiles%\My Product" being later converted into "ProgramFilesFolder\My Product"</para> |
4535 | 4550 | </summary> |
4536 | 4551 | <param name="text"></param> |
|
8336 | 8351 | The .NET4.5 installed. This condition is to be used in Project.SetNetFxPrerequisite. |
8337 | 8352 | </summary> |
8338 | 8353 | </member> |
| 8354 | + <member name="F:WixSharp.Condition.Net451_Installed"> |
| 8355 | + <summary> |
| 8356 | + The .NET4.5.1 installed. This condition is to be used in Project.SetNetFxPrerequisite. |
| 8357 | + </summary> |
| 8358 | + </member> |
| 8359 | + <member name="F:WixSharp.Condition.Net452_Installed"> |
| 8360 | + <summary> |
| 8361 | + The .NET4.5.2 installed. This condition is to be used in Project.SetNetFxPrerequisite. |
| 8362 | + </summary> |
| 8363 | + </member> |
| 8364 | + <member name="F:WixSharp.Condition.Net46_Installed"> |
| 8365 | + <summary> |
| 8366 | + The .NET4.6 installed. This condition is to be used in Project.SetNetFxPrerequisite. |
| 8367 | + </summary> |
| 8368 | + </member> |
| 8369 | + <member name="F:WixSharp.Condition.Net461_Installed"> |
| 8370 | + <summary> |
| 8371 | + The .NET4.6.1 installed. This condition is to be used in Project.SetNetFxPrerequisite. |
| 8372 | + </summary> |
| 8373 | + </member> |
| 8374 | + <member name="F:WixSharp.Condition.Net462_Installed"> |
| 8375 | + <summary> |
| 8376 | + The .NET4.6.2 installed. This condition is to be used in Project.SetNetFxPrerequisite. |
| 8377 | + </summary> |
| 8378 | + </member> |
8339 | 8379 | <member name="F:WixSharp.Condition.Net30_SP_Installed"> |
8340 | 8380 | <summary> |
8341 | 8381 | The .NET3.0 SP installed. This condition is to be used in Project.SetNetFxPrerequisite. |
|
0 commit comments