Skip to content
ConsoleMonster
Class

GridOptionsFluent

ConsoleMonster.Interactive

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

The fluent methods of GridOptions, 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
  • GridOptionsFluent

Methods

AddCommand 3 overloads
public static GridOptions AddCommand(GridOptions gridOptions, AppCommand item) #

Adds an item to GridOptions.Command: Commands available through the action palette and their shortcuts. Actions keep the grid open.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
item ConsoleMonster.Interactive.AppCommand required
The item.

Returns

GridOptions The same instance.
public static GridOptions AddCommand(GridOptions gridOptions, params AppCommand[] items) #

Adds items to GridOptions.Command: Commands available through the action palette and their shortcuts. Actions keep the grid open.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
items ConsoleMonster.Interactive.AppCommand[] required
The items, in order.

Returns

GridOptions The same instance.
public static GridOptions AddCommand(GridOptions gridOptions, IEnumerable<AppCommand> items) #

Adds items to GridOptions.Command: Commands available through the action palette and their shortcuts. Actions keep the grid open.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Interactive.AppCommand> required
The items, in order.

Returns

GridOptions The same instance.
public static GridOptions AddHiddenColumn(GridOptions gridOptions, string item) #

Adds an item to GridOptions.HiddenColumns: Columns hidden at the start (by header).

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
item string required
The item.

Returns

GridOptions The same instance.
AddHiddenColumns 2 overloads
public static GridOptions AddHiddenColumns(GridOptions gridOptions, params string[] items) #

Adds items to GridOptions.HiddenColumns: Columns hidden at the start (by header).

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
items string[] required
The items, in order.

Returns

GridOptions The same instance.
public static GridOptions AddHiddenColumns(GridOptions gridOptions, IEnumerable<string> items) #

Adds items to GridOptions.HiddenColumns: Columns hidden at the start (by header).

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

GridOptions The same instance.
public static GridOptions Configure(GridOptions gridOptions, Action<GridOptions> configure) #

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

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.GridOptions> required
Assignments applied in order.

Returns

GridOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Interactive.GridOptions { RefreshRow = value };    Ui.Options<global::ConsoleMonster.Interactive.GridOptions>().Configure(configured => configured.RefreshRow = value);
public static GridOptions Dispatcher(GridOptions gridOptions, AppDispatcher? value) #

Sets GridOptions.Dispatcher: Optional per-run mailbox, drained on the input thread and closed when the grid exits.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
value ConsoleMonster.Interactive.AppDispatcher? required
The value.

Returns

GridOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Interactive.GridOptions { Dispatcher = value };    Ui.Options<global::ConsoleMonster.Interactive.GridOptions>().Dispatcher(value);
public static GridOptions Filter(GridOptions gridOptions, string? value) #

Sets GridOptions.Filter: The filter to start with.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
value string? required
The value.

Returns

GridOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Interactive.GridOptions { Filter = value };    Ui.Options<global::ConsoleMonster.Interactive.GridOptions>().Filter(value);
Interactive 2 overloads
public static GridOptions Interactive(GridOptions gridOptions, InteractiveOptions? value) #

Sets GridOptions.Interactive: Prompt options (input, capture, theme, labels); null for the defaults.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
value ConsoleMonster.Interactive.InteractiveOptions? required
The value.

Returns

GridOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Interactive.GridOptions { Interactive = value };    Ui.Options<global::ConsoleMonster.Interactive.GridOptions>().Interactive(value);
public static GridOptions Interactive(GridOptions gridOptions, Action<InteractiveOptions> configure) #

Configures GridOptions.Interactive in place (creating it when not set): Prompt options (input, capture, theme, labels); null for the defaults.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.InteractiveOptions> required
Configures the value.

Returns

GridOptions The same instance.
public static GridOptions SortColumn(GridOptions gridOptions, int value) #

Sets GridOptions.SortColumn: The column to sort by at the start (by index), or -1 for the input order.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
value int required
The value.

Returns

GridOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Interactive.GridOptions { SortColumn = value };    Ui.Options<global::ConsoleMonster.Interactive.GridOptions>().SortColumn(value);
SortDescending 2 overloads
public static GridOptions SortDescending(GridOptions gridOptions, bool value) #

Sets GridOptions.SortDescending: Sorts descending at the start.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance.
value bool required
The value.

Returns

GridOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Interactive.GridOptions { SortDescending = value };    Ui.Options<global::ConsoleMonster.Interactive.GridOptions>().SortDescending(value);
public static GridOptions SortDescending(GridOptions gridOptions) #

Sets GridOptions.SortDescending to true.

Parameters

gridOptions ConsoleMonster.Interactive.GridOptions required
The instance to configure.

Returns

GridOptions The same instance.