Table of Contents

Class Select<TValue>

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

Select 组件实现类

public class Select<TValue> : SingleSelectBase<TValue>, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable, IValidateComponent, ISelect

Type Parameters

TValue
Inheritance
DisplayBase<TValue>
ValidateBase<TValue>
SelectBase<TValue>
Select<TValue>
Implements
Inherited Members
Extension Methods

Constructors

Select() 

public Select()

Properties

ClearIcon

获得/设置 右侧清除图标 默认 fa-solid fa-angle-up

[Parameter]
public string? ClearIcon { get; set; }

Property Value

string

DefaultVirtualizeItemText

获得/设置 默认文本 IsVirtualize 时生效 默认 null

[Parameter]
public string? DefaultVirtualizeItemText { get; set; }

Property Value

string

Remarks

开启 IsVirtualize 并且通过 OnQueryAsync 提供数据源时，由于渲染时还未调用或者调用后数据集未包含 Value 选项值，此时使用 DefaultText 值渲染

DisableItemChangedWhenFirstRender

获得/设置 禁止首次加载时触发 OnSelectedItemChanged 回调方法 默认 false

[Parameter]
public bool DisableItemChangedWhenFirstRender { get; set; }

Property Value

bool

DisplayTemplate

获得/设置 显示部分模板 默认 null

[Parameter]
public RenderFragment<SelectedItem?>? DisplayTemplate { get; set; }

Property Value

RenderFragment<SelectedItem>

IsClearable

获得/设置 是否可清除 默认 false

[Parameter]
public bool IsClearable { get; set; }

Property Value

bool

IsEditable

获得/设置 是否可编辑 默认 false

[Parameter]
public bool IsEditable { get; set; }

Property Value

bool

IsFixedSearch

获得/设置 是否固定下拉框中的搜索栏 默认 false

[Parameter]
public bool IsFixedSearch { get; set; }

Property Value

bool

IsVirtualize

获得/设置 是否开启虚拟滚动 默认 false 未开启 注意：开启虚拟滚动后不支持 ShowSearchIsPopoverIsFixedSearch 参数设置，设置初始值时请设置 DefaultVirtualizeItemText

[Parameter]
public bool IsVirtualize { get; set; }

Property Value

bool

NoSearchDataText

获得/设置 无搜索结果时显示文字

[Parameter]
public string? NoSearchDataText { get; set; }

Property Value

string

OnClearAsync

获得/设置 清除文本内容 OnClear 回调方法 默认 null

[Parameter]
public Func<Task>? OnClearAsync { get; set; }

Property Value

Func<Task>

OnInputChangedCallback

获得/设置 选项输入更新后回调方法 默认 null

[Parameter]
public Func<string, Task>? OnInputChangedCallback { get; set; }

Property Value

Func<string, Task>

Remarks

设置 IsEditable 后生效

OnQueryAsync

虚拟滚动数据加载回调方法

[Parameter]
public Func<VirtualizeQueryOption, Task<QueryData<SelectedItem>>>? OnQueryAsync { get; set; }

Property Value

Func<VirtualizeQueryOption, Task<QueryData<SelectedItem>>>

OnSearchTextChanged

获得/设置 搜索文本发生变化时回调此方法

[Parameter]
public Func<string, IEnumerable<SelectedItem>>? OnSearchTextChanged { get; set; }

Property Value

Func<string, IEnumerable<SelectedItem>>

Options

获得/设置 选项模板支持静态数据

[Parameter]
public RenderFragment? Options { get; set; }

Property Value

RenderFragment

OverscanCount

获得/设置 过载阈值数 默认为 4

[Parameter]
public int OverscanCount { get; set; }

Property Value

int

Remarks

需要设置 IsVirtualize 值为 true 时生效

PlaceHolder

获得 PlaceHolder 属性

[Parameter]
public string? PlaceHolder { get; set; }

Property Value

string

RowHeight

获得/设置 虚拟滚动行高 默认为 33

[Parameter]
public float RowHeight { get; set; }

Property Value

float

Remarks

需要设置 IsVirtualize 值为 true 时生效

Methods

Add(SelectedItem)

添加静态下拉项方法

public void Add(SelectedItem item)

Parameters

item SelectedItem

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClearSearchText()

清空搜索栏文本内容

public void ClearSearchText()

ConfirmSelectedItem(int)

客户端回车回调方法

[JSInvokable]
public Task ConfirmSelectedItem(int index)

Parameters

index int

Returns

Task

InvokeInitAsync()

call JavaScript method

protected override Task InvokeInitAsync()

Returns

Task

OnParametersSet()

OnParametersSet 方法

protected override void OnParametersSet()

RetrieveId()

获得 input 组件 Id 方法

protected override string? RetrieveId()

Returns

string

TryParseValueFromString(string, out TValue, out string?)

Parses a string to create an instance of TValue. Derived classes can override this to change how CurrentValueAsString interprets incoming values.

protected override bool TryParseValueFromString(string value, out TValue result, out string? validationErrorMessage)

Parameters

value string
result TValue
validationErrorMessage string

Returns

bool