Skip to content
ConsoleMonster
Class

ConsoleLogFileFluent

ConsoleMonster.Output

Namespace
ConsoleMonster.Output
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of ConsoleLogFile, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • ConsoleLogFileFluent

Methods

public static ConsoleLogFile Configure(ConsoleLogFile consoleLogFile, Action<ConsoleLogFile> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
configure System.Action<ConsoleMonster.Output.ConsoleLogFile> required
Assignments applied in order.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property      // C# fluent
consoleLogFile.Warning = value;    consoleLogFile.Configure(configured => configured.Warning = value);
public static ConsoleLogFile Encoding(ConsoleLogFile consoleLogFile, Encoding value) #

Sets ConsoleLogFile.Encoding: The encoding for a new file (default UTF-8 without a byte order mark; Write-Color defaults to UTF-16 "Unicode"); see ConsoleLogFile.ResolveEncoding. An existing file keeps its own encoding (see ConsoleLogFile.KeepExistingEncoding).

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value System.Text.Encoding required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property       // C# fluent
consoleLogFile.Encoding = value;    consoleLogFile.Encoding(value);
EncodingSpecified 2 overloads
public static ConsoleLogFile EncodingSpecified(ConsoleLogFile consoleLogFile, bool value) #

Sets ConsoleLogFile.EncodingSpecified: Whether ConsoleLogFile.Encoding was chosen by the caller (for example PowerShell's -Encoding). When it differs from an existing file's encoding, the file's encoding is kept and ConsoleLogFile.Warning is told once.

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value bool required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property                // C# fluent
consoleLogFile.EncodingSpecified = value;    consoleLogFile.EncodingSpecified(value);
public static ConsoleLogFile EncodingSpecified(ConsoleLogFile consoleLogFile) #

Sets ConsoleLogFile.EncodingSpecified to true.

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance to configure.

Returns

ConsoleLogFile The same instance.
public static ConsoleLogFile Format(ConsoleLogFile consoleLogFile, ConsoleLogFormat value) #

Sets ConsoleLogFile.Format: The layout (default Text).

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value ConsoleMonster.Output.ConsoleLogFormat required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property     // C# fluent
consoleLogFile.Format = value;    consoleLogFile.Format(value);
IncludeTime 2 overloads
public static ConsoleLogFile IncludeTime(ConsoleLogFile consoleLogFile, bool value) #

Sets ConsoleLogFile.IncludeTime: Whether records start with the time (default true).

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value bool required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property          // C# fluent
consoleLogFile.IncludeTime = value;    consoleLogFile.IncludeTime(value);
public static ConsoleLogFile IncludeTime(ConsoleLogFile consoleLogFile) #

Sets ConsoleLogFile.IncludeTime to true.

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance to configure.

Returns

ConsoleLogFile The same instance.
KeepExistingEncoding 2 overloads
public static ConsoleLogFile KeepExistingEncoding(ConsoleLogFile consoleLogFile, bool value) #

Sets ConsoleLogFile.KeepExistingEncoding: Whether appending to an existing file keeps that file's encoding (default true), detected by ConsoleLogFile.DetectEncoding, so a UTF-16 log written by Write-Color is never continued in UTF-8. A file whose encoding cannot be told (no byte order mark, not UTF-16 text) is appended to in ConsoleLogFile.Encoding.

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value bool required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property                   // C# fluent
consoleLogFile.KeepExistingEncoding = value;    consoleLogFile.KeepExistingEncoding(value);
public static ConsoleLogFile KeepExistingEncoding(ConsoleLogFile consoleLogFile) #

Sets ConsoleLogFile.KeepExistingEncoding to true.

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance to configure.

Returns

ConsoleLogFile The same instance.
public static ConsoleLogFile Retries(ConsoleLogFile consoleLogFile, int value) #

Sets ConsoleLogFile.Retries: Attempts before giving up (default 2).

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value int required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property      // C# fluent
consoleLogFile.Retries = value;    consoleLogFile.Retries(value);
public static ConsoleLogFile Separator(ConsoleLogFile consoleLogFile, string value) #

Sets ConsoleLogFile.Separator: The CSV separator (default a comma).

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value string required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property        // C# fluent
consoleLogFile.Separator = value;    consoleLogFile.Separator(value);
public static ConsoleLogFile TimeFormat(ConsoleLogFile consoleLogFile, string value) #

Sets ConsoleLogFile.TimeFormat: The time format (default yyyy-MM-dd HH:mm:ss).

Parameters

consoleLogFile ConsoleMonster.Output.ConsoleLogFile required
The instance.
value string required
The value.

Returns

ConsoleLogFile The same instance.

Examples

// C# initializer or property         // C# fluent
consoleLogFile.TimeFormat = value;    consoleLogFile.TimeFormat(value);