DropDownBase<T> Class

DropDownBase<T>link

Base class of components that display a list of items.

Declaration

public DropDownBase<T>()

PreserveCollectionOnSelectionlink

Will add/remove selected items from a bound ICollection<T>, instead of replacing it.

Declaration

protected bool PreserveCollectionOnSelection

isPopupOpenlink

Gets a value indicating whether the popup is open.

Declaration

protected bool isPopupOpen

listlink

The list

Declaration

protected ElementReference? list

searchlink

The search

Declaration

protected ElementReference search

selectedIndexlink

The selected index

Declaration

protected int selectedIndex

selectedItemlink

The selected item

Declaration

protected object selectedItem

selectedItemslink

The selected items

Declaration

protected ISet<object> selectedItems

AllowClearlink

Gets or sets a value indicating whether the user can clear the value. Set to false by default.

Declaration

public bool AllowClear { get; set; }

Property Value

AllowFilteringlink

Gets or sets a value indicating whether filtering is allowed. Set to false by default.

Declaration

public bool AllowFiltering { get; set; }

Property Value

AllowSelectAlllink

Gets or sets a value indicating whether the user can select all values in multiple selection. Set to true by default.

Declaration

public bool AllowSelectAll { get; set; }

Property Value

AllowVirtualizationlink

Specifies wether virtualization is enabled. Set to false by default.

Declaration

public bool AllowVirtualization { get; set; }

Property Value

ClearAriaLabellink

Gets or sets the clear button aria label text.

Declaration

public string ClearAriaLabel { get; set; }

Property Value

Countlink

Specifies the total number of items in the data source.

Declaration

public int Count { get; set; }

Property Value

Datalink

Gets or sets the data.

Declaration

public Collections.IEnumerable Data { get; set; }

Property Value

DisabledPropertylink

Gets or sets the disabled property.

Declaration

public string DisabledProperty { get; set; }

Property Value

EmptyAriaLabellink

Gets or sets the empty value aria label text.

Declaration

public string EmptyAriaLabel { get; set; }

Property Value

FilterAsYouTypelink

Gets or sets a value indicating whether filtering is allowed as you type. Set to true by default.

Declaration

public bool FilterAsYouType { get; set; }

Property Value

FilterDelaylink

Gets or sets the filter delay.

Declaration

public int FilterDelay { get; set; }

Property Value

HasValuelink

Declaration

public bool HasValue { get; }

Property Value

HeaderTemplatelink

Gets or sets the header template.

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

ItemComparerlink

For lists of objects, an IEqualityComparer to control how selected items are determined

Declaration

public IEqualityComparer<object> ItemComparer { get; set; }

Property Value

Itemslink

Gets the items.

Declaration

protected IEnumerable<object> Items { get; }

Property Value

ListIdlink

Gets the listbox identifier.

Declaration

protected string ListId { get; }

Property Value

Multiplelink

Gets or sets a value indicating whether this DropDownBase<T> is multiple.

Declaration

public bool Multiple { get; set; }

Property Value

PageSizelink

Specifies the default page size. Set to 5 by default.

Declaration

public int PageSize { get; set; }

Property Value

PopupIDlink

Gets the popup identifier.

Declaration

protected string PopupID { get; }

Property Value

RemoveChipTitlelink

Gets or sets the remove chip button title.

Declaration

public string RemoveChipTitle { get; set; }

Property Value

ResetSelectedIndexOnFilterlink

Gets or sets a value indicating the selected index should reset to the top item when filtering, resulting in a down arrow action will start moving from the top.

Declaration

public bool ResetSelectedIndexOnFilter { get; set; }

Property Value

SearchAriaLabellink

Gets or sets the search aria label text.

Declaration

public string SearchAriaLabel { get; set; }

Property Value

SearchIDlink

Gets the search identifier.

Declaration

public string SearchID { get; }

Property Value

SelectedItemlink

Gets or sets the selected item.

Declaration

public object SelectedItem { get; set; }

Property Value

SelectedItemChangedlink

Gets or sets the selected item changed.

Declaration

public EventCallback<object> SelectedItemChanged { get; set; }

Property Value

Separatorlink

Gets or sets the item separator for Multiple dropdown.

Declaration

public string Separator { get; set; }

Property Value

Templatelink

Gets or sets the template.

Declaration

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

Property Value

ValuePropertylink

Gets or sets the value property.

Declaration

public string ValueProperty { get; set; }

Property Value

Viewlink

Gets the view.

Declaration

protected Collections.IEnumerable View { get; }

Property Value

VirtualizationOverscanCountlink

Gets or sets a value that determines how many additional items will be rendered before and after the visible region. This help to reduce the frequency of rendering during scrolling. However, higher values mean that more elements will be present in the page.

Declaration

public int VirtualizationOverscanCount { get; set; }

Property Value

Virtualizelink

The Virtualize instance.

Declaration

public Virtualization.Virtualize<object> Virtualize { get; }

Property Value

ClearAlllink

Clears all.

Declaration

protected Task ClearAll()

Returns

Disposelink

Declaration

public override void Dispose()

GetItemOrValueFromPropertylink

Gets the item or value from property.

Declaration

public virtual object GetItemOrValueFromProperty(object item, string property)

Parameters

Returns

GetValuelink

Declaration

public override object GetValue()

Returns

HandleKeyPresslink

Handles the key press.

Declaration

protected virtual Task HandleKeyPress(KeyboardEventArgs args, bool isFilter, bool? shouldSelectOnChange)

Parameters

Returns

OnAfterRenderAsynclink

Called when [after render asynchronous].

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Returns

OnChangelink

Handles the Change event.

Declaration

protected void OnChange(ChangeEventArgs args)

Parameters

OnDataChangedlink

Declaration

protected override Task OnDataChanged()

Returns

OnFilterlink

Handles the FilterKeyPress event.

Declaration

protected virtual Task OnFilter(ChangeEventArgs args)

Parameters

Returns

OnFilterInputlink

Handles filter input changes (e.g. paste).

Declaration

protected virtual Task OnFilterInput(ChangeEventArgs args)

Parameters

Returns

OnFilterKeyPresslink

Handles the FilterKeyPress event.

Declaration

protected virtual Task OnFilterKeyPress(KeyboardEventArgs args)

Parameters

Returns

OnInitializedlink

Declaration

protected override void OnInitialized()

OnKeyPresslink

Handles the KeyPress event.

Declaration

protected virtual Task OnKeyPress(KeyboardEventArgs args, bool? shouldSelectOnChange)

Parameters

Returns

OnParametersSetlink

Declaration

protected override void OnParametersSet()

OnParametersSetAsynclink

Called when [parameters set asynchronous].

Declaration

protected override Task OnParametersSetAsync()

Returns

OnSelectAllKeyDownlink

Handles keyboard activation for the select-all action.

Declaration

protected Task OnSelectAllKeyDown(KeyboardEventArgs args)

Parameters

Returns

OnSelectItemlink

Called when [select item].

Declaration

protected virtual Task OnSelectItem(object item, bool isFromKey)

Parameters

Returns

OpenPopuplink

Opens the popup script.

Declaration

protected virtual Task OpenPopup(string key, bool isFilter, bool isFromClick)

Parameters

Returns

OpenPopupScriptlink

Opens the popup script.

Declaration

protected string OpenPopupScript()

Returns

OpenPopupScriptFromParentlink

Opens the popup script from parent.

Declaration

protected string OpenPopupScriptFromParent()

Returns

Resetlink

Resets this instance.

Declaration

public void Reset()

SelectAlllink

Selects all.

Declaration

protected virtual Task SelectAll()

Returns

SelectItemlink

Selects the item internal.

Declaration

public Task SelectItem(object item, bool raiseChange)

Parameters

Returns

SelectItemFromValuelink

Selects the item from value.

Declaration

protected virtual void SelectItemFromValue(object value)

Parameters

SetParametersAsynclink

Set parameters as an asynchronous operation.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns