Class

TableGridBase<TItem, TCommandEventArgs>

Declaration

protected TableGridBase()

Declaration

protected HashSet<TItem> _selectedItemsMap

Field Value

Automatically creates columns based on data model properties when no columns are explicitly defined. Set to false to define columns manually. Cannot be used with dynamic objects (like ExpandoObject) - use explicit column definitions instead.

Declaration

[Parameter]
public bool AutoGenerateColumns { get; set; }

Property Value

Enables column virtualization to improve performance when working with a large number of columns. This feature ensures that only the columns visible in the current viewport are rendered, reducing the rendering load and improving performance and responsiveness. This is particularly useful for grids with many columns, as it enhances scrolling performance and overall user experience.

Declaration

[Parameter]
public bool ColumnVirtualization { get; set; }

Property Value

Requires users to confirm before deleting data items. Shows a confirmation dialog to prevent accidental deletions.

Declaration

[Parameter]
public bool ConfirmDelete { get; set; }

Property Value

Declaration

public AdaptiveBreakpoint CurrentBreakpoint { get; set; }

Property Value

Declaration

[CascadingParameter]
protected DialogFactory DialogFactory { get; set; }

Property Value

Shows a loading indicator during long-running operations like data requests or exports. The default value is true. This has no effect on initial data load.

Declaration

[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

Determines the filter menu interface when GridFilterMode is FilterMenu. Use Menu for traditional filters or CheckBoxList for multi-select filtering.

Declaration

[Parameter]
public FilterMenuType FilterMenuType { get; set; }

Property Value

Delay in milliseconds between when user stops typing in filter rows and when filtering is applied. Use this to prevent excessive filtering during typing. Default is 150ms.

Declaration

[Parameter]
public int FilterRowDebounceDelay { get; set; }

Property Value

Defines the id HTML attribute of the Component.

Declaration

[Parameter]
public string Id { get; set; }

Property Value

Declaration

public bool IsPopupRendering { get; }

Property Value

Enables keyboard navigation through Grid cells and rows using arrow keys, Tab, Enter, and other keyboard shortcuts for accessibility.

Declaration

[Parameter]
public bool Navigable { get; set; }

Property Value

Template displayed when the Grid has no data to show. Use this to show custom messages or call-to-action buttons for empty states.

Declaration

[Parameter]
public RenderFragment NoDataTemplate { get; set; }

Property Value

Fires when users click on the Add command button to start creating a new data item. Use this to initialize default values or prepare the edit form.

Declaration

[Parameter]
public EventCallback<TCommandEventArgs> OnAdd { get; set; }

Property Value

Fires when users cancel edit mode via the Cancel command button or Esc key. Use this to clean up temporary data or refresh state.

Declaration

[Parameter]
public EventCallback<TCommandEventArgs> OnCancel { get; set; }

Property Value

Fires when the Create command is executed. In Popup and Inline modes, this is when users save the new data item. In Incell mode, this event follows immediately the OnAdd event.

Declaration

[Parameter]
public EventCallback<TCommandEventArgs> OnCreate { get; set; }

Property Value

Fires when users click on the Delete command button or when they confirm the delete operation. See ConfirmDelete for confirmation settings.

Declaration

[Parameter]
public EventCallback<TCommandEventArgs> OnDelete { get; set; }

Property Value

Fires when users enter edit mode via the Edit command button, cell click, or Enter keypress. Use this to customize the editing experience.

Declaration

[Parameter]
public EventCallback<TCommandEventArgs> OnEdit { get; set; }

Property Value

Fires when the Update command is executed. In Popup and Inline modes, this is when users save the data item. In Incell mode, this is when users blur the edit cell or press Enter.

Declaration

[Parameter]
public EventCallback<TCommandEventArgs> OnUpdate { get; set; }

Property Value

Allows users to drag and drop column headers to change the column order. Enable this for customizable column arrangements.

Declaration

[Parameter]
public bool Reorderable { get; set; }

Property Value

Allows users to drag column borders to adjust column widths interactively. Enable this for better user control over column sizing.

Declaration

[Parameter]
public bool Resizable { get; set; }

Property Value

Enables users to drag and drop rows to reorder data. Use the GridRowDropEventArgs<TItem> event to handle row reordering logic. Not compatible with grouping functionality (Groupable).

Declaration

[Parameter]
public bool RowDraggable { get; set; }

Property Value

Sets the height of each table row in pixels. This is required when using virtual scrolling (Virtual) for performance calculations. When virtual scrolling is enabled, both RowHeight and Height must be specified.

Declaration

[Parameter]
public decimal RowHeight { get; set; }

Property Value

Custom template for rendering Grid rows. Use this to create completely custom row layouts instead of the default table row structure.

Declaration

[Parameter]
public RenderFragment<TItem> RowTemplate { get; set; }

Property Value

Collection of currently selected data items when row selection is enabled. Supports two-way binding for programmatic selection management. Also set GridSelectionMode to enable selection functionality.

Declaration

[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }

Property Value

Event triggered when the row selection changes. Use this event to handle user actions such as selecting or deselecting rows in the Grid. Pair it with the Value parameter (one-way binding) to track and respond to selection state changes.

Declaration

[Parameter]
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }

Property Value

Shows a menu button in column headers that provides options for sorting, filtering, grouping, and column visibility. Use ShowColumnMenu to disable the menu for specific columns.

Declaration

[Parameter]
public bool ShowColumnMenu { get; set; }

Property Value

Controls whether users can sort by one column at a time or multiple columns simultaneously. Use Multiple for complex sorting scenarios. The available options are Single (default) and Multiple. Sortable must be enabled.

Declaration

[Parameter]
public SortMode SortMode { get; set; }

Property Value

Enables data sorting by clicking on column headers. Users can sort data in ascending or descending order to organize information.

Declaration

[Parameter]
public bool Sortable { get; set; }

Property Value

Declaration

public override void Dispose()

Overrides DataBoundComponent<TItem>.Dispose()

Declaration

protected abstract TItem GetItemFromDropIndex(int index)

Parameters

Returns

Gets the data item instance at the specified index position.

Declaration

public TItem GetItemFromDropIndex(string index)

Parameters

Returns

Declaration

protected Task HandleVirtualScrollPaging()

Returns

Declaration

protected override void OnAfterRender(bool firstRender)

Parameters

Overrides ComponentBase.OnAfterRender(bool)

Declaration

protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

Declaration

protected virtual Task PageData()

Returns

Declaration

protected void ResetEditContext()

Declaration

protected void SetMultiColumnHeaders()

Declaration

protected abstract void SetSkip(int skip)

Parameters