ILMergeSettings Class

Summary

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

Syntax

public sealed class ILMergeSettings : ToolSettings

Constructors

Name Summary
ILMergeSettings() Initializes a new instance of the ILMergeSettings class.

Properties

Name Value Summary
Align int?
Gets or sets a value that controls the file alignment used for the target assembly.
AllowDuplicateTypes bool
Gets or sets a value indicating whether to allow the user to allow all public types to be renamed when they are duplicates.
AllowMultiple bool
Gets or sets a value indicating whether you want to allow duplicates (for those attributes whose type specifies "AllowMultiple" in their definition).
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
AttributeFile FilePath
Gets or sets the path and filename to an attribute assembly, an assembly that will be used to get all of the assembly-level attributes such as Culture, Version, etc.
Closed bool
Gets or sets a value indicating whether the "transitive closure" of the input assemblies is computed and added to the list of input assemblies.
CopyAttributes bool
Gets or sets a value indicating whether the assembly level attributes of each input assembly are copied over into the target assembly.
DelaySign bool
Gets or sets a value indicating whether the target assembly will be delay signed.
DuplicateTypes string[]
Gets or sets a list of public types which are allowed to be renamed when duplicates exist.
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
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
Internalize bool
Gets or sets a value indicating whether whether types in assemblies other than the primary assembly should have their visibility modified to internal.
KeepFirst bool
Gets or sets a value indicating whether the first attribute that is found is kept.
KeyContainer string
Gets or sets the name of the container to use when signing the target assembly.
KeyFile FilePath
Gets or sets the path to a .snk file. The target assembly will be signed with its contents and will then have a strong name.
Log bool
Gets or sets a value indicating whether log messages are written.
LogFile FilePath
Gets or sets the path to the file where log messages should be written to.
NDebug bool
Gets or sets a value indicating whether a .pdb file for the output assembly is generated and merges into it any .pdb files found for input assemblies.
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
PostAction Action<IProcess>
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
SearchDirectories DirectoryPath[]
Gets or sets the directories to be used to search for input assemblies.
SetupProcessSettings Action<ProcessSettings>
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
TargetKind TargetKind
Gets or sets the target kind.
TargetPlatform TargetPlatform
Gets or sets the target platform.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout TimeSpan?
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
Union bool
Gets or sets a value indicating whether types with the same name are all merged into a single type in the target assembly.
UseFullPublicKeyForReferences bool
Gets or sets a value indicating whether external assembly references in the manifest of the target assembly will use full public keys or public key tokens.
Version string
Gets or sets the version. When this has a non-null value, then the target assembly will be given its value as the version number of the assembly.
Wildcards bool
Gets or sets a value indicating whether any wild cards in file names are expanded and all matching files will be used as input.
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
XmlDocumentation bool
Gets or sets a value indicating whether XML documentation files are merged to produce an XML documentation file for the target assembly.
ZeroPeKind bool
Gets or sets a value indicating whether an assembly's PeKind flag (this is the value of the field listed as .corflags in the Manifest) is zero it will be treated as if it was ILonly.

Extension Methods

Name Value Summary
Dump<ILMergeSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ILMergeSettings>(ILMergeSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ILMergeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ILMergeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ILMergeSettings>(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<ILMergeSettings>(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
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin
WithArgumentCustomization<ILMergeSettings>(Func<ProcessArgumentBuilder, ProcessArgumentBuilder>) T
Sets the tool argument customization delegate.
WithEnvironmentVariable<ILMergeSettings>(string, string) T
Sets or adds tool environment variable.
WithExpectedExitCode<ILMergeSettings>(int) T
Sets expected exit code using WithHandleExitCode<T>(T, Func<int, bool>).
WithHandleExitCode<ILMergeSettings>(Func<int, bool>) T
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
WithNoWorkingDirectory<ILMergeSettings>(bool) T
Sets whether the tool should use a working directory or not.
WithPostAction<ILMergeSettings>(Action<IProcess>) T
Sets a delegate which is executed after the tool process was started.
WithSetupProcessSettings<ILMergeSettings>(Action<ProcessSettings>) T
Sets a delegate to configure the process settings.
WithToolPath<ILMergeSettings>(FilePath) T
Sets the tool path.
WithToolSettings<ILMergeSettings>(Action<ILMergeSettings>) T
Provides fluent null guarded tool settings action.
WithToolTimeout<ILMergeSettings>(TimeSpan) T
Sets the tool timeout.
WithWorkingDirectory<ILMergeSettings>(DirectoryPath) T
Sets the tool working directory.