Table of Contents

Class Transfer<TValue>

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

穿梭框组件

public class Transfer<TValue> : ValidateBase<TValue>, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable, IValidateComponent

Type Parameters

TValue
Inheritance
DisplayBase<TValue>
ValidateBase<TValue>
Transfer<TValue>
Implements
Inherited Members
Extension Methods

Constructors

Transfer() 

public Transfer()

Properties

Items

获得/设置 组件绑定数据项集合

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

Property Value

IEnumerable<SelectedItem>

LeftButtonText

获得/设置 左侧按钮显示文本

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

Property Value

string

LeftHeaderTemplate

获得/设置 左侧 Panel Header 模板

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

Property Value

RenderFragment<List<SelectedItem>>

LeftIcon

获得/设置 向左侧转移图标

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

Property Value

string

LeftItemTemplate

获得/设置 左侧 Panel Item 模板

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

Property Value

RenderFragment<SelectedItem>

LeftPanelSearchPlaceHolderString

获得/设置 左侧面板搜索框 placeholder 文字

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

Property Value

string

LeftPanelText

获得/设置 左侧面板 Header 显示文本

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

Property Value

string

LeftPannelSearchPlaceHolderString

获得/设置 左侧面板搜索框 placeholder 文字

[Parameter]
[Obsolete("已过期，请使用 LeftPanelSearchPlaceHolderString 代替 Please use LeftPanelSearchPlaceHolderString")]
public string? LeftPannelSearchPlaceHolderString { get; set; }

Property Value

string

LocalizerFactory

获得/设置 IStringLocalizerFactory 注入服务实例 默认为 null

[Inject]
public IStringLocalizerFactory? LocalizerFactory { get; set; }

Property Value

IStringLocalizerFactory

Max

获得/设置 右侧面板包含的最大数量, 默认为 0 不限制

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

Property Value

int

MaxErrorMessage

获得/设置 设置最大值时错误消息文字

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

Property Value

string

Min

获得/设置 右侧面板包含的最大数量，默认为 0 不限制

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

Property Value

int

MinErrorMessage

获得/设置 设置最小值时错误消息文字

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

Property Value

string

OnSelectedItemsChanged

获得/设置 选中项集合发生改变时回调委托方法

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

Property Value

Func<IEnumerable<SelectedItem>, Task>

OnSetItemClass

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

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

Property Value

Func<SelectedItem, string>

RightButtonText

获得/设置 右侧按钮显示文本

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

Property Value

string

RightHeaderTemplate

获得/设置 右侧 Panel Header 模板

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

Property Value

RenderFragment<List<SelectedItem>>

RightIcon

获得/设置 向右侧转移图标

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

Property Value

string

RightItemTemplate

获得/设置 右侧 Panel Item 模板

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

Property Value

RenderFragment<SelectedItem>

RightPanelSearchPlaceHolderString

获得/设置 右侧面板搜索框 placeholder 文字

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

Property Value

string

RightPanelText

获得/设置 右侧面板 Header 显示文本

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

Property Value

string

RightPannelSearchPlaceHolderString

获得/设置 右侧面板搜索框 placeholder 文字

[Parameter]
[Obsolete("已过期，请使用 RightPanelSearchPlaceHolderString 代替 Please use RightPanelSearchPlaceHolderString")]
public string? RightPannelSearchPlaceHolderString { get; set; }

Property Value

string

ShowSearch

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

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

Property Value

bool

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

FormatValueAsString(TValue)

FormatValueAsString 方法

protected override string? FormatValueAsString(TValue value)

Parameters

value TValue

Returns

string

OnInitialized()

OnInitialized 方法

protected override void OnInitialized()

OnParametersSet()

OnParametersSet 方法

protected override void OnParametersSet()

TryParseValueFromString(string, out TValue, out string?) 

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

Parameters

value string
result TValue
validationErrorMessage string

Returns

bool