CandleRunner Class

Summary

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

Syntax

public sealed class CandleRunner : Tool<CandleSettings>

Constructors

Name Summary
CandleRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the CandleRunner 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(IEnumerable<FilePath>, CandleSettings) void
Runs Candle with the specified source files and settings.

Extension Methods

Name Value Summary
Dump<CandleRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CandleRunner>(CandleRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CandleRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CandleRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CandleRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CandleRunner>(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