Class

ChangesFluent

ConsoleMonster.Changes

Namespace: ConsoleMonster.Changes
Assembly: ConsoleMonster
Modifiers: static

The fluent methods of ChangeView, 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
ChangesFluent

Methods

AddIgnore 3 overloads

public static DiffOptions AddIgnore(DiffOptions diffOptions, string item) #

Adds an item to DiffOptions.Ignore: Members (or paths such as Address.City, with * wildcards) left out of the comparison.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
item string required: The item.

Returns

DiffOptions The same instance.

public static DiffOptions AddIgnore(DiffOptions diffOptions, params string[] items) #

Adds items to DiffOptions.Ignore: Members (or paths such as Address.City, with * wildcards) left out of the comparison.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items string[] required: The items, in order.

Returns

DiffOptions The same instance.

public static DiffOptions AddIgnore(DiffOptions diffOptions, IEnumerable<string> items) #

Adds items to DiffOptions.Ignore: Members (or paths such as Address.City, with * wildcards) left out of the comparison.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items System.Collections.Generic.IEnumerable<string> required: The items, in order.

Returns

DiffOptions The same instance.

AddKey 3 overloads

public static DiffOptions AddKey(DiffOptions diffOptions, string item) #

Adds an item to DiffOptions.Key: The members whose values identify an object (like Compare-Object -Property for matching). Empty: Id, Name, Key...

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
item string required: The item.

Returns

DiffOptions The same instance.

public static DiffOptions AddKey(DiffOptions diffOptions, params string[] items) #

Adds items to DiffOptions.Key: The members whose values identify an object (like Compare-Object -Property for matching). Empty: Id, Name, Key...

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items string[] required: The items, in order.

Returns

DiffOptions The same instance.

public static DiffOptions AddKey(DiffOptions diffOptions, IEnumerable<string> items) #

Adds items to DiffOptions.Key: The members whose values identify an object (like Compare-Object -Property for matching). Empty: Id, Name, Key...

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items System.Collections.Generic.IEnumerable<string> required: The items, in order.

Returns

DiffOptions The same instance.

AddProperties 2 overloads

public static DiffOptions AddProperties(DiffOptions diffOptions, params string[] items) #

Adds items to DiffOptions.Properties: The members to compare, or empty for all of them.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items string[] required: The items, in order.

Returns

DiffOptions The same instance.

public static DiffOptions AddProperties(DiffOptions diffOptions, IEnumerable<string> items) #

Adds items to DiffOptions.Properties: The members to compare, or empty for all of them.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items System.Collections.Generic.IEnumerable<string> required: The items, in order.

Returns

DiffOptions The same instance.

public static DiffOptions AddProperty(DiffOptions diffOptions, string item) #

Adds an item to DiffOptions.Properties: The members to compare, or empty for all of them.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
item string required: The item.

Returns

DiffOptions The same instance.

public static DiffOptions AddSource(DiffOptions diffOptions, IMemberSource item) #

Adds an item to DiffOptions.Sources: Member sources tried before reflection (PowerShell objects, dictionaries, JSON).

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
item ConsoleMonster.Data.IMemberSource required: The item.

Returns

DiffOptions The same instance.

AddSources 2 overloads

public static DiffOptions AddSources(DiffOptions diffOptions, params IMemberSource[] items) #

Adds items to DiffOptions.Sources: Member sources tried before reflection (PowerShell objects, dictionaries, JSON).

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items ConsoleMonster.Data.IMemberSource[] required: The items, in order.

Returns

DiffOptions The same instance.

public static DiffOptions AddSources(DiffOptions diffOptions, IEnumerable<IMemberSource> items) #

Adds items to DiffOptions.Sources: Member sources tried before reflection (PowerShell objects, dictionaries, JSON).

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Data.IMemberSource> required: The items, in order.

Returns

DiffOptions The same instance.

public static DiffOptions Configure(DiffOptions diffOptions, Action<DiffOptions> configure) #

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

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
configure System.Action<ConsoleMonster.Changes.DiffOptions> required: Assignments applied in order.

Returns

DiffOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Changes.DiffOptions { KeySelector = value };    diffOptions.Configure(configured => configured.KeySelector = value);

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Changes.DiffOptions { Unwrap = value };    diffOptions.Configure(configured => configured.Unwrap = value);

public static TextDiffOptions Context(TextDiffOptions textDiffOptions, int value) #

Sets TextDiffOptions.Context: Unchanged lines retained on each side of a change (default three). Must be nonnegative.

Parameters

textDiffOptions ConsoleMonster.Changes.TextDiffOptions required: The instance.
value int required: The value.

Returns

TextDiffOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Changes.TextDiffOptions { Context = value };    textDiffOptions.Context(value);

public static DiffOptions Depth(DiffOptions diffOptions, int value) #

Sets DiffOptions.Depth: How deep nested objects are compared (default 3).

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
value int required: The value.

Returns

DiffOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Changes.DiffOptions { Depth = value };    diffOptions.Depth(value);

public static TextDiffOptions DifferenceLabel(TextDiffOptions textDiffOptions, string value) #

Sets TextDiffOptions.DifferenceLabel: The plain new-text label in the widget and unified header (default After).

Parameters

textDiffOptions ConsoleMonster.Changes.TextDiffOptions required: The instance.
value string required: The value.

Returns

TextDiffOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Changes.TextDiffOptions { DifferenceLabel = value };    textDiffOptions.DifferenceLabel(value);

IgnoreWhitespace 2 overloads

public static TextDiffOptions IgnoreWhitespace(TextDiffOptions textDiffOptions, bool value) #

Sets TextDiffOptions.IgnoreWhitespace: Ignores Unicode whitespace within lines. Line boundaries and a missing final newline still matter.

Parameters

textDiffOptions ConsoleMonster.Changes.TextDiffOptions required: The instance.
value bool required: The value.

Returns

TextDiffOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Changes.TextDiffOptions { IgnoreWhitespace = value };    textDiffOptions.IgnoreWhitespace(value);

public static TextDiffOptions IgnoreWhitespace(TextDiffOptions textDiffOptions) #

Sets TextDiffOptions.IgnoreWhitespace to true.

Parameters

textDiffOptions ConsoleMonster.Changes.TextDiffOptions required: The instance to configure.

Returns

TextDiffOptions The same instance.

IncludeUnchanged 2 overloads

public static DiffOptions IncludeUnchanged(DiffOptions diffOptions, bool value) #

Sets DiffOptions.IncludeUnchanged: Whether unchanged objects are listed too (they are always counted).

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
value bool required: The value.

Returns

DiffOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Changes.DiffOptions { IncludeUnchanged = value };    diffOptions.IncludeUnchanged(value);

public static DiffOptions IncludeUnchanged(DiffOptions diffOptions) #

Sets DiffOptions.IncludeUnchanged to true.

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance to configure.

Returns

DiffOptions The same instance.

Interactive 2 overloads

public static ChangePreviewOptions Interactive(ChangePreviewOptions changePreviewOptions, InteractiveOptions? value) #

Sets ChangePreviewOptions.Interactive: Prompt options (input, target, labels), or null for the defaults.

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
value ConsoleMonster.Interactive.InteractiveOptions? required: The value.

Returns

ChangePreviewOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.Changes.ChangePreviewOptions { Interactive = value };    changePreviewOptions.Interactive(value);

public static ChangePreviewOptions Interactive(ChangePreviewOptions changePreviewOptions, Action<InteractiveOptions> configure)

Configures ChangePreviewOptions.Interactive in place (creating it when not set): Prompt options (input, target, labels), or null for the defaults.

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
configure System.Action<ConsoleMonster.Interactive.InteractiveOptions> required: Configures the value.

Returns

ChangePreviewOptions The same instance.

public static ChangeView LongValue(ChangeView changeView, int value) #

Sets ChangeView.LongValue: Values longer than this many cells (or with line breaks) show as a line diff instead of in the table (default 60).

Parameters

changeView ConsoleMonster.Changes.ChangeView required: The instance.
value int required: The value.

Returns

ChangeView The same instance.

Examples

// C# initializer or property    // C# fluent
changeView.LongValue = value;    changeView.LongValue(value);

public static ChangeView MaxProperties(ChangeView changeView, int value) #

Sets ChangeView.MaxProperties: The most lines an added or removed object takes in the table, one per compared property (default 6, 0 for no limit); beyond it the last line says "+N more" with ChangeView.MoreHint. The side-by-side view lists all.

Parameters

changeView ConsoleMonster.Changes.ChangeView required: The instance.
value int required: The value.

Returns

ChangeView The same instance.

Examples

// C# initializer or property        // C# fluent
changeView.MaxProperties = value;    changeView.MaxProperties(value);

Mode 2 overloads

public static ChangeView Mode(ChangeView changeView, ChangeViewMode value) #

Sets ChangeView.Mode: The view.

Parameters

changeView ConsoleMonster.Changes.ChangeView required: The instance.
value ConsoleMonster.Changes.ChangeViewMode required: The value.

Returns

ChangeView The same instance.

