Skip to content
ConsoleMonster

API Reference

Class

KeyValueListFluent

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

The fluent methods of KeyValueList, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • Object
  • KeyValueListFluent

Methods

public static KeyValueList WithGap(KeyValueList keyValueList, Int32 value) #
Returns: KeyValueList

Sets KeyValueList.Gap: Cells between the key column and the values (default 2).

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static KeyValueList WithMaxKeyFraction(KeyValueList keyValueList, Double value) #
Returns: KeyValueList

Sets KeyValueList.MaxKeyFraction: The widest the key column may be, as a fraction of the width (default 0.4).

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList requiredposition: 0
The instance.
value System.Double requiredposition: 1
The value.

Returns

The same instance.

WithNumberColumn 2 overloads
public static KeyValueList WithNumberColumn(KeyValueList keyValueList, ColumnFormat value) #
Returns: KeyValueList

Sets KeyValueList.NumberColumn: Layout of the leading number of each value (234 / 332, 8.4 rules/s, ~12s): values that start with a number share a number column, right-aligned by default, so the numbers line up under each other. Set the alignment to HorizontalAlignment.Left to print values as written.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList requiredposition: 0
The instance.
value ConsoleMonster.Layout.ColumnFormat requiredposition: 1
The value.

Returns

The same instance.

public static KeyValueList WithNumberColumn(KeyValueList keyValueList, Action<ColumnFormat> configure) #
Returns: KeyValueList

Configures KeyValueList.NumberColumn in place: Layout of the leading number of each value (234 / 332, 8.4 rules/s, ~12s): values that start with a number share a number column, right-aligned by default, so the numbers line up under each other. Set the alignment to HorizontalAlignment.Left to print values as written.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList requiredposition: 0
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> requiredposition: 1
Configures the value.

Returns

The same instance.

WithPresentation 2 overloads
public static KeyValueList WithPresentation(KeyValueList keyValueList, PresentationOptions value) #
Returns: KeyValueList

Sets KeyValueList.Presentation: Culture, clock and time zone for values added with KeyValueList.AddValue.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList requiredposition: 0
The instance.
value ConsoleMonster.Presenters.PresentationOptions requiredposition: 1
The value.

Returns

The same instance.

public static KeyValueList WithPresentation(KeyValueList keyValueList, Action<PresentationOptions> configure) #
Returns: KeyValueList

Configures KeyValueList.Presentation in place (creating it when not set): Culture, clock and time zone for values added with KeyValueList.AddValue.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList requiredposition: 0
The instance.
configure System.Action<ConsoleMonster.Presenters.PresentationOptions> requiredposition: 1
Configures the value.

Returns

The same instance.