PanelSwWixExtension 3.3.0.155

Requires NuGet 2.7 or higher.

dotnet add package PanelSwWixExtension --version 3.3.0.155
NuGet\Install-Package PanelSwWixExtension -Version 3.3.0.155
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PanelSwWixExtension" Version="3.3.0.155" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PanelSwWixExtension --version 3.3.0.155
#r "nuget: PanelSwWixExtension, 3.3.0.155"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PanelSwWixExtension as a Cake Addin
#addin nuget:?package=PanelSwWixExtension&version=3.3.0.155

// Install PanelSwWixExtension as a Cake Tool
#tool nuget:?package=PanelSwWixExtension&version=3.3.0.155

PanelSwWixExtension WiX v3 NuGet version (PanelSwWixExtension) WiX v4 NuGet version (PanelSwWixExtension4)

PanelSwWixExtension from the creator of JetBA is the most comprehensive open source WiX extension. I would like to thank JetBrains for their support of this project

PanelSwWixExtension WiX Elements

  • Immediate Actions:
    • Md5Hash: Computes MD5 hash.
    • WmiSearch: Execute a WMI query.
    • PathSearch: Search for a file on PATH environment variable folder list.
    • VersionCompare: Compare two versions, set result to property in range -4 to +4, denoting the version part that was different.
    • ForceVersion: Force a specified version for a file. Version overwrite is done on runtime in the MSI database.
    • AccountSidSearch: Lookup an account's SID by account name.
    • JsonJpathSearch: Read JSON values
    • DiskSpace: Calculate available disk space for a target directory
    • CertificateHashSearch: Find a certificate hash in local system MY store.
    • Evaluate: Evaluate mathematical expressions and store result in property.
    • SetPropertyFromPipe: Allows setting property from a pipe.
    • SqlSearch: Execute a SQL query and place result in a property.
    • ReadIniValues: Reads .INI file values.
    • XmlSearch: Read XML values.
    • RegularExpression: Execute a Regular Expression to replace or find matches in property values and in file contents.
    • MsiSqlQuery: Execute a MSI-SQL query on the MSI database.
    • CreateSelfSignCertificate: Create a self-sign certificate that can then be installed by WixIisExtension.
    • ToLowerCase: Convert property value to lowercase.
    • CustomPatchRef Support referencing custom table rows in a patch
    • Payload Support extracting files from Binary table temporarilty during MSI execution
  • Deferred Actions:
    • RestartLocalResources: Register processes with the Restart Manager if they reside in the specified folder
    • XslTransform: Apply a XSL transform on an installed XML file
    • WebsiteConfig: currently, can only stop a website
    • JsonJPath: Set values in JSON-formatted file.
    • Dism: Enable Windows Feature using DISM API. Features will be installed when the parent component is being installed or repaired.
    • ZipFile: Creates a ZIP archive from selected files.
    • Unzip: Extract a ZIP archive to selected folder.
    • CustomUninstallKey: Overwrite registry values in the product's Uninstall registry key
    • RemoveRegistryValue: Removes registry values. Complements the standard RemoveRegistryValue WiX element that will only remove registry values during installation.
    • ExecOn: Execute a custom command on component action.
    • TaskScheduler: Add a task to Windows Task Scheduler.
    • DeletePath: Delete folder or file specified by a path.
    • FileRegex: Execute a Regular Expression to perform find & replace operations within files.
    • ShellExecute: Call ShellExecuteEx with parameters.
    • Telemetry: Send telemetry data to a given URL.
    • InstallUtil: Install a .NET assembly service.
    • TopShelf: Install a TopShelf based service.
    • BackupAndRestore: Backup a file before install or upgarde and restore it after.
    • SqlScript: Execute SQL scripts, optionally with text replacements.
    • SplitFile: Splits a file to parts during build, and reconstruct it during install. Used to workaround MSI limitation of 2GB file size.
  • Bundle Actions:
    • ExePackage/UninstallCommand: Execute a custom command to uninstall an ExePackage. Used for packages which the uninstall is launched via a different executable than the install.

Preprocessor

  • $(psw.VarNullOrEmpty(VAR_NAME)): Return 1 if the variable is not defined, or if it defined as empty. Return 0 otherwise
  • $(psw.AutoGuid(x,y,z,...)): Return a pseudo-random UUID per arguments
  • $(psw.FileExists(path)): Return 1 if the file exists, 0 otherwise
  • $(psw.DirExists(path)): Return 1 if the folder exists, 0 otherwise
  • $(psw.DirEmpty(path)): Return 1 if the folder doesn't exist or if it has no files (including in subfolders). Return 0 otherwise

