skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop
    Web
    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for ASP.NET AJAX UI for ASP.NET MVC UI for ASP.NET Core UI for Blazor UI for Silverlight UI for PHP UI for JSP
    Mobile
    UI for .NET MAUI UI for Xamarin
    Document Management
    Telerik Document Processing
    Desktop
    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF UI for UWP
    Reporting & Mocking
    Telerik Reporting Telerik Report Server Telerik JustMock
    Automated Testing
    Test Studio Test Studio Dev Edition
    CMS
    Sitefinity
    UI/UX Tools
    ThemeBuilder
    Debugging
    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Jam FiddlerCap FiddlerCore
    Extended Reality
    UI for Unity XR
    Free Tools
    JustAssembly JustDecompile VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Docs & Support
  • Pricing
  • Search
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class TelerikGrid<TItem>

The class for the Telerik Grid component.

Inheritance
System.Object
BaseComponent
DataBoundComponent<TItem>
GridBase<TItem>
TableGridBase<TItem, GridCommandEventArgs>
TelerikGrid<TItem>
Inherited Members
TableGridBase<TItem, GridCommandEventArgs>.Dispose()
TableGridBase<TItem, GridCommandEventArgs>.ResetEditContext()
TableGridBase<TItem, GridCommandEventArgs>.PageData()
TableGridBase<TItem, GridCommandEventArgs>.GetItemFromDropIndex(String)
TableGridBase<TItem, GridCommandEventArgs>.GetItemFromDropIndex(Int32)
TableGridBase<TItem, GridCommandEventArgs>.DialogFactory
TableGridBase<TItem, GridCommandEventArgs>.Id
TableGridBase<TItem, GridCommandEventArgs>.ColumnVirtualization
TableGridBase<TItem, GridCommandEventArgs>.AutoGenerateColumns
TableGridBase<TItem, GridCommandEventArgs>.Navigable
TableGridBase<TItem, GridCommandEventArgs>.RowTemplate
TableGridBase<TItem, GridCommandEventArgs>.NoDataTemplate
TableGridBase<TItem, GridCommandEventArgs>.Resizable
TableGridBase<TItem, GridCommandEventArgs>.Reorderable
TableGridBase<TItem, GridCommandEventArgs>.Sortable
TableGridBase<TItem, GridCommandEventArgs>.SortMode
TableGridBase<TItem, GridCommandEventArgs>.FilterMenuType
TableGridBase<TItem, GridCommandEventArgs>.SelectedItems
TableGridBase<TItem, GridCommandEventArgs>.SelectedItemsChanged
TableGridBase<TItem, GridCommandEventArgs>.EnableLoaderContainer
TableGridBase<TItem, GridCommandEventArgs>.RowDraggable
TableGridBase<TItem, GridCommandEventArgs>.ConfirmDelete
TableGridBase<TItem, GridCommandEventArgs>.RowHeight
TableGridBase<TItem, GridCommandEventArgs>.FilterRowDebounceDelay
TableGridBase<TItem, GridCommandEventArgs>.OnCreate
TableGridBase<TItem, GridCommandEventArgs>.OnUpdate
TableGridBase<TItem, GridCommandEventArgs>.OnDelete
TableGridBase<TItem, GridCommandEventArgs>.OnEdit
TableGridBase<TItem, GridCommandEventArgs>.OnAdd
TableGridBase<TItem, GridCommandEventArgs>.OnCancel
GridBase<TItem>.Width
GridBase<TItem>.Height
GridBase<TItem>.PageSizeChanged
GridBase<TItem>.PageSize
GridBase<TItem>.Page
GridBase<TItem>.PageChanged
GridBase<TItem>.Pageable
GridBase<TItem>.OnModelInit
GridBase<TItem>.TotalCount
DataBoundComponent<TItem>.Rebind()
DataBoundComponent<TItem>.Data
BaseComponent.ShouldRender()
BaseComponent.OnInitializedAsync()
BaseComponent.InitLocalizer()
BaseComponent.ThrowIfParameterIsNull(Object, String)
BaseComponent.HaveOptionsChanged(IDictionary<String, Object>, IDictionary<String, Object>)
BaseComponent.GetClassString(String[])
BaseComponent.InvokeAsync<T>(String, Object[])
BaseComponent.InvokeAsync<T>(String, CancellationToken, Object[])
BaseComponent.InvokeVoidAsync(String, Object[])
BaseComponent.InvokeComponentMethodAsync<T>(String, Object[])
BaseComponent.InvokeComponentMethodAsync<T>(String, CancellationToken, Object[])
BaseComponent.InvokeVoidComponentMethodAsync(String, Object[])
BaseComponent.InvokeDisposeAsync()
BaseComponent.StateHasChanged()
BaseComponent.RootComponent
BaseComponent.Class
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikGrid<TItem> : TableGridBase<TItem, GridCommandEventArgs>, IDisposable, IPagerContainer, IRowDraggableContainer, IValidationContainer, IPopupEditSettingsContainer, IGridContainer, IColumnContainer
Type Parameters
TItem

