Class SfListView<TValue>

Component for executing complex list items common functionalities.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfListView<TValue>

Namespace: Syncfusion.Blazor.Lists

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfListView<TValue> : SfBaseComponent

Type Parameters

Name	Description
TValue	The generic type parameter.

Constructors

SfListView()

Declaration

public SfListView()

Properties

Animation

The Animation property provides an option to apply the different animations on the ListView component.

Declaration

public AnimationSettings Animation { get; set; }

Property Value

Type	Description
AnimationSettings

CheckBoxPosition

The CheckBoxPosition is used to set the position of check box in a list item. By default, the checkBoxPosition is Left, which will appear before the text content in a list item.

Declaration

public CheckBoxPosition CheckBoxPosition { get; set; }

Property Value

Type	Description
CheckBoxPosition

CssClass

The CssClass property is used to add a user-preferred class name in the root element of the ListView, using which we can customize the component (both CSS and functionality customization).

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

DataSource

The DataSource provides the data to render the ListView component which is mapped with the fields of ListView.

Declaration

public IEnumerable<TValue> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TValue>

Enabled

If Enabled set to true, the list items are enabled. And, we can disable the component using this property by setting its value as false.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

EnableVirtualization

If EnableVirtualization set to true, which will increase the ListView performance, while loading a large amount of data.

Declaration

public bool EnableVirtualization { get; set; }

Property Value

Type	Description
System.Boolean

Fields

The Fields is used to map keys from the dataSource which extracts the appropriate data from the dataSource with specified mapped with the column fields to render the ListView.

Declaration

public ListViewFieldSettings<TValue> Fields { get; set; }

Property Value

Type	Description
ListViewFieldSettings<TValue>

GroupTemplate

The ListView has an option to custom design the group header title with the help of groupTemplate property.

Declaration

public RenderFragment<ComposedItemModel<TValue>> GroupTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<Syncfusion.Blazor.Lists.ComposedItemModel<TValue>>

HeaderTemplate

The ListView has an option to custom design the ListView header title with the help of headerTemplate property.

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

HeaderTitle

The HeaderTitle is used to set the title of the ListView component.

Declaration

public string HeaderTitle { get; set; }

Property Value

Type	Description
System.String

Height

Defines the height of the ListView component.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HtmlAttributes

The HtmlAttributes allows additional attributes such as id, class, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

The ID property is used as a key to identify our element.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Query

The Query is used to fetch the specific data from dataSource by using where and select keywords.

Declaration

public Query Query { get; set; }

Property Value

Type	Description
Query

ShowCheckBox

If ShowCheckBox set to true, which will show or hide the checkbox.

Declaration

public bool ShowCheckBox { get; set; }

Property Value

Type	Description
System.Boolean

ShowHeader

If ShowHeader set to true, which will show or hide the header of the ListView component.

Declaration

public bool ShowHeader { get; set; }

Property Value

Type	Description
System.Boolean

ShowIcon

If ShowIcon set to true, which will show or hide the icon of the list item.

Declaration

public bool ShowIcon { get; set; }

Property Value

Type	Description
System.Boolean

SortOrder

The SortOrder is used to sort the data source. The available type of sort orders are, None - The data source is not sorting. Ascending - The data source is sorting with ascending order. Descending - The data source is sorting with descending order.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type	Description
SortOrder

Template

The ListView supports to customize the content of each list items with the help of template property.

Declaration

public RenderFragment<TValue> Template { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<TValue>

Width

Defines the width of the ListView component.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

AddItem(IEnumerable<TValue>)

Adds the new list item(s) to the current ListView. To add a new list item(s) in the ListView, we need to pass the Data as an array of items that need data like fields: TValue { fieldName: fieldValue }.

Declaration

public void AddItem(IEnumerable<TValue> data)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TValue>	data	Specifies the arguement data.

Back()

Switches back from the navigated sub list item.

Declaration

public Task Back()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

CheckAllItems()

Checks all the unchecked items in the ListView.

Declaration

public Task CheckAllItems()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

CheckItem(TValue)

Checks the specific list item by passing the unchecked fields as an argument to this method. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public Task CheckItem(TValue listItem)

Parameters

Type	Name	Description
TValue	listItem	Specifies the list item arguement.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FindItem(TValue)

Finds out an item details from the current list. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public TValue FindItem(TValue listItem)

Parameters

Type	Name	Description
TValue	listItem	Specifies the list item arguement.

Returns

Type	Description
TValue	TValue.

GetPropertyStyle()

Get style Attributes value.

Declaration

protected string GetPropertyStyle()

Returns

Type	Description
System.String	returns property styles.

GetSelectedItems()

Gets the details of the currently selected item from the list items.

Declaration

public Task<SelectedItems<TValue>> GetSelectedItems()

Returns

Type	Description
System.Threading.Tasks.Task<SelectedItems<TValue>>	Task.

HideItem(TValue)

Hides an list item from the ListView. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public Task HideItem(TValue listItem)

Parameters

Type	Name	Description
TValue	listItem	Specifies the list item arguement.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	Set to true for the first time component rendering; otherwise gets false.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitialized()

Method invoked when the component is ready to start.

Declaration

protected override void OnInitialized()

OnParametersSetAsync()

Method invoked when any changes in component state occurs.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

RefreshItemHeight()

Refresh the item height of the list item.

Declaration

public Task RefreshItemHeight()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

Render()

This method has been deprecated as we achieve this behaviour by using default behaviour of blazor framework.

Declaration

public Task Render()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

SelectItem(TValue)

Selects the list item from the ListView by passing field object. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public Task SelectItem(TValue listItem)

Parameters

Type	Name	Description
TValue	listItem	Specifies the list item arguement.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

SelectMultipleItems(IEnumerable<TValue>)

Selects multiple list items from the ListView. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public Task SelectMultipleItems(IEnumerable<TValue> listItems)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TValue>	listItems	Specifies the list items arguement.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ShowItem(TValue)

Shows the hide list item from the ListView. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public Task ShowItem(TValue listItem)

Parameters

Type	Name	Description
TValue	listItem	Specifies the list item arguement.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

UncheckAllItems()

Uncheck all the checked items in ListView.

Declaration

public Task UncheckAllItems()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

UncheckItem(TValue)

Uncheck the specific list item by passing the checked fields as an argument to this method. listItem like fields: TValue { fieldName: fieldValue }.

Declaration

public Task UncheckItem(TValue listItem)

Parameters

Type	Name	Description
TValue	listItem	Specifies the list item arguement.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

UpdateListViewDataSource(Boolean, IEnumerable<TValue>)

Updates listview datasource.

Declaration

protected void UpdateListViewDataSource(bool updateSortedData = false, IEnumerable<TValue> dataSource = null)

Parameters

Type	Name	Description
System.Boolean	updateSortedData	specifies the update sorted data.
System.Collections.Generic.IEnumerable<TValue>	dataSource	specifies the data source.