Table of Contents

Class TransferPanel

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

TransferPanelBase 穿梭框面板组件

public class TransferPanel : BootstrapComponentBase, IComponent, IHandleAfterRender, IHandleEvent
Inheritance
TransferPanel
Implements
Inherited Members
Extension Methods

Constructors

TransferPanel()

public TransferPanel()

Properties

HeaderTemplate

获得/设置 Header 模板

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

Property Value

RenderFragment<List<SelectedItem>>

IsDisabled

获得/设置 是否禁用 默认为 false

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

Property Value

bool

ItemTemplate

获得/设置 Item 模板

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

Property Value

RenderFragment<SelectedItem>

Items

获得/设置 数据集合

[Parameter]
[EditorRequired]
public List<SelectedItem>? Items { get; set; }

Property Value

List<SelectedItem>

OnSelectedItemsChanged

获得/设置 选项状态变化时回调方法

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

Property Value

Func<Task>

OnSetItemClass

获得/设置 数据样式回调方法 默认为 null

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

Property Value

Func<SelectedItem, string>

SearchIcon

获得/设置 搜索框图标

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

Property Value

string

SearchPlaceHolderString

获得/设置 搜索框的 placeholder 字符串

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

Property Value

string

SearchText

获得/设置 搜索关键字

protected string? SearchText { get; set; }

Property Value

string

ShowSearch

获得/设置 是否显示搜索框

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

Property Value

bool

Text

获得/设置 面板显示文字

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

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClearSearch()

清空搜索条件方法

protected void ClearSearch()

HeaderCheckState()

头部复选框初始化值方法

protected CheckboxState HeaderCheckState()

Returns

CheckboxState

OnHeaderCheck(CheckboxState, SelectedItem)

左侧头部复选框初始化值方法

protected Task OnHeaderCheck(CheckboxState state, SelectedItem item)

Parameters

state CheckboxState
item SelectedItem

Returns

Task

OnKeyUp(KeyboardEventArgs)

搜索文本框按键回调方法

protected void OnKeyUp(KeyboardEventArgs e)

Parameters

e KeyboardEventArgs

OnParametersSet()

OnParametersSet 方法

protected override void OnParametersSet()

OnSearch(ChangeEventArgs)

搜索框文本改变时回调此方法

protected virtual void OnSearch(ChangeEventArgs e)

Parameters

e ChangeEventArgs

OnStateChanged(CheckboxState, SelectedItem)

protected Task OnStateChanged(CheckboxState state, SelectedItem item)

Parameters

state CheckboxState
item SelectedItem

Returns

Task