Examples

// C# initializer or property    // C# fluent
changeView.Mode = value;         changeView.Mode(value);

public static ChangePreviewOptions Mode(ChangePreviewOptions changePreviewOptions, ChangeViewMode value) #

Sets ChangePreviewOptions.Mode: The view of the changes (default ChangeViewMode.Full).

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
value ConsoleMonster.Changes.ChangeViewMode required: The value.

Returns

ChangePreviewOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Changes.ChangePreviewOptions { Mode = value };    changePreviewOptions.Mode(value);

public static ChangeView MoreHint(ChangeView changeView, string? value) #

Sets ChangeView.MoreHint: Plain text after "+N more" saying where to see every value (Show-ConsoleChanges: "-PassThru or -View SideBySide"), or null.

Parameters

changeView ConsoleMonster.Changes.ChangeView required: The instance.
value string? required: The value.

Returns

ChangeView The same instance.

Examples

// C# initializer or property    // C# fluent
changeView.MoreHint = value;     changeView.MoreHint(value);

public static ChangePreviewOptions Question(ChangePreviewOptions changePreviewOptions, string? value) #

Sets ChangePreviewOptions.Question: The question, or null for "Apply these changes?" in the current language.

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
value string? required: The value.

Returns

ChangePreviewOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Changes.ChangePreviewOptions { Question = value };    changePreviewOptions.Question(value);

public static TextDiffOptions ReferenceLabel(TextDiffOptions textDiffOptions, string value) #

Sets TextDiffOptions.ReferenceLabel: The plain original-text label in the widget and unified header (default Before).

Parameters

textDiffOptions ConsoleMonster.Changes.TextDiffOptions required: The instance.
value string required: The value.

Returns

TextDiffOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Changes.TextDiffOptions { ReferenceLabel = value };    textDiffOptions.ReferenceLabel(value);

public static DiffOptions TimeBudget(DiffOptions diffOptions, TimeSpan value) #

Sets DiffOptions.TimeBudget: How long getters may stall in one comparison before slow members stop being read (default 2 seconds).

Parameters

diffOptions ConsoleMonster.Changes.DiffOptions required: The instance.
value System.TimeSpan required: The value.

Returns

DiffOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Changes.DiffOptions { TimeBudget = value };    diffOptions.TimeBudget(value);

Title 2 overloads

public static ChangeView Title(ChangeView changeView, string? value) #

Sets ChangeView.Title: A title above the view (markup), or null.

Parameters

changeView ConsoleMonster.Changes.ChangeView required: The instance.
value string? required: The value.

Returns

ChangeView The same instance.

Examples

// C# initializer or property    // C# fluent
changeView.Title = value;        changeView.Title(value);

public static ChangePreviewOptions Title(ChangePreviewOptions changePreviewOptions, string? value) #

Sets ChangePreviewOptions.Title: A title above the preview (markup), or null.

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
value string? required: The value.

Returns

ChangePreviewOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Changes.ChangePreviewOptions { Title = value };    changePreviewOptions.Title(value);

public static ChangePreviewOptions TypedConfirmation(ChangePreviewOptions changePreviewOptions, string? value) #

Sets ChangePreviewOptions.TypedConfirmation: Text the user must type to confirm (for example a server name), or null.

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
value string? required: The value.

Returns

ChangePreviewOptions The same instance.

Examples

// C# initializer or property                                                             // C# fluent
new global::ConsoleMonster.Changes.ChangePreviewOptions { TypedConfirmation = value };    changePreviewOptions.TypedConfirmation(value);

TypedWhenDestructive 2 overloads

public static ChangePreviewOptions TypedWhenDestructive(ChangePreviewOptions changePreviewOptions, bool value) #

Sets ChangePreviewOptions.TypedWhenDestructive: Whether changes that remove objects need a typed confirmation when ChangePreviewOptions.TypedConfirmation is not set: the user types the number of removals (default true).

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance.
value bool required: The value.

Returns

ChangePreviewOptions The same instance.

Examples

// C# initializer or property                                                                // C# fluent
new global::ConsoleMonster.Changes.ChangePreviewOptions { TypedWhenDestructive = value };    changePreviewOptions.TypedWhenDestructive(value);

public static ChangePreviewOptions TypedWhenDestructive(ChangePreviewOptions changePreviewOptions) #

Sets ChangePreviewOptions.TypedWhenDestructive to true.

Parameters

changePreviewOptions ConsoleMonster.Changes.ChangePreviewOptions required: The instance to configure.

Returns

ChangePreviewOptions The same instance.

Inheritance

Methods

Inherited Methods