WiXAliases Class

Summary

Contains functionality related to WiX.

In order to use the commands for this alias, include the following in your build.cake file to download and install from nuget.org, or specify the ToolPath within the appropriate settings class: 

#tool "nuget:?package=WiX"

Namespace
Cake.Common.Tools.WiX
Base Types
  • object
graph BT Type-->Base0["object"] Type["WiXAliases"] class Type type-node

Syntax

[CakeAliasCategory("WiX")]
public static class WiXAliases

Attributes

Type Description
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Methods

Name Value Summary
WiXCandle(ICakeContext, GlobPattern, CandleSettings) void
Compiles all .wxs sources matching the specified pattern.
static
WiXCandle(ICakeContext, IEnumerable<FilePath>, CandleSettings) void
Compiles all .wxs sources in the provided source files.
static
WiXHeat(ICakeContext, DirectoryPath, FilePath, WiXHarvestType, HeatSettings) void
Harvests files in the provided directory path.
static
WiXHeat(ICakeContext, DirectoryPath, FilePath, WiXHarvestType) void
Harvests files in the provided object files.
static
WiXHeat(ICakeContext, FilePath, FilePath, WiXHarvestType, HeatSettings) void
Harvests from the desired files.
static
WiXHeat(ICakeContext, FilePath, FilePath, WiXHarvestType) void
Harvests from the desired files.
static
WiXHeat(ICakeContext, string, FilePath, WiXHarvestType, HeatSettings) void
Harvests files for a website or performance.
static
WiXHeat(ICakeContext, string, FilePath, WiXHarvestType) void
Harvests files for a website or performance.
static
WiXLight(ICakeContext, GlobPattern, LightSettings) void
Links all .wixobj files matching the specified pattern.
static
WiXLight(ICakeContext, IEnumerable<FilePath>, LightSettings) void
Links all .wixobj files in the provided object files.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin