Class SfListBox<TValue, TItem>

ListBox component used to display a list of items. Users can select one or more items in the list using a checkbox or by keyboard selection. It supports sorting, grouping, reordering and drag and drop of items.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfDropDownBase<TItem>

SfListBox<TValue, TItem>

Inherited Members

SfDropDownBase<TItem>.Render(IEnumerable<TItem>, FieldSettingsModel, Query)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.SetListData(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.DropDowns.FieldSettingsModel, Syncfusion.Blazor.Data.Query)

SfDropDownBase<TItem>.SetFields()

SfDropDownBase<TItem>.SimpleDataExecute(IEnumerable<TItem>, Query)

SfDropDownBase<TItem>.CloneQuery(Query)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetDataByText(System.String, System.String)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IncrementalSearch(System.String, System.Collections.Generic.IEnumerable<TItem>, System.Nullable<System.Int32>, System.Boolean)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.Search(System.String, System.Collections.Generic.IEnumerable<TItem>, System.String, System.Boolean)

SfDropDownBase<TItem>.SetItemValue(String, Type)

SfDropDownBase<TItem>.IsSimpleDataType()

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.AddItems(System.Collections.Generic.IEnumerable<TItem>, System.Nullable<System.Int32>)

SfDropDownBase<TItem>.AddItemsAsync(IEnumerable<TItem>, Nullable<Int32>)

SfDropDownBase<TItem>.InsertItem(IEnumerable<TItem>, Nullable<Int32>, Boolean)

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.RenderItems()

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.HighlightSearch(System.String, System.String, System.Boolean, Syncfusion.Blazor.DropDowns.FilterType)

SfDropDownBase<TItem>.ListItemCreated(ListOptions<TItem>)

SfDropDownBase<TItem>.EnablePersistence

SfDropDownBase<TItem>.ItemTemplate

SfDropDownBase<TItem>.GroupTemplate

SfDropDownBase<TItem>.NoRecordsTemplate

SfDropDownBase<TItem>.ActionFailureTemplate

SfDropDownBase<TItem>.SortOrder

SfDropDownBase<TItem>.Enabled

SfDropDownBase<TItem>.DataSource

SfDropDownBase<TItem>.Query

SfDropDownBase<TItem>.FilterType

SfDropDownBase<TItem>.IgnoreCase

SfDropDownBase<TItem>.IgnoreAccent

SfDropDownBase<TItem>.ZIndex

SfDropDownBase<TItem>.DropDownsEditContext

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ListData

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.MainData

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ListDataSource

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ItemData

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IsActionFaiure

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.TotalCount

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.DropDowns

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfListBox<TValue, TItem> : SfDropDownBase<TItem>, IListBox

Type Parameters

Name	Description
TValue
TItem

Constructors

SfListBox()

Declaration

public SfListBox()

Properties

AllowDragAndDrop

If 'allowDragAndDrop' is set to true, then you can perform drag and drop of the list item. ListBox contains same 'scope' property enables drag and drop between multiple ListBox.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean

AllowFiltering

To enable the filtering option in this component. Filter action performs when type in search box and collect the matched item through Filtering event. If searching character does not match, noRecordsTemplate property value will be shown.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean

ComponentName

Declaration

protected override string ComponentName { get; set; }

Property Value

Type	Description
System.String

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ComponentName

CssClass

Sets the CSS classes to root element of this component, which helps to customize the complete styles.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

FilterBarPlaceholder

Accepts the value to be displayed as a watermark text on the filter bar.

Declaration

public string FilterBarPlaceholder { get; set; }

Property Value

Type	Description
System.String

Height

Sets the height of the ListBox component.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HtmlAttributes

You can add the additional HTML attributes such as id, title etc., to the listbox element.

Declaration

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

Property Value

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

MaximumSelectionLength

Sets limitation to the value selection. based on the limitation, list selection will be prevented.

Declaration

public double MaximumSelectionLength { get; set; }

Property Value

Type	Description
System.Double

Scope

Defines the connected ListBox reference to group sets of draggable and droppable ListBox. A draggable ListBox with the scope reference will be accepted by the droppable.

Declaration

public string Scope { get; set; }

Property Value

Type	Description
System.String

Value

Sets the specified item to the selected state or gets the selected item in the ListBox.

Declaration

public TValue Value { get; set; }

Property Value

Type	Description
TValue

ValueChanged

Specifies the callback to trigger when the value changes.

Declaration

public EventCallback<TValue> ValueChanged { get; set; }

Property Value

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

ValueExpression

Specifies the expression for defining the value of the bound.

Declaration

public Expression<Func<TValue>> ValueExpression { get; set; }

Property Value

Type	Description
System.Linq.Expressions.Expression<System.Func<TValue>>

Methods

ActionBegin(IEnumerable<TItem>, Query)

Declaration

protected override Task<ActionBeginEventArgs> ActionBegin(IEnumerable<TItem> dataSource, Query query = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	dataSource
Query	query

Returns

Type	Description
System.Threading.Tasks.Task<ActionBeginEventArgs>

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ActionBegin(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)

ActionComplete(IEnumerable<TItem>, Query)

Declaration

protected override Task ActionComplete(IEnumerable<TItem> dataSource, Query query = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	dataSource
Query	query

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ActionComplete(System.Collections.Generic.IEnumerable<TItem>, Syncfusion.Blazor.Data.Query)

ActionFailure(Object)

Declaration

protected override Task ActionFailure(object args)

Parameters

Type	Name	Description
System.Object	args

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.ActionFailure(System.Object)

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

EnableItems<T>(T, Boolean)

This method is used to enable or disable the items in the ListBox based on the items and enable argument.

Declaration

public void EnableItems<T>(T items, bool enable = true)

Parameters

Type	Name	Description
T	items	Specifies the list items to be enabled or disabled. You can pass either value(TValue) or data source(TItem) collection.
System.Boolean	enable	Set false to disable the items. By default the items will be enabled.

Type Parameters

Name	Description
T

GetDataByValue(TValue)

Gets the array of data Object that matches the given array of values.

Declaration

public List<TItem> GetDataByValue(TValue dataValue)

Parameters

Type	Name	Description
TValue	dataValue	Specifies the value(s).

Returns

Type	Description
System.Collections.Generic.List<TItem>

GetDataList()

Returns the updated dataSource in ListBox.

Declaration

public IEnumerable<TItem> GetDataList()

Returns

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

GetPersistData()

Declaration

protected Task<string> GetPersistData()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetQuery(Query)

Declaration

protected override Query GetQuery(Query query)

Parameters

Type	Name	Description
Query	query

Returns

Type	Description
Query

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.GetQuery(Syncfusion.Blazor.Data.Query)

IsFilter()

Declaration

protected override bool IsFilter()

Returns

Type	Description
System.Boolean

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.IsFilter()

MoveAllAsync(String, Nullable<Double>)

Moves all the values from one ListBox to the scoped ListBox.

Declaration

public Task MoveAllAsync(string scope = null, Nullable<double> index = null)

Parameters

Type	Name	Description
System.String	scope	Specifies the destination ListBox reference.
System.Nullable<System.Double>	index	Specifies the index to place the moved items.

Returns

Type	Description
System.Threading.Tasks.Task

MoveAsync(TValue, Nullable<Double>, String)

Moves the given value(s) / selected value(s) to the given / default scoped ListBox.

Declaration

public Task MoveAsync(TValue values = null, Nullable<double> index = null, string scope = null)

Parameters

Type	Name	Description
TValue	values	Specifies the value(s).
System.Nullable<System.Double>	index	Specifies the index to place the moved items.
System.String	scope	Specifies the destination ListBox reference.

Returns

Type	Description
System.Threading.Tasks.Task

MoveDownAsync(TValue)

Moves the given value(s) / selected value(s) downwards.

Declaration

public Task MoveDownAsync(TValue values = null)

Parameters

Type	Name	Description
TValue	values	Specifies the value(s).

Returns

Type	Description
System.Threading.Tasks.Task

MoveUpAsync(TValue)

Moves the given value(s) / selected value(s) upwards.

Declaration

public Task MoveUpAsync(TValue values = null)

Parameters

Type	Name	Description
TValue	values	Specifies the value(s).

Returns

Type	Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.DropDowns.SfDropDownBase<TItem>.OnParametersSetAsync()

RemoveItemAsync(IEnumerable<TItem>, Nullable<Int32>)

Removes a item or collection of items from the list. By default, removed the last item in the list, but you can remove based on the index parameter.

Declaration

public Task RemoveItemAsync(IEnumerable<TItem> items = null, Nullable<int> itemIndex = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	items	Specifies the list of data collection to be removed.
System.Nullable<System.Int32>	itemIndex	Specifies the index to remove the item from the list.

Returns

Type	Description
System.Threading.Tasks.Task

SelectAllAsync(Boolean)

Based on the state parameter, entire list item will be selected/deselected.

Declaration

public Task SelectAllAsync(bool state = true)

Parameters

Type	Name	Description
System.Boolean	state	Set true/false to select/ unselect the entire list items.

Returns

Type	Description
System.Threading.Tasks.Task

SelectItemsAsync<T>(T, Boolean)

Based on the state parameter, specified list item will be selected/deselected.

Declaration

public Task SelectItemsAsync<T>(T items, bool state = true)

Parameters

Type	Name	Description
T	items	Specifies the list items to be selected or unselected. You can pass either value(TValue) or data source(TItem) collection.
System.Boolean	state	Set false to un select the items. By default the items will be selected.

Returns

Type	Description
System.Threading.Tasks.Task

Type Parameters

Name	Description
T

SetLocalStorage(String, List<String>)

Declaration

protected Task SetLocalStorage(string persistId, List<string> values)

Parameters

Type	Name	Description
System.String	persistId
System.Collections.Generic.List<System.String>	values

Returns

Type	Description
System.Threading.Tasks.Task