The type of the model to which the grid is bound.

Constructors

TelerikGrid()

Declaration
public TelerikGrid()

Properties

DetailTemplate

Defines the detail template of the grid.

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

EditMode

Defines the EditMode of the Grid. Supports None, Inline, Popup and Incell editing. The Default Option is None.

Declaration
public GridEditMode EditMode { get; set; }
Property Value
GridEditMode

FilterMode

Defines the Filter Mode of the Grid.

Declaration
public GridFilterMode FilterMode { get; set; }
Property Value
GridFilterMode

GridExport

Defines the export configuration.

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

GridPagerTemplate

Defines the template that will be displayed instead of the Pager.

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

GridSettings

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

GridToolBarTemplate

Defines the toolbar template of the Grid.

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

Groupable

Defines whether the Grid is groupable.

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

LoadGroupsOnDemand

Defines whether groups should be loaded on demand.

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

OnRead

Fires when the data source is read. Use this to attach your own paging, sorting and filtering logic. Once attached, you must implement all such data source operations here, the Component will no longer perform them for you.

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

OnRowClick

Fires when the user clicks on a row, or presses enter.

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

OnRowCollapse

Fires when the user collapses a row using mouse or keyboard.

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

OnRowContextMenu

Fires when the user triggers contextmenu event with click or context menu button.

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

OnRowDoubleClick

Fires when the user double-clicks on a row.

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

OnRowDrop

Fired when a row is dropped.

Declaration
public EventCallback<GridRowDropEventArgs<TItem>> OnRowDrop { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GridRowDropEventArgs<TItem>>

OnRowExpand

Fires when the user expands a row using mouse or keyboard.

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

OnRowRender

Called each time a row is rendered. Use this to add custom classes to the row based on the data item.

Declaration
public Action<GridRowRenderEventArgs> OnRowRender { get; set; }
Property Value
System.Action<GridRowRenderEventArgs>

OnStateChanged

Fires on user interaction that causes changes in the GridState<TItem>.

Declaration
public EventCallback<GridStateEventArgs<TItem>> OnStateChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GridStateEventArgs<TItem>>

OnStateInit

Invoked when the Grid is initialized and state could be loaded. Useful when you'd like to persist changed on page reloads.

Declaration
public EventCallback<GridStateEventArgs<TItem>> OnStateInit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<GridStateEventArgs<TItem>>

ScrollMode

Defines scrolling mode of the Grid. Possible values are Scrollable and Virtual.

Declaration
public GridScrollMode ScrollMode { get; set; }
Property Value
GridScrollMode

SelectionMode

Defines the Selection Mode of the Grid.

Declaration
public GridSelectionMode SelectionMode { get; set; }
Property Value
GridSelectionMode

ShowColumnMenu

Specifies if the column menu will be visible.

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

Size

Specifies the Size of the grid. Default value is Medium.

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

Methods

AutoFitAllColumns()

Declaration
public void AutoFitAllColumns()

AutoFitAllColumnsAsync()

Declaration
public Task AutoFitAllColumnsAsync()
Returns
System.Threading.Tasks.Task

AutoFitColumn(String)

Declaration
public void AutoFitColumn(string id)
Parameters
System.String id

AutoFitColumnAsync(String)

Declaration
public Task AutoFitColumnAsync(string id)
Parameters
System.String id

Returns
System.Threading.Tasks.Task

AutoFitColumns(IEnumerable<String>)

Declaration
public void AutoFitColumns(IEnumerable<string> ids)
Parameters
System.Collections.Generic.IEnumerable<System.String> ids

AutoFitColumnsAsync(IEnumerable<String>)

Declaration
public Task AutoFitColumnsAsync(IEnumerable<string> ids)
Parameters
System.Collections.Generic.IEnumerable<System.String> ids

Returns
System.Threading.Tasks.Task

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

Dispose()

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

ExportToCsvAsync()

Exports the grid to a stream that can be saved as a CSV file.

Declaration
public Task<MemoryStream> ExportToCsvAsync()
Returns
System.Threading.Tasks.Task<System.IO.MemoryStream>

ExportToExcelAsync()

Exports the grid to a stream that can be saved as an Excel file.

Declaration
public Task<MemoryStream> ExportToExcelAsync()
Returns
System.Threading.Tasks.Task<System.IO.MemoryStream>

GetItemFromDropIndex(Int32)

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

Returns
TItem

Overrides
Telerik.Blazor.Components.Common.TableGridBase<TItem, Telerik.Blazor.Components.GridCommandEventArgs>.GetItemFromDropIndex(System.Int32)

GetState()

Gets the current state of the Grid. Includes grouping, filtering, edit items, column state, etc.

Declaration
public GridState<TItem> GetState()
Returns
GridState<TItem>

Instance of a GridState<TItem> class that contains all data.

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean firstRender

Returns
System.Threading.Tasks.Task

Overrides
BaseComponent.OnAfterRenderAsync(Boolean)

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task

Overrides
Telerik.Blazor.Components.Common.DataBoundComponent<TItem>.OnParametersSetAsync()

PageData()

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

Overrides
Telerik.Blazor.Components.Common.TableGridBase<TItem, Telerik.Blazor.Components.GridCommandEventArgs>.PageData()

SaveAsCsvFileAsync()

Exports the grid to a file and sends it to the browser for download.

Declaration
public ValueTask SaveAsCsvFileAsync()
Returns
System.Threading.Tasks.ValueTask

SaveAsExcelFileAsync()

Exports the grid to a file and sends it to the browser for download.

Declaration
public ValueTask SaveAsExcelFileAsync()
Returns
System.Threading.Tasks.ValueTask

SetParametersAsync(ParameterView)

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Microsoft.AspNetCore.Components.ParameterView parameters

Returns
System.Threading.Tasks.Task

Overrides
Telerik.Blazor.Components.Common.DataBoundComponent<TItem>.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView)

SetStateAsync(GridState<TItem>)

Sets the state of the Grid. Includes grouping, filtering, edit items, column state, etc.

Declaration
public Task SetStateAsync(GridState<TItem> state)
Parameters
GridState<TItem> state

Returns
System.Threading.Tasks.Task

Was this article helpful?

Tell us how we can improve this article

Skip
Getting Started
  • Client-side Blazor
  • Server-side Blazor
  • Demos
Community
  • Forums
  • Blogs
  • Feedback Portal
Support Resources
  • Demos
  • Knowledge Base
  • Samples Repo
  • Localizations Repo
Sample Applications
  • Dashboard
  • PWA - Stocks
  • PWA - Blazing Coffee Roasters

Copyright © 2019 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.