Class
TelerikListView<TItem>

Represents a Telerik UI for Blazor ListView component that displays data in a customizable list format with support for templates, pagination, and CRUD operations. Use this component to present data items with rich, custom layouts beyond simple tables or grids. Supports editing workflows, custom templates for each item, header and footer content, and pagination for large datasets. Provides full CRUD capabilities with events for create, read, update, and delete operations.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

The type of data item that the ListView will display and manipulate. Each TItem instance represents a single row of data that will be rendered using the Template and can be edited using the EditTemplate.

Syntax:

cs-api-definition
public class TelerikListView<TItem> : GridBase<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>GridBase<TItem>TelerikListView<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>.Dispose()DataBoundComponent<TItem>.Rebind()DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()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.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)

Constructors

TelerikListView()

Declaration

cs-api-definition
public TelerikListView()

Properties

ComponentLoaderContainer

Declaration

cs-api-definition
public ComponentLoaderContainer ComponentLoaderContainer { get; set; }

Property Value

ComponentLoaderContainer

EditTemplate

Defines the layout and content displayed when a ListView item is being edited during CRUD operations. Access the item being edited through @context to bind form controls to item properties.

Declaration

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

Property Value

RenderFragment<TItem>

EnableLoaderContainer

Controls whether a loading indicator appears during data operations like fetching, editing, or deleting items. When enabled, shows a spinner overlay during OnRead, OnCreate, OnUpdate, and OnDelete operations. Default value is true.

Declaration

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

Property Value

bool

FooterTemplate

Defines content displayed at the bottom of the ListView below all data items and pagination controls.

Declaration

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

Property Value

RenderFragment

HeaderTemplate

Defines content displayed at the top of the ListView above all data items.

Declaration

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

Property Value

RenderFragment

ListViewSettings

Configures ListView settings including pagination behavior and layout options. Children: ListViewPagerSettings for controlling page size options, navigation style, and pager position.

Declaration

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

Property Value

RenderFragment

OnCancel

Fires when a user cancels editing of an item without saving changes, typically by clicking a Cancel button. Event provides ListViewCommandEventArgs with the item that was being edited and the ability to cancel the operation.

Declaration

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

Property Value

EventCallback<ListViewCommandEventArgs>

OnCreate

Fires when a user initiates the creation of a new item through ListView commands or actions. Event provides ListViewCommandEventArgs with the new item data and the ability to cancel the operation.

Declaration

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

Property Value

EventCallback<ListViewCommandEventArgs>

OnDelete

Fires when a user initiates deletion of an item through ListView commands or actions. Event provides ListViewCommandEventArgs with the item being deleted and the ability to cancel the operation.

Declaration

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

Property Value

EventCallback<ListViewCommandEventArgs>

OnEdit

Fires when a user initiates editing of an existing item through ListView commands or actions. Event provides ListViewCommandEventArgs with the item being edited and the ability to cancel the operation.

Declaration

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

Property Value

EventCallback<ListViewCommandEventArgs>

OnRead

Fires when the ListView needs to load data, enabling custom data source operations like filtering, sorting, and pagination. Cannot be combined with the Telerik.Blazor.Data parameter - choose either direct data binding or OnRead for data management. Provides ListViewReadEventArgs with paging and request information for implementing custom data logic.

Declaration

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

Property Value

EventCallback<ListViewReadEventArgs>

OnUpdate

Fires when a user confirms changes to an edited item, typically by clicking a Save or Update button. Event provides ListViewCommandEventArgs with the updated item data and the ability to cancel the operation.

Declaration

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

Property Value

EventCallback<ListViewCommandEventArgs>

Template

Defines the layout and content for each data item in the ListView using custom markup and data binding. Access item properties through @context to display data, format values, or bind to other components.

Declaration

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

Property Value

RenderFragment<TItem>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides DataBoundComponent<TItem>.OnParametersSetAsync()

SetFocusedItemIndex(int)

Declaration

cs-api-definition
public void SetFocusedItemIndex(int index)

Parameters

index

int