Skip to content
ConsoleMonster
Class

DataGridInputOptions

ConsoleMonster.Interactive

Edit on GitHub
Namespace
ConsoleMonster.Interactive
Assembly
ConsoleMonster
Source
DataGridInputOptions.cs:9
Base
AppInputOptions
Modifiers
sealed

Named grid configuration shared by Ui.DataGrid and New-ConsoleDataGrid.

Inheritance

Usage

Explore 41 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 19

Accepted by parameters 22

Constructors

public DataGridInputOptions() #
DataGridInputOptions.cs:9

Methods

public DataGrid Build() #
DataGridInputOptions.cs:14

Creates the persistent input after its key and listing are configured.

Returns

DataGrid

Properties

public Grid? Grid { get; set; } #
DataGridInputOptions.cs:7

Rows and columns, including original objects and stable identities.

public int Height { get; set; } #
DataGridInputOptions.cs:9

Natural visible content height.

public bool QuickSearch { get; set; } #
DataGridInputOptions.cs:11

Whether unbound typing performs prefix search.

Extension Methods

public static DataGridInputOptions Configure(DataGridInputOptions dataGridInputOptions, Action<DataGridInputOptions> configure) #

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

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.DataGridInputOptions> required
Assignments applied in order.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { OnChange = value };    Ui.DataGrid().Configure(configured => configured.OnChange = value);
Disabled 2 overloads
public static DataGridInputOptions Disabled(DataGridInputOptions dataGridInputOptions, bool value) #

Sets AppInputOptions.Disabled: Disables editing and keyboard focus.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value bool required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { Disabled = value };    Ui.DataGrid().Disabled(value);
public static DataGridInputOptions Disabled(DataGridInputOptions dataGridInputOptions) #

Sets AppInputOptions.Disabled to true.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance to configure.

Returns

DataGridInputOptions The same instance.
Grid 2 overloads
public static DataGridInputOptions Grid(DataGridInputOptions dataGridInputOptions, Grid? value) #

Sets DataGridInputOptions.Grid: Rows and columns, including original objects and stable identities.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value ConsoleMonster.Interactive.Grid? required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { Grid = value };    Ui.DataGrid().Grid(value);
public static DataGridInputOptions Grid(DataGridInputOptions dataGridInputOptions, Action<Grid> configure) #

Configures DataGridInputOptions.Grid in place: Rows and columns, including original objects and stable identities.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.Grid> required
Configures the value.

Returns

DataGridInputOptions The same instance.
public static DataGridInputOptions Height(DataGridInputOptions dataGridInputOptions, int value) #

Sets DataGridInputOptions.Height: Natural visible content height.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value int required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { Height = value };    Ui.DataGrid().Height(value);
public static DataGridInputOptions Key(DataGridInputOptions dataGridInputOptions, string value) #

Sets AppInputOptions.Key: The unique application-state key.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value string required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { Key = value };    Ui.DataGrid().Key(value);
public static DataGridInputOptions Label(DataGridInputOptions dataGridInputOptions, string? value) #

Sets AppInputOptions.Label: The visible label; null uses the key.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value string? required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                     // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { Label = value };    Ui.DataGrid().Label(value);
QuickSearch 2 overloads
public static DataGridInputOptions QuickSearch(DataGridInputOptions dataGridInputOptions, bool value) #

Sets DataGridInputOptions.QuickSearch: Whether unbound typing performs prefix search.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value bool required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                           // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { QuickSearch = value };    Ui.DataGrid().QuickSearch(value);
public static DataGridInputOptions QuickSearch(DataGridInputOptions dataGridInputOptions) #

Sets DataGridInputOptions.QuickSearch to true.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance to configure.

Returns

DataGridInputOptions The same instance.
public static DataGridInputOptions TabIndex(DataGridInputOptions dataGridInputOptions, int value) #

Sets AppInputOptions.TabIndex: Keyboard focus order; equal values preserve declaration order.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value int required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { TabIndex = value };    Ui.DataGrid().TabIndex(value);
public static DataGridInputOptions ValidationMessage(DataGridInputOptions dataGridInputOptions, string? value) #

Sets AppInputOptions.ValidationMessage: Initial validation text.

Parameters

dataGridInputOptions ConsoleMonster.Interactive.DataGridInputOptions required
The instance.
value string? required
The value.

Returns

DataGridInputOptions The same instance.

Examples

// C# initializer or property                                                                 // C# fluent
new global::ConsoleMonster.Interactive.DataGridInputOptions { ValidationMessage = value };    Ui.DataGrid().ValidationMessage(value);