MSBuildFileLoggerSettings Class

Summary

Represents the settings for a file logger.
graph BT Type-->Base0["MSBuildLoggerSettings"] click Base0 "/api/Cake.Common.Tools.DotNet.MSBuild/MSBuildLoggerSettings" Base0-->Base1["object"] Type["MSBuildFileLoggerSettings"] class Type type-node

Syntax

public class MSBuildFileLoggerSettings : MSBuildLoggerSettings

Properties

Name Value Summary
AppendToLogFile bool
Gets or sets a value indicating whether the build log is appended to the log file or overwrites it.
ConsoleColorType MSBuildConsoleColorType
Gets or sets value that indicates the type of console color to use for all logging messages.
Inherited from MSBuildLoggerSettings
DisableMultiprocessorLogging bool
Gets or sets a value indicating whether to disable the multiprocessor logging style of output when running in non-multiprocessor mode.
Inherited from MSBuildLoggerSettings
FileEncoding string
Gets or sets the encoding for the file (for example, UTF-8, Unicode, or ASCII).
ForceNoAlign bool
Gets or sets a value indicating whether to not align the text to the size of the console buffer.
Inherited from MSBuildLoggerSettings
HideItemAndPropertyList bool
Gets or sets a value indicating whether to hide the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
Inherited from MSBuildLoggerSettings
LogFile string
Gets or sets the path to the log file into which the build log is written.
NoSummary bool
Gets or sets a value indicating whether to hide the error and warning summary at the end.
Inherited from MSBuildLoggerSettings
PerformanceSummary bool
Gets or sets a value indicating whether to show the time that’s spent in tasks, targets, and projects.
Inherited from MSBuildLoggerSettings
ShowCommandLine bool
Gets or sets a value indicating whether to show TaskCommandLineEvent messages.
Inherited from MSBuildLoggerSettings
ShowEventId bool
Gets or sets a value indicating whether to show the event Id for each started event, finished event, and message.
Inherited from MSBuildLoggerSettings
ShowTimestamp bool
Gets or sets a value indicating whether to show the timestamp as a prefix to any message.
Inherited from MSBuildLoggerSettings
SummaryOutputLevel MSBuildLoggerOutputLevel
Gets or sets value that indicates the level of summary output at the end for the logger.
Inherited from MSBuildLoggerSettings
Verbosity DotNetVerbosity?
Gets or sets a value that overrides the /verbosity setting for this logger.
Inherited from MSBuildLoggerSettings

Extension Methods

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