Class
TableGridBase<TItem, TCommandEventArgs>

Definition

Namespace:Telerik.Blazor.Components.Common

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

TCommandEventArgs

Syntax:

cs-api-definition
public abstract class TableGridBase<TItem, TCommandEventArgs> : GridBase<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable where TCommandEventArgs : TableGridBaseCommandEventArgs, new()

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>GridBase<TItem>TableGridBase<TItem, TCommandEventArgs>

Derived Classes: TelerikGrid<TItem>TelerikTreeList<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members GridBase<TItem>.WidthGridBase<TItem>.HeightGridBase<TItem>.PageSizeChangedGridBase<TItem>.PageSizeGridBase<TItem>.PageGridBase<TItem>.PageChangedGridBase<TItem>.PageableGridBase<TItem>.OnModelInitGridBase<TItem>.TotalCountDataBoundComponent<TItem>.SetParametersAsync(ParameterView)DataBoundComponent<TItem>.OnParametersSetAsync()DataBoundComponent<TItem>.Rebind()DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.OnAfterRenderAsync(bool)BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.BuildRenderTree(RenderTreeBuilder)ComponentBase.OnInitialized()ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TableGridBase()

Declaration

cs-api-definition
protected TableGridBase()

Fields

_selectedItemsMap

Declaration

cs-api-definition
protected HashSet<TItem> _selectedItemsMap

Field Value

HashSet<TItem>

Properties

AutoGenerateColumns

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

Declaration

cs-api-definition
[Parameter]
public bool AutoGenerateColumns { get; set; }

Property Value

bool

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

cs-api-definition
[Parameter]
public bool ColumnVirtualization { get; set; }

Property Value

bool

ConfirmDelete

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

Declaration

cs-api-definition
[Parameter]
public bool ConfirmDelete { get; set; }

Property Value

bool

DialogFactory

Declaration

cs-api-definition
[CascadingParameter]
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

cs-api-definition
[Parameter]
public bool EnableLoaderContainer { get; set; }

Property Value

bool

FilterMenuType

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

Declaration

cs-api-definition
[Parameter]
public FilterMenuType FilterMenuType { get; set; }

Property Value

FilterMenuType

FilterRowDebounceDelay

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

Declaration

cs-api-definition
[Parameter]
public int FilterRowDebounceDelay { get; set; }

Property Value

int

Id

Defines the id HTML attribute of the Component.

Declaration

cs-api-definition
[Parameter]
public string Id { get; set; }

Property Value

string

Navigable

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

Declaration

cs-api-definition
[Parameter]
public bool Navigable { get; set; }

Property Value

bool

NoDataTemplate

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

Declaration

cs-api-definition
[Parameter]
public RenderFragment NoDataTemplate { get; set; }

Property Value

RenderFragment

OnAdd

Fires when users click on the Add command button.

Declaration

cs-api-definition
[Parameter]
public EventCallback<TCommandEventArgs> OnAdd { get; set; }

Property Value

EventCallback<TCommandEventArgs>

OnCancel

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TCommandEventArgs> OnCancel { get; set; }

Property Value

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

cs-api-definition
[Parameter]
public EventCallback<TCommandEventArgs> OnCreate { get; set; }

Property Value

EventCallback<TCommandEventArgs>

OnDelete

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TCommandEventArgs> OnDelete { get; set; }

Property Value

EventCallback<TCommandEventArgs>

OnEdit

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

Declaration

cs-api-definition
[Parameter]
public EventCallback<TCommandEventArgs> OnEdit { get; set; }

Property Value

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

cs-api-definition
[Parameter]
public EventCallback<TCommandEventArgs> OnUpdate { get; set; }

Property Value

EventCallback<TCommandEventArgs>

Reorderable

Defines if users can reorder columns.

Declaration

cs-api-definition
[Parameter]
public bool Reorderable { get; set; }

Property Value

bool

Resizable

Defines if users can resize columns.

Declaration

cs-api-definition
[Parameter]
public bool Resizable { get; set; }

Property Value

bool

RowDraggable

Defines if users can drag (reorder) data rows.

Declaration

cs-api-definition
[Parameter]
public bool RowDraggable { get; set; }

Property Value

bool

RowHeight

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

Declaration

cs-api-definition
[Parameter]
public decimal RowHeight { get; set; }

Property Value

decimal

RowTemplate

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

Declaration

cs-api-definition
[Parameter]
public RenderFragment<TItem> RowTemplate { get; set; }

Property Value

RenderFragment<TItem>

SelectedItems

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

Declaration

cs-api-definition
[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }

Property Value

IEnumerable<TItem>

SelectedItemsChanged

The event fires when users select or unselect items.

Declaration

cs-api-definition
[Parameter]
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }

Property Value

EventCallback<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

cs-api-definition
[Parameter]
public bool ShowColumnMenu { get; set; }

Property Value

bool

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

cs-api-definition
[Parameter]
public SortMode SortMode { get; set; }

Property Value

SortMode

Sortable

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

Declaration

cs-api-definition
[Parameter]
public bool Sortable { get; set; }

Property Value

bool

Methods

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides DataBoundComponent<TItem>.Dispose()

GetItemFromDropIndex(int)

Declaration

cs-api-definition
protected abstract TItem GetItemFromDropIndex(int index)

Parameters

index

int

Returns

TItem

GetItemFromDropIndex(string)

Gets the data item instance at the specified index position.

Declaration

cs-api-definition
public TItem GetItemFromDropIndex(string index)

Parameters

index

string

The index position within the currently rendered data rows.

Returns

TItem

An object of type TItem.

HandleVirtualScrollPaging()

Declaration

cs-api-definition
protected Task HandleVirtualScrollPaging()

Returns

Task

OnAfterRender(bool)

Declaration

cs-api-definition
protected override void OnAfterRender(bool firstRender)

Parameters

firstRender

bool

Overrides ComponentBase.OnAfterRender(bool)

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

PageData()

Declaration

cs-api-definition
protected virtual Task PageData()

Returns

Task

ResetEditContext()

Declaration

cs-api-definition
protected void ResetEditContext()

SetMultiColumnHeaders()

Declaration

cs-api-definition
protected void SetMultiColumnHeaders()

SetSkip(int)

Declaration

cs-api-definition
protected abstract void SetSkip(int skip)

Parameters

skip

int