Class TableGridBase<TItem, TCommandEventArgs>

Inheritance
System.Object
BaseComponent
DataBoundComponent<TItem>
GridBase<TItem>
TableGridBase<TItem, TCommandEventArgs>
TelerikGrid<TItem>
TelerikTreeList<TItem>
Inherited Members
Namespace: Telerik.Blazor.Components.Common
Assembly: Telerik.Blazor.dll

Syntax

public abstract class TableGridBase<TItem, TCommandEventArgs> : GridBase<TItem>, IDisposable, IPagerContainer, IColumnContainer, IRowDraggableContainer, IValidationContainer, IPopupEditSettingsContainer where TCommandEventArgs : TableGridBaseCommandEventArgs, new()
Type Parameters
TItem

TCommandEventArgs

Constructors

TableGridBase()

Declaration
protected TableGridBase()

Fields

_selectedItemsMap

Declaration
protected HashSet<TItem> _selectedItemsMap
Field Value
System.Collections.Generic.HashSet<TItem>

Properties

AutoGenerateColumns

Defines if the Component will create columns automatically, based on the data item properties.

Declaration
public bool AutoGenerateColumns { get; set; }
Property Value
System.Boolean

ColumnVirtualization

Defines if the Component will use UI virtualization for its columns, and render only the ones that are visible or close to the scrollable area.

Declaration
public bool ColumnVirtualization { get; set; }
Property Value
System.Boolean

ConfirmDelete

Defines if the Component will require users to confirm delete operations.

Declaration
public bool ConfirmDelete { get; set; }
Property Value
System.Boolean

DialogFactory

Declaration
protected DialogFactory DialogFactory { get; set; }
Property Value
DialogFactory

EnableLoaderContainer

Defines if a loading indicator displays during long-running operations. The default value is true. The setting has no effect on initial data load.

Declaration
public bool EnableLoaderContainer { get; set; }
Property Value
System.Boolean

FilterMenuType

Defines the filtering UI when the FilterMode is FilterMenu. The available options are Telerik.Blazor.FilterMenuType.Menu (default) and Telerik.Blazor.FilterMenuType.CheckBoxList.

Declaration
public FilterMenuType FilterMenuType { get; set; }
Property Value
Telerik.Blazor.FilterMenuType

FilterRowDebounceDelay

Time in ms between the last typed symbol and the firing of the internal filter oninput event. Default is 150ms.

Declaration
public int FilterRowDebounceDelay { get; set; }
Property Value
System.Int32

Id

Defines the id HTML attribute of the Component.

Declaration
public string Id { get; set; }
Property Value
System.String

Navigable

Defines if users can navigate the Component and execute actions via the keyboard. The default value is false.

Declaration
public bool Navigable { get; set; }
Property Value
System.Boolean

NoDataTemplate

Defines the template that will display when the Component has no data to show.

Declaration
public RenderFragment NoDataTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

OnAdd

Fires when users click on the Add command button.

Declaration
public EventCallback<TCommandEventArgs> OnAdd { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TCommandEventArgs>

OnCancel

Fires when users cancel edit mode via the Cancel command button or Esc keypress.

Declaration
public EventCallback<TCommandEventArgs> OnCancel { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TCommandEventArgs>

OnCreate

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
public EventCallback<TCommandEventArgs> OnCreate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TCommandEventArgs>

OnDelete

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

Declaration
public EventCallback<TCommandEventArgs> OnDelete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TCommandEventArgs>

OnEdit

Fires when users enter edit mode via the Edit command button, a cell click or Enter keypress.

Declaration
public EventCallback<TCommandEventArgs> OnEdit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TCommandEventArgs>

OnUpdate

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

Declaration
public EventCallback<TCommandEventArgs> OnUpdate { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TCommandEventArgs>

Reorderable

Defines if users can reorder columns.

Declaration
public bool Reorderable { get; set; }
Property Value
System.Boolean

Resizable

Defines if users can resize columns.

Declaration
public bool Resizable { get; set; }
Property Value
System.Boolean

RowDraggable

Defines if users can drag (reorder) data rows.

Declaration
public bool RowDraggable { get; set; }
Property Value
System.Boolean

RowHeight

Defines the height of each table row in the Component. Accepts a number and is applied as pixels.

Declaration
public Decimal RowHeight { get; set; }
Property Value
System.Decimal

RowTemplate

Defines the Component row template that will render inside each tr tag.

Declaration
public RenderFragment<TItem> RowTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<TItem>

SelectedItems

Defines the collection of selected items. The parameter supports two-way binding. Also set SelectionMode.

Declaration
public IEnumerable<TItem> SelectedItems { get; set; }
Property Value
System.Collections.Generic.IEnumerable<TItem>

SelectedItemsChanged

The event fires when users select or unselect items.

Declaration
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TItem>>

ShowColumnMenu

Specifies if header cells will render a button to display a column menu. Use ShowColumnMenu to disable the menu at column level.

Declaration
public bool ShowColumnMenu { get; set; }
Property Value
System.Boolean

Sortable

Defines if users can sort the data by clicking on the column headers.

Declaration
public bool Sortable { get; set; }
Property Value
System.Boolean

SortMode

Defines if users can sort one or multiple columns at the same time. The available options are Single (default) and Multiple. Sortable must be enabled.

Declaration
public SortMode SortMode { get; set; }
Property Value
SortMode

Methods

Dispose()

Declaration
public override void Dispose()
Overrides
Telerik.Blazor.Components.Common.DataBoundComponent<TItem>.Dispose()

GetItemFromDropIndex(Int32)

Declaration
protected abstract TItem GetItemFromDropIndex(int index)
Parameters
System.Int32 index

Returns
TItem

GetItemFromDropIndex(String)

Gets the data item instance at the specified index position.

Declaration
public TItem GetItemFromDropIndex(string index)
Parameters
System.String index

The index position within the currently rendered data rows.
Returns
TItem

An object of type TItem.

HandleVirtualScrollPaging()

Declaration
protected Task HandleVirtualScrollPaging()
Returns
System.Threading.Tasks.Task

OnAfterRender(Boolean)

Declaration
protected override void OnAfterRender(bool firstRender)
Parameters
System.Boolean firstRender

OnParametersSet()

Declaration
protected override void OnParametersSet()

PageData()

Declaration
protected virtual Task PageData()
Returns
System.Threading.Tasks.Task

ResetEditContext()

Declaration
protected void ResetEditContext()

SetMultiColumnHeaders()

Declaration
protected void SetMultiColumnHeaders()

SetSkip(Int32)

Declaration
protected abstract void SetSkip(int skip)
Parameters
System.Int32 skip