This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.ExcelDnaPack.

Summary

Contains settings used by ExcelDnaPackTool.

Assembly

Cake.ExcelDnaPack.dll

Namespace

Cake.ExcelDnaPack

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["ExcelDnaPackSettings"] class Type type-node

Syntax

public class ExcelDnaPackSettings : ToolSettings

Constructors

Name	Summary
ExcelDnaPackSettings()

Properties

Name	Value	Summary
DnaFilePath	FilePath	The path to the primary .dna file for the Excel-DNA add-in.
NoCompression	Nullable<bool>	Disable compression (LZMA) of resources.
NoMultiThreading	Nullable<bool>	Disable multi-threading to ensure deterministic order of packing.
OutputXllFilePath	FilePath	The output path for the packed .xll file. Default is `DnaFilePath`-packed.xll.
PromptBeforeOverwrite	Nullable<bool>	Enable interactive prompt to overwrite the output .xll file, if it already exists. Defaults to if .

Extension Methods

Name	Value	Summary
Dump<ExcelDnaPackSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<ExcelDnaPackSettings>(ExcelDnaPackSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NoCompression()	ExcelDnaPackSettings	Disable compression (LZMA) of resources From ExcelDnaPackSettingsExtensions Requires the Cake.ExcelDnaPack addin
NoMultiThreading()	ExcelDnaPackSettings	Disable multi-threading to ensure deterministic order of packing From ExcelDnaPackSettingsExtensions Requires the Cake.ExcelDnaPack addin
NotNull<ExcelDnaPackSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<ExcelDnaPackSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
PromptBeforeOverwrite()	ExcelDnaPackSettings	Enable interactive prompt to overwrite the output .xll file, if it already exists. From ExcelDnaPackSettingsExtensions Requires the Cake.ExcelDnaPack addin
SetDnaFilePath(FilePath)	ExcelDnaPackSettings	Set the path to the primary .dna file for the Excel-DNA add-in From ExcelDnaPackSettingsExtensions Requires the Cake.ExcelDnaPack addin
SetOutputXllFilePath(FilePath)	ExcelDnaPackSettings	Set the output path for the packed .xll file. Default is `DnaFilePath`-packed.xll. From ExcelDnaPackSettingsExtensions Requires the Cake.ExcelDnaPack addin
ThrowIfNull<ExcelDnaPackSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<ExcelDnaPackSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

ExcelDnaPackSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods