HeatRunner Class

Summary

The WiX Heat runner.
Namespace
Cake.Common.Tools.WiX.Heat
Base Types
graph BT Type-->Base0["Tool<HeatSettings>"] Base0-->Base1["object"] Type["HeatRunner"] class Type type-node

Syntax

public sealed class HeatRunner : Tool<HeatSettings>

Constructors

Name Summary
HeatRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the HeatRunner class.

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
Run(DirectoryPath, FilePath, WiXHarvestType, HeatSettings) void
Runs the Wix Heat runner for the specified directory path.
Run(FilePath, FilePath, WiXHarvestType, HeatSettings) void
Runs the Wix Heat runner for the specified directory path.
Run(string, FilePath, WiXHarvestType, HeatSettings) void
Runs the Wix Heat runner for the specified directory path.

Extension Methods

Name Value Summary
Dump<HeatRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<HeatRunner>(HeatRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<HeatRunner>(string) void
Requires the Cake.Issues addin
NotNull<HeatRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<HeatRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<HeatRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin