Class

ShapeOptionsFluent

ConsoleMonster.Values

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

The fluent methods of ShapeOptions, 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
ShapeOptionsFluent

Methods

public static ShapeOptions AddSource(ShapeOptions shapeOptions, IMemberSource item) #

Adds an item to ShapeOptions.Sources: Record adapters tried before the built-in ones (for example PowerShell objects).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
item ConsoleMonster.Data.IMemberSource required: The item.

Returns

ShapeOptions The same instance.

AddSources 2 overloads

public static ShapeOptions AddSources(ShapeOptions shapeOptions, params IMemberSource[] items) #

Adds items to ShapeOptions.Sources: Record adapters tried before the built-in ones (for example PowerShell objects).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
items ConsoleMonster.Data.IMemberSource[] required: The items, in order.

Returns

ShapeOptions The same instance.

public static ShapeOptions AddSources(ShapeOptions shapeOptions, IEnumerable<IMemberSource> items) #

Adds items to ShapeOptions.Sources: Record adapters tried before the built-in ones (for example PowerShell objects).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Data.IMemberSource> required: The items, in order.

Returns

ShapeOptions The same instance.

public static ShapeOptions Collections(ShapeOptions shapeOptions, CollectionDisplay value) #

Sets ShapeOptions.Collections: How collections are written inside cells and titles (default CollectionDisplay.Join).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value ConsoleMonster.Values.CollectionDisplay required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { Collections = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().Collections(value);

public static ShapeOptions Configure(ShapeOptions shapeOptions, Action<ShapeOptions> configure) #

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

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
configure System.Action<ConsoleMonster.Values.ShapeOptions> required: Assignments applied in order.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { Unwrap = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().Configure(configured => configured.Unwrap = value);

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { Identity = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().Configure(configured => configured.Identity = value);

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { TypeNames = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().Configure(configured => configured.TypeNames = value);

public static ShapeOptions Culture(ShapeOptions shapeOptions, CultureInfo? value) #

Sets ShapeOptions.Culture: The culture for numbers and dates, or null for the current culture.

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value System.Globalization.CultureInfo? required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { Culture = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().Culture(value);

public static ShapeOptions ItemLimit(ShapeOptions shapeOptions, int value) #

Sets ShapeOptions.ItemLimit: How many items a collection shows before the "+N" marker (default 5).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value int required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { ItemLimit = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().ItemLimit(value);

public static ShapeOptions MaxFields(ShapeOptions shapeOptions, int value) #

Sets ShapeOptions.MaxFields: The most fields a record contributes as default columns (default 12).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value int required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { MaxFields = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().MaxFields(value);

public static ShapeOptions MaxNodes(ShapeOptions shapeOptions, int value) #

Sets ShapeOptions.MaxNodes: How many values one shaping pass may read (default 20 000).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value int required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { MaxNodes = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().MaxNodes(value);

public static ShapeOptions Separator(ShapeOptions shapeOptions, string value) #

Sets ShapeOptions.Separator: The separator for CollectionDisplay.Join and CollectionDisplay.FirstN (default ", ").

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value string required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { Separator = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().Separator(value);

public static ShapeOptions TimeBudget(ShapeOptions shapeOptions, TimeSpan value) #

Sets ShapeOptions.TimeBudget: How long one shaping pass (a table, a list, a tree) may spend reading values (default 2 seconds).

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value System.TimeSpan required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { TimeBudget = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().TimeBudget(value);

UseReflection 2 overloads

public static ShapeOptions UseReflection(ShapeOptions shapeOptions, bool value) #

Sets ShapeOptions.UseReflection: Whether plain .NET objects may be read through reflection (default true). Callers using trimming must preserve those public members, or set this to false and supply explicit adapters or shapers. Adapter-only mode does not make arbitrary caller delegates or adapters trim-safe.

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance.
value bool required: The value.

Returns

ShapeOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Values.ShapeOptions { UseReflection = value };    Ui.Options<global::ConsoleMonster.Values.ShapeOptions>().UseReflection(value);

public static ShapeOptions UseReflection(ShapeOptions shapeOptions) #

Sets ShapeOptions.UseReflection to true.

Parameters

shapeOptions ConsoleMonster.Values.ShapeOptions required: The instance to configure.

Returns

ShapeOptions The same instance.

Inheritance

Methods

Inherited Methods