Packaging a .NET user interface extension

Note
By default, PackageBuilder installs extensions for all users of the computer and requires administrative permissions on the computer. To create packages that install the extensions for only the current user of the computer, see "Deploying packages to only the current user."

Download (via the link in Related information) and install WiX version 3.0 (or higher) on development computers in order to use the PackageBuilder tool.

To package a .NET extension library into a .CAB file:

1. Run the PackageBuilder tool by executing the following command:

Note
If this produces the error "System.InvalidOperationException: The path to the bootstrappers was not found," check that the path is correct in the value of the registry key that corresponds to the latest installed version of Visual Studio at the following location: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\GenericBootstrapper

To automatically package an extension every time you build it with Visual Studio:

1. In Visual Studio, open the project’s properties.
2. Click the Compile tab. The Compile options page appears.
3. Click the Build Events button . The Build Events dialog appears.
4. Click Edit Post-build button. The Post-build Event Command Line dialog appears.
5. Add the following command line: "%BCMNETSDK%\Deployment\Extension\PackageBuilder.exe" "$(TargetPath)"
6. Click OK to save your changes.

The next time you compile the project, the PackageBuilder will creates a CAB file in the Package subfolder of the project’s output folder. The PackageBuilder tool also creates a Support subfolder where it places all files that have been used to build the .CAB file:

• Bootstrapper.proj – MSBuild project file. Creates a bootstrapper application (setup.exe) to check for and deploy all components upon which your extension depends (for example, .NET Framework, interop libraries, and so on).
• Build.bat – Windows batch file to create the .CAB file.
• ComObjectName.wxi - WiX include file. Contains information required for COM registration.
• Config.wxi – WiX include file. Contains preprocessor variable definitions used to configure setup units.
• CustomComponents.wxs – WiX source fragment file. Contains definitions of custom components to include in the CAB.
• ExtensionName.dll – a copy of the compiled extension library.
• ExtensionName.htm – HTML file that contains a description of the extension ActiveX library that is used by the Internet Component Download service.
• ExtensionName.inf – An information file that provides installation instructions that the Internet Component Download service uses to download and install the .CAB file.
• ExtensionName.wxi – WiX include file. Contains definition of the extension component.
• Product.ico – Icon shown in the Add/Remove window in Control Panel.
• Product.wxs – WiX project file. Creates a .MSI package file to be packed into the .CAB file.
• Sign.bat - Windows batch file that can be used to sign the CAB file and its contents with an Authenticode signature. The file contains placeholders which should be replaced with the path to a signing tool.

See Also