Class SfDropDownList<TValue, TItem>

The DropDownList component contains a list of predefined values from which a single value can be chosen.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfDropDownBase<TItem>

SfDropDownList<TValue, TItem>

SfComboBox<TValue, TItem>

Inherited Members

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

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

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

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

SfDropDownBase<TItem>.ActionFailure(Object)

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

SfDropDownBase<TItem>.SetFields()

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

SfDropDownBase<TItem>.CloneQuery(Query)

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

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

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)

SfDropDownBase<TItem>.IsFilter()

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>.DuplicateQuery

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>.DataId

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

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

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

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

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

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 SfDropDownList<TValue, TItem> : SfDropDownBase<TItem>, IInputBase, IDropDowns

Type Parameters

Name	Description
TValue	Specifies the value type.
TItem	Specifies the type of SfDropDownList.

Constructors

SfDropDownList()

Declaration

public SfDropDownList()

Fields

ARIA_HAS_POPUP

specifies the aria-has-popup class.

Declaration

protected const string ARIA_HAS_POPUP = "aria-haspopup"

Field Value

Type	Description
System.String

ASSERTIVE

specifies the assertive string.

Declaration

protected const string ASSERTIVE = "assertive"

Field Value

Type	Description
System.String

FALSE

Specifies the string false.

Declaration

protected const string FALSE = "false"

Field Value

Type	Description
System.String

NO_DATA

Specifies the root class of base component.

Declaration

protected const string NO_DATA = "e-content e-dropdownbase e-nodata"

Field Value

Type	Description
System.String

TRUE

Specifies the string true.

Declaration

protected const string TRUE = "true"

Field Value

Type	Description
System.String

Properties

AllowFiltering

When AllowFiltering is set to true, show the filter bar (search box) of the component.

The filter action retrieves matched items through the `Filtering` event based on the characters typed in the search TextBox.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean

CssClass

Specifies the CSS class name that can be appended with the root element of the DropDownList. One or more custom CSS classes can be added to a DropDownList.

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

EnableVirtualization

The Virtual Scrolling feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDowns, that is, when scrolling, the datamanager request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDowns, set the EnableVirtualization to true.

Declaration

public bool EnableVirtualization { 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

FloatLabelType

Specifies the floating label behavior of the DropDownList that the placeholder text floats above the DropDownList based on the following values.

Possible values are:

• NeverNever floats the label in the DropDownList when the placeholder is available.
• AlwaysThe floating label always floats above the DropDownList.
• AutoThe floating label floats above the DropDownList after focusing it or when enters the value in it.

Declaration

public FloatLabelType FloatLabelType { get; set; }

Property Value

Type	Description
FloatLabelType

FooterTemplate

Accepts the template design and assigns it to the footer container of the popup list.

Declaration

public RenderFragment FooterTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

HeaderTemplate

Accepts the template design and assigns it to the header container of the popup list.

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

HtmlAttributes

You can add the additional html attributes such as styles, class, and more to the root element. If you configured both property and equivalent html attributes, then the component considers the property value.

Declaration

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

Property Value

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

ID

Specifies the id of the DropDownList component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Index

Gets or sets the index of the selected item in the component.

Declaration

public Nullable<int> Index { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

IndexChanged

Specifies the callback to trigger when the index changes.

Declaration

public EventCallback<Nullable<int>> IndexChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Nullable<System.Int32>>

InputAttributes

You can add the additional input attributes such as disabled, value, and more to the root element.

If you configured both the property and equivalent input attribute, then the component considers the property value.

Declaration

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

Property Value

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

ItemsCount

The data can be fetched in popup based on ItemsCount, when enabled the EnableVirtualization.

Declaration

public int ItemsCount { get; set; }

Property Value

Type	Description
System.Int32

Placeholder

Specifies the text that is shown as a hint or placeholder until the user focuses or enter a value in DropDownList. The property is depending on the FloatLabelType property.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String

PopupHeight

Specifies the height of the popup list.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String

PopupWidth

Specifies the width of the popup list. By default, the popup width sets based on the width of the component.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String

Readonly

Specifies the boolean value whether the DropDownList allows the user to change the value.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean

ShowClearButton

Specifies whether to show or hide the clear button.

When the clear button is clicked, `Value`, `Text`, and `Index` properties are reset to null.

Declaration

public virtual bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean

TabIndex

Specifies the tab order of the DropDownList component.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32

Value

Gets or sets the value of the selected item in the component.

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>>

ValueTemplate

Accepts the template design and assigns it to the selected list item in the input element of the component.

Declaration

public RenderFragment<TItem> ValueTemplate { get; set; }

Property Value

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

Width

Specifies the width of the component. By default, the component width sets based on the width of its parent container.

You can also set the width in pixel values.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

ClearAll(EventArgs)

Task which used to clear all the items.

Declaration

protected virtual Task ClearAll(EventArgs args = null)

Parameters

Type	Name	Description
System.EventArgs	args	Specifies the EventArgs arguments.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ClearAsync()

Allows you to clear the selected values from the component.

Declaration

public Task ClearAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

DropDownClick()

Triggers while clicking the dropdown icon.

Declaration

protected Task DropDownClick()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FilterAsync(IEnumerable<TItem>, Query, FieldSettingsModel)

To filter the data from given data source by using query.

Declaration

public Task FilterAsync(IEnumerable<TItem> dataSource, Query query = null, FieldSettingsModel fields = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	dataSource	Specifies the data source.
Query	query	Specifies the query.
FieldSettingsModel	fields	Specifies the fields.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FilteringAction(IEnumerable<TItem>, Query, FieldSettingsModel)

Task which specifies the filtering action.

Declaration

protected Task FilteringAction(IEnumerable<TItem> dataSource, Query query, FieldSettingsModel fields)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TItem>	dataSource	Specifies the data source.
Query	query	Specifies the query.
FieldSettingsModel	fields	Specifies the fields.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FocusAsync()

Sets the focus to the DropDownList component for interaction.

Declaration

public Task FocusAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FocusOutAsync()

Remove the focus from the DropDownList component, if the component is in focus state.

Declaration

public Task FocusOutAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

FocusOutHandler(FocusEventArgs, Boolean)

Triggers when the component get focused out.

Declaration

protected Task FocusOutHandler(FocusEventArgs args, bool isFilterinput = false)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Web.FocusEventArgs	args	Specifies the FocusEventArgs arguments.
System.Boolean	isFilterinput	Specifies whether it is a filter input or not.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

GetDataByValue(TValue)

Gets the data Object that matches the given value.

Declaration

public TItem GetDataByValue(TValue ddlValue)

Parameters

Type	Name	Description
TValue	ddlValue	Specifies the DropDownList value.

Returns

Type	Description
TItem	Task.

GetItemsAsync()

Gets all the list items bound on this component.

Declaration

public Task<IEnumerable<TItem>> GetItemsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<TItem>>	Task.

HidePopupAsync()

Hides the DropDownList popup.

Declaration

public Task HidePopupAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

HideSpinnerAsync()

Hides the spinner loader.

Declaration

public Task HideSpinnerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

OnFilterUp(KeyboardEventArgs)

Specifies the keyup event of filter event.

Declaration

protected Task OnFilterUp(KeyboardEventArgs args)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Web.KeyboardEventArgs	args	Specifies the KeyboardEventArgs arguments.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

RefreshDataAsync()

Refreshes the popup list items. The method is useful if the popup list item changed externally.

Declaration

public Task RefreshDataAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SearchList(KeyboardEventArgs)

Task which specifies the search list.

Declaration

protected virtual Task SearchList(KeyboardEventArgs args = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Web.KeyboardEventArgs	args	Specifies the KeyboardEventArgs arguments.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ShowPopupAsync()

Opens the popup that displays the list of items.

Declaration

public Task ShowPopupAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

ShowSpinnerAsync()

Shows the spinner loader.

Declaration

public Task ShowSpinnerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	Task.

UpdateMainData()

Task which update main data.

Declaration

protected virtual void UpdateMainData()

UpdateValue()

Task which updates the value.

Declaration

protected virtual Task UpdateValue()

Returns

Type	Description
System.Threading.Tasks.Task	Task.