Custom Actions

  • TerminateSuccessfully_Immediate: Terminates the installation with a successful indication. Executed in-script.
  • TerminateSuccessfully_Deferred: Terminates the installation with a successful indication. Deferred execution.
  • SplitPath: Split a full path supplied in 'FULL_PATH_TO_SPLIT' property and places the parts in properties SPLIT_DRIVE, SPLIT_FOLDER, SPLIT_FILE_NAME, SPLIT_FILE_EXTENSION.
  • PathExists: Tests whether the path supplied in 'FULL_PATH_TO_TEST' property exists. Sets 'PATH_EXISTS' property to 1 if it exists or clears it if it doesn't.
  • SplitString: Splits a string. Property name specified in 'PROPERTY_TO_SPLIT' and split token specified in 'STRING_SPLIT_TOKEN'. Results are stored in properties following the name supplied in 'PROPERTY_TO_SPLIT'. For example, say PROPERTY_TO_SPLIT="MY_PROP", MY_PROP="1,2,3" and STRING_SPLIT_TOKEN=",". Scheduling SplitString custom action will yield properties MY_PROP_0="1", MY_PROP_1="2" and MY_PROP_2="3".
  • TrimString: Trim whitespace characters in property with name specified in 'PROPERTY_TO_TRIM'.

Error codes

PanelSwWixExtension uses error codes in Error table:

  • 27000: TopShelf error template for prompting user on errors.
  • 27001: ExecOn error template for prompting user on errors.
  • 27002: ServiceConfig error template for prompting user on errors.
  • 27003: Dism error template for prompting user on failures to add a Windows feature package.
  • 27004: Dism error template for prompting user on failures to enable a Windows feature.
  • 27005: SqlScript error template for prompting user on errors.
  • 27006: ExecOn error template for prompting user on console output parsing.
  • 27007: WebsiteConfig error template for prompting user on errors.
  • 27008: SqlSearch error template for prompting user on errors.
  • 27009: JsonJpath error template for prompting user on errors.

Properties

The following properties hold localized built-in account names. To use them, add a PropertyRef element.

  • DOMAIN_ADMINISTRATORS
  • DOMAIN_GUESTS
  • DOMAIN_USERS
  • ENTERPRISE_DOMAIN_CONTROLLERS
  • DOMAIN_DOMAIN_CONTROLLERS
  • DOMAIN_COMPUTERS
  • BUILTIN_ADMINISTRATORS
  • BUILTIN_GUESTS
  • BUILTIN_USERS
  • LOCAL_ADMIN
  • LOCAL_GUEST
  • ACCOUNT_OPERATORS
  • BACKUP_OPERATORS
  • PRINTER_OPERATORS
  • SERVER_OPERATORS
  • AUTHENTICATED_USERS
  • PERSONAL_SELF
  • CREATOR_OWNER
  • CREATOR_GROUP
  • LOCAL_SYSTEM
  • POWER_USERS
  • EVERYONE
  • REPLICATOR
  • INTERACTIVE
  • NETWORK
  • SERVICE
  • RESTRICTED_CODE
  • WRITE_RESTRICTED_CODE
  • ANONYMOUS
  • SCHEMA_ADMINISTRATORS
  • CERT_SERV_ADMINISTRATORS
  • RAS_SERVERS
  • ENTERPRISE_ADMINS
  • GROUP_POLICY_ADMINS
  • ALIAS_PREW2KCOMPACC
  • LOCAL_SERVICE
  • NETWORK_SERVICE
  • REMOTE_DESKTOP
  • NETWORK_CONFIGURATION_OPS
  • PERFMON_USERS
  • PERFLOG_USERS
  • IIS_USERS
  • CRYPTO_OPERATORS
  • OWNER_RIGHTS
  • EVENT_LOG_READERS
  • ENTERPRISE_RO_DCs
  • CERTSVC_DCOM_ACCESS

The following properties hold localized CSIDL folders. To use them, add a PropertyRef element.

  • UserDesktopFolder: CSIDL_DESKTOPDIRECTORY

Building

PanelSwWixExtension require the following prerequisites to build:

  • CMake: CMake path can be specified in 'CMakeDir' property in 'TidyBuild.custom.props'
  • ADK installed. Specifically, Dism API should be installed. Set DismApi folder path in 'DismApiDir' property in 'TidyBuild.custom.props'
  • Update git submodules

To build the extension download the code, open the solution PanelSwWixExtension.sln in Visual Studio 2017 and build it.

Unit-test WiX are available in the solution folder 'UnitTests'. After building a unit test project, you'll need to shutdown Visual Studio before you can build PanelSwWixExtension project again. This is due to the unfortunate habit of Visual Studio to hold the extension file in use. You may find it convenient to build unit test projects from a command prompt to workaround this limitation

MSBuild UnitTests\WebsiteConfigUT\WebsiteConfigUT.wixproj /p:Configuration=Release /p:Platform=x86 /t:Rebuild "/p:SolutionDir=%CD%\\"
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.3.0.155 99 3/28/2023
3.3.0.155-psw-wix 31 3/28/2023
3.2.13.152 99 3/27/2023
3.2.13.152-psw-wix 39 3/27/2023
3.2.12.151 393 3/13/2023
3.2.12.151-psw-wix 41 3/13/2023
3.2.11.142 83 3/12/2023
3.2.11.142-psw-wix 40 3/12/2023
3.2.10.140 739 2/8/2023
3.2.10.140-psw-wix 67 2/8/2023
3.2.9.138 152 2/5/2023
3.2.9.138-psw-wix 64 2/5/2023
3.2.8.135 201 2/1/2023
3.2.8.135-psw-wix 68 2/1/2023
3.2.7.131 309 1/26/2023
3.2.7.131-psw-wix 66 1/26/2023
3.2.6.129 153 1/25/2023
3.2.6.129-psw-wix 53 1/25/2023
3.2.5.124 466 1/4/2023
3.2.5.124-psw-wix 74 1/4/2023
3.2.4.112 474 12/11/2022
3.2.4.112-psw-wix 1,750 12/11/2022
3.2.3.111 312 12/5/2022
3.2.3.111-psw-wix 60 12/5/2022
3.2.2.110 281 11/29/2022
3.2.2.110-psw-wix 87 11/29/2022
3.2.1.109 588 11/3/2022
3.2.1.109-psw-wix 71 11/3/2022
3.2.0.108 815 10/3/2022
3.2.0.108-psw-wix 88 10/3/2022
3.1.1.105 287 10/2/2022
3.1.1.105-psw-wix 83 10/2/2022
3.1.0.104 531 9/20/2022
3.1.0.104-psw-wix 71 9/20/2022
3.0.1.103 1,248 9/13/2022
3.0.1.103-psw-wix 174 9/13/2022
3.0.0.101 326 9/13/2022
3.0.0.101-psw-wix 93 9/13/2022
2.46.1.99 411 9/8/2022
2.46.1.99-psw-wix 108 9/8/2022
2.45.7.97 318 9/8/2022
2.45.7.97-psw-wix 93 9/8/2022
2.45.4.94 352 8/30/2022
2.45.4.94-psw-wix 76 8/30/2022
2.45.3.92 362 8/17/2022
2.45.3.92-psw-wix 87 8/17/2022
2.45.2.91 294 8/17/2022
2.45.2.91-psw-wix 62 8/17/2022
2.45.1.90 297 8/15/2022
2.45.1.90-psw-wix 71 8/15/2022
2.45.0.85 325 8/9/2022
2.45.0.85-psw-wix 97 8/9/2022
2.44.3.84 368 6/23/2022
2.44.3.84-psw-wix 1,709 6/23/2022
2.44.2.83 324 6/22/2022
2.44.2.83-psw-wix 81 6/22/2022
2.44.1.80 319 6/21/2022
2.44.1.80-psw-wix 78 6/21/2022
2.44.0.79 359 5/30/2022
2.44.0.79-psw-wix 81 5/30/2022
2.43.0.78 356 5/12/2022
2.43.0.78-psw-wix 126 5/12/2022
2.42.4.77 329 4/27/2022
2.42.4.77-psw-wix 562 4/27/2022
2.42.3.76 342 4/20/2022
2.42.3.76-psw-wix 114 4/20/2022
2.42.1.75 784 4/11/2022
2.42.1.75-psw-wix 103 4/11/2022
2.42.1.74 325 4/10/2022
2.42.1.74-psw-wix 87 4/10/2022
2.42.0.73 335 4/3/2022
2.42.0.73-psw-wix 101 4/3/2022
2.41.0.70 344 3/31/2022
2.41.0.70-psw-wix 192 3/31/2022
2.40.0.69 360 3/29/2022
2.40.0.69-psw-wix 93 3/29/2022
2.39.0.68 339 3/29/2022
2.39.0.68-psw-wix 90 3/29/2022
2.38.5.67 350 3/9/2022
2.38.5.67-psw-wix 120 3/9/2022
2.38.4.65 345 2/21/2022
2.38.4.65-psw-wix 110 2/21/2022
2.38.3.64 338 2/17/2022
2.38.3.64-psw-wix 96 2/17/2022
2.38.2.62 331 2/15/2022
2.38.2.62-psw-wix 88 2/15/2022
2.38.1.61 349 2/9/2022
2.38.1.61-psw-wix 93 2/9/2022
2.38.0.56 364 2/2/2022
2.38.0.56-psw-wix 129 2/2/2022
2.37.0.53 360 1/26/2022
2.37.0.53-psw-wix 121 1/26/2022
2.36.2.52 233 12/26/2021
2.36.2.52-psw-wix 113 12/26/2021
2.36.1.51 300 12/23/2021
2.36.1.51-psw-wix 106 12/23/2021
2.36.0.50 243 12/23/2021
2.36.0.50-psw-wix 114 12/23/2021
2.35.0.49 255 12/15/2021
2.35.0.49-psw-wix 128 12/15/2021
2.34.6.48 230 12/14/2021
2.34.6.48-psw-wix 115 12/14/2021
2.34.5.47 396 10/31/2021
2.34.5.47-psw-wix 1,448 10/31/2021
2.34.4.41 286 10/27/2021
2.34.4.41-psw-wix 185 10/27/2021
2.34.3.38 285 10/26/2021
2.34.3.38-psw-wix 158 10/26/2021
2.34.2.33 292 10/21/2021
2.34.2.33-psw-wix 170 10/21/2021
2.34.1.32 278 10/20/2021
2.34.1.32-psw-wix 145 10/20/2021
2.34.0.31 304 10/19/2021
2.34.0.31-psw-wix 185 10/19/2021
2.33.0.28 295 9/20/2021
2.33.0.28-psw-wix 177 9/20/2021
2.32.3.25 293 7/20/2021
2.32.3.25-psw-wix 263 7/20/2021
2.32.2.24 296 7/19/2021
2.32.2.24-psw-wix 187 7/19/2021
2.32.0.21 740 6/28/2021
2.32.0.21-psw-wix 188 6/28/2021
2.31.6.18 284 6/9/2021
2.31.6.18-psw-wix 595 6/9/2021
2.31.5 306 5/12/2021
2.31.5-psw-wix 185 5/12/2021
2.31.4 287 5/6/2021
2.31.4-psw-wix 186 5/6/2021
2.31.3 304 4/27/2021
2.31.3-psw-wix 182 4/27/2021
2.31.2 545 4/6/2021
2.31.2-psw-wix 188 4/6/2021
2.31.1 316 4/5/2021
2.31.1-psw-wix 185 4/5/2021
2.31.0.55 804 2/22/2021
2.31.0-psw-wix 295 2/22/2021
2.30.2.54 1,040 1/27/2021
2.30.2-psw-wix 1,085 1/27/2021
2.30.1 316 1/25/2021
2.30.1-psw-wix 188 1/25/2021
2.30.0.52 637 12/29/2020
2.30.0-psw-wix 202 12/29/2020
2.29.0.51 1,163 11/8/2020
2.29.0-psw-wix 313 11/8/2020
2.28.1.50 461 10/6/2020
2.28.1-psw-wix 269 10/6/2020
2.28.0.49 391 9/29/2020
2.28.0-psw-wix 283 9/29/2020
2.27.0.48 400 9/22/2020
2.27.0-psw-wix 280 9/22/2020
2.26.0.47 436 9/2/2020
2.26.0-psw-wix 319 9/2/2020
2.25.1.46 405 6/28/2020
2.25.1-psw-wix 273 6/28/2020
2.24.1.43 447 6/23/2020
2.24.1-psw-wix 297 6/23/2020
2.24.0.40 398 6/18/2020
2.24.0-psw-wix 296 6/18/2020
2.23.39 431 6/16/2020
2.23.37-psw-wix 285 6/15/2020
2.22.1 537 5/21/2020
2.22.1-fix-6144 299 5/21/2020
2.22.0 463 4/30/2020
2.22.0-fix-6144 335 4/30/2020
2.21.2 456 4/16/2020
2.21.2-fix-6144 315 4/16/2020
2.21.1 419 4/13/2020
2.21.1-fix-6144 309 4/13/2020
2.21.0 424 4/12/2020
2.21.0-fix-6144 319 4/12/2020
2.20.0 688 3/26/2020
2.20.0-fix-6144 314 3/26/2020
2.19.0 1,049 2/24/2020
2.19.0-fix-6144 320 3/23/2020
2.18.0 440 2/13/2020
2.17.1 657 2/6/2020
2.17.0 520 1/27/2020
2.16.3 545 1/26/2020
2.16.2 601 1/20/2020
2.16.1 456 1/14/2020
2.16.0 481 1/9/2020
2.15.7 551 1/9/2020
2.15.6 492 12/15/2019
2.15.5 464 12/12/2019
2.15.4 461 12/11/2019
2.15.3 495 12/3/2019
2.15.2 456 12/3/2019
2.15.1 455 12/1/2019
2.15.0 470 11/27/2019
2.14.2 476 11/21/2019
2.14.1 474 11/13/2019
2.14.0 475 11/12/2019
2.13.3 467 11/10/2019
2.13.2 489 10/28/2019
2.13.1 473 10/22/2019
2.13.0 508 10/6/2019
2.12.1 496 9/19/2019
2.12.0 488 9/16/2019
2.11.1 491 9/15/2019
2.11.0 512 9/11/2019
2.10.2 525 8/14/2019
2.10.1 496 8/12/2019
2.10.0 544 8/11/2019
2.9.1 737 7/17/2019
2.9.0 526 7/16/2019
2.8.2 559 6/12/2019
2.8.1 535 5/26/2019
2.8.0 541 5/23/2019
2.7.1 539 5/17/2019
2.7.0 546 5/16/2019
2.6.6 562 5/15/2019
2.6.5 546 5/14/2019
2.6.4 526 5/8/2019
2.6.3 532 5/8/2019
2.6.2 632 5/2/2019
2.6.1 568 4/18/2019
2.6.0 937 4/8/2019
2.5.0 932 3/26/2019
2.4.1 547 3/20/2019
2.4.0 557 3/7/2019
2.3.0 557 3/5/2019
2.2.0 546 2/28/2019
2.1.0 547 2/25/2019
2.0.3 621 2/19/2019
2.0.1 632 2/14/2019
2.0.0 611 2/11/2019
1.17.17 680 1/17/2019
1.17.16 697 1/16/2019
1.17.15 677 1/15/2019
1.17.14 673 1/14/2019
1.17.13 700 1/10/2019
1.17.12 665 1/9/2019
1.17.11 733 1/2/2019
1.17.10 735 1/2/2019
1.17.9 666 12/31/2018
1.17.8 686 12/31/2018
1.17.7 678 12/27/2018
1.17.6 682 12/27/2018
1.17.5 691 12/27/2018
1.17.4 620 12/26/2018
1.17.3 663 12/23/2018
1.17.2 661 12/23/2018
1.17.1 664 12/20/2018
1.17.0 694 12/20/2018
1.16.2 736 12/19/2018
1.16.1 672 12/18/2018
1.16.0 693 12/13/2018
1.15.0 694 12/6/2018
1.14.0 664 12/5/2018
1.13.0 664 12/5/2018
1.12.2 724 11/28/2018
1.12.1 709 11/28/2018
1.12.0 705 10/22/2018
1.11.0 716 10/21/2018
1.10.2 792 10/14/2018
1.10.1 749 10/5/2018
1.10.0 737 10/5/2018
1.9.2 731 10/3/2018
1.9.1 739 9/21/2018
1.9.0 707 9/21/2018
1.8.2 778 9/16/2018
1.8.1 789 9/2/2018
1.8.0 760 8/28/2018
1.6.2 795 7/29/2018
1.6.1 778 7/25/2018
1.6.0 779 7/24/2018
1.5.0 857 7/11/2018
1.4.3 1,090 7/4/2018
1.4.2 935 6/27/2018
1.4.1 899 6/14/2018
1.4.0 891 6/12/2018
1.3.1 933 5/30/2018
1.3.0 899 5/21/2018
1.2.0 913 5/10/2018
1.1.38 880 5/7/2018
1.1.37 959 5/2/2018
1.1.36 891 4/25/2018
1.1.35 927 4/25/2018
1.1.34 945 4/11/2018
1.1.33 833 3/15/2018
1.1.32 934 3/14/2018
1.1.31 973 3/7/2018
1.1.30 907 2/27/2018
1.1.29 932 2/26/2018
1.1.28 923 2/25/2018
1.1.27 894 2/22/2018
1.1.26 911 2/21/2018
1.1.25 808 2/21/2018
1.1.24 921 2/19/2018
1.1.23 2,267 1/30/2018
1.1.22 901 1/30/2018
1.1.21 926 1/10/2018
1.1.20 864 12/18/2017
1.1.19 1,056 11/28/2017
1.1.18 850 11/5/2017
1.1.15 993 9/5/2017