HeatSettings Class

Summary

Contains settings used by HeatRunner.
Namespace
Cake.Common.Tools.WiX.Heat
Base Types
graph BT Type-->Base0["ToolSettings"] click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base0-->Base1["object"] Type["HeatSettings"] class Type type-node

Syntax

public sealed class HeatSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<ProcessArgumentBuilder, ProcessArgumentBuilder>
Gets or sets the argument customization. Argument customization is a way that lets you add, replace or reuse arguments passed to a tool. This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
AutogeneratedGuid bool
Gets or sets a value indicating whether to auto generate Guid at compile time.
ComponentGroupName string
Gets or sets the name of the component group.
Configuration string
Gets or sets the configuration to set when harvesting the project.
DirectoryId string
Gets or sets the overridden directory identifier for generated directory elements.
DirectoryReferenceId string
Gets or sets the directory reference identifier for generated directory elements.
EnvironmentVariables IDictionary<string, string>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
Extensions IEnumerable<string>
Gets or sets the WiX extensions to use.
File FilePath
Gets or sets the file.
Generate WiXGenerateType
Gets or sets the type of elements to generate.
GenerateBinderVariables bool
Gets or sets a value indicating whether generate binder variables instead of preprocessor variables.
GenerateGuid bool
Gets or sets a value indicating whether all components are given a guid.
GenerateGuidWithoutBraces bool
Gets or sets a value indicating whether to generate guids without curly braces.
HandleExitCode Func<int, bool>
Gets or sets whether the exit code from the tool process causes an exception to be thrown.

If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code.

If the delegate returns true then no exception is thrown.

This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value.

Inherited from ToolSettings
Indent int?
Gets or sets the indentation multiplier, overrides default of 4.
KeepEmptyDirectories bool
Gets or sets a value indicating whether to keep empty directories.
NoLogo bool
Gets or sets a value indicating whether [no logo].
NoWorkingDirectory bool
Gets or sets a value indicating whether or not to opt out of using an explicit working directory for the process.
Inherited from ToolSettings
OutputFile FilePath
Gets or sets the output file.
OutputGroup WiXOutputGroupType?
Gets or sets the output group of Visual Studio project.
Platform string
Gets or sets the platform to set when harvesting the project.
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
PreprocessorVariable string
Gets or sets the preprocessor variable.
ProjectName string
Gets or sets the overridden project name to use in variables.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
SuppressCom bool
Gets or sets a value indicating whether the COM elements.
SuppressFragments bool
Gets or sets a value indicating whether to suppress the generation of fragments for directories and components.
SuppressRegistry bool
Gets or sets a value indicating whether [suppress registry].
SuppressRootDirectory bool
Gets or sets a value indicating whether [suppress root directory].
SuppressSpecificWarnings IEnumerable<string>
Gets or sets the suppress specific warnings.
SuppressUniqueIds bool
Gets or sets a value indicating whether to suppress unique identifiers for files, components, and directories.
SuppressVb6Com bool
Gets or sets a value indicating whether to suppress VB6 COM registration entries.
Template WiXTemplateType?
Gets or sets the template to use when harvesting.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Transform string
Gets or sets the transform to apply to harvested files.
TreatSpecificWarningsAsErrors IEnumerable<string>
Gets or sets the treat specific warnings as errors.
Verbose bool
Gets or sets a value indicating whether output is verbose.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

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