TextTransformSettings Class

Summary

Contains settings used by TextTransformRunner.
Namespace
Cake.Common.Tools.TextTransform
Base Types
graph TD Base0["ToolSettings"]-->Type click Base0 "/api/Cake.Core.Tooling/ToolSettings" Base1["object"]-->Base0 Type["TextTransformSettings"] class Type type-node

Syntax

public sealed class TextTransformSettings : ToolSettings

Properties

Name Value Summary
ArgumentCustomization Func<T, TResult>
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
Assembly string
Gets or sets the assembly used for compiling and running the text template.
EnvironmentVariables IDictionary<TKey, TValue>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
IncludeDirectory DirectoryPath
Gets or sets a directory that contains the text templates sourced in the specified text template.
Namespace string
Gets or sets namespace that is used for compiling the text template.
OutputFile FilePath
Gets or sets the output file for the transform.
ReferencePath DirectoryPath
Gets or sets a directory to search for assemblies specified within the text template.
ToolPath FilePath
Gets or sets the tool path.
Inherited from ToolSettings
ToolTimeout Nullable<T>
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
WorkingDirectory DirectoryPath
Gets or sets the working directory for the tool process.
Inherited from ToolSettings

Extension Methods

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