ClassTableGridBase<TItem, TCommandEventArgs>
Definition
Namespace:Telerik.Blazor.Components.Common
Assembly:Telerik.Blazor.dll
Type Parameters:
TItem
TCommandEventArgs
Syntax:
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:
Implements:
Inherited Members
Constructors
TableGridBase()
Declaration
protected TableGridBase()
Fields
Properties
AutoGenerateColumns
Defines if the Component will create columns automatically, based on the data item properties.
Declaration
[Parameter]
public bool AutoGenerateColumns { get; set; }
Property Value
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
[Parameter]
public bool ColumnVirtualization { get; set; }
Property Value
ConfirmDelete
Defines if the Component will require users to confirm delete operations.
Declaration
[Parameter]
public bool ConfirmDelete { get; set; }
Property Value
DialogFactory
Declaration
[CascadingParameter]
protected DialogFactory DialogFactory { get; set; }
Property Value
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
[Parameter]
public bool EnableLoaderContainer { get; set; }
Property Value
FilterMenuType
Defines the filtering UI when the FilterMode
is FilterMenu
. The available options are Menu (default) and CheckBoxList.
Declaration
[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
[Parameter]
public int FilterRowDebounceDelay { get; set; }
Property Value
Id
Defines the id
HTML attribute of the Component.
Navigable
Defines if users can navigate the Component and execute actions via the keyboard. The default value is false
.
NoDataTemplate
Defines the template that will display when the Component has no data to show.
Declaration
[Parameter]
public RenderFragment NoDataTemplate { get; set; }
Property Value
OnAdd
Fires when users click on the Add command button.
Declaration
[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
[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
[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
[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
[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
[Parameter]
public EventCallback<TCommandEventArgs> OnUpdate { get; set; }
Property Value
EventCallback<TCommandEventArgs>
Reorderable
Defines if users can reorder columns.
Resizable
Defines if users can resize columns.
RowDraggable
Defines if users can drag (reorder) data rows.
Declaration
[Parameter]
public bool RowDraggable { get; set; }
Property Value
RowHeight
Defines the height of each table row in the Component. Accepts a number and is applied as pixels.
Declaration
[Parameter]
public decimal RowHeight { get; set; }
Property Value
RowTemplate
Defines the Component row template that will render inside each tr
tag.
Declaration
[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
[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }
Property Value
IEnumerable<TItem>
SelectedItemsChanged
The event fires when users select or unselect items.
Declaration
[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
[Parameter]
public bool ShowColumnMenu { get; set; }
Property Value
Methods
Dispose()
Declaration
public override void Dispose()
Overrides
GetItemFromDropIndex(int)
Declaration
protected abstract TItem GetItemFromDropIndex(int index)
Parameters
index
Returns
TItem
GetItemFromDropIndex(string)
Gets the data item instance at the specified index position.
Declaration
public TItem GetItemFromDropIndex(string index)
Parameters
index
The index position within the currently rendered data rows.
Returns
TItem
An object of type TItem
.
OnAfterRender(bool)
Declaration
protected override void OnAfterRender(bool firstRender)
Parameters
firstRender
Overrides
OnParametersSet()
Declaration
protected override void OnParametersSet()
Overrides
ResetEditContext()
Declaration
protected void ResetEditContext()
SetMultiColumnHeaders()
Declaration
protected void SetMultiColumnHeaders()