Table of Contents

Class ListView<TItem>

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

ListView 组件基类

public class ListView<TItem> : BootstrapComponentBase, IComponent, IHandleAfterRender, IHandleEvent

Type Parameters

TItem
Inheritance
ListView<TItem>
Implements
Inherited Members
Extension Methods

Constructors

ListView()

public ListView()

Properties

BodyTemplate

获得/设置 BodyTemplate

[Parameter]
[EditorRequired]
public RenderFragment<TItem>? BodyTemplate { get; set; }

Property Value

RenderFragment<TItem>

CollapsedGroupCallback

获得/设置 首次渲染是否收缩回调委托

[Parameter]
public Func<object?, bool>? CollapsedGroupCallback { get; set; }

Property Value

Func<object, bool>

Collapsible

获得/设置 是否可折叠 默认 false 需要开启分组设置 GroupName

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

Property Value

bool

FooterTemplate

获得/设置 FooterTemplate 默认 null 未设置 设置值后 Pageable 参数不起作用,请自行实现分页功能

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

Property Value

RenderFragment

GroupHeaderTextCallback

获得/设置 获得 Text 值 默认 null 使用分组 Key.ToString() 方法获取

[Parameter]
public Func<object?, string?>? GroupHeaderTextCallback { get; set; }

Property Value

Func<object, string>

GroupItemOrderCallback

获得/设置 组内项目排序回调方法 默认 null

[Parameter]
public Func<IGrouping<object?, TItem>, IOrderedEnumerable<TItem>>? GroupItemOrderCallback { get; set; }

Property Value

Func<IGrouping<object, TItem>, IOrderedEnumerable<TItem>>

GroupName

获得/设置 分组 Lambda 表达式 默认 null

[Parameter]
public Func<TItem, object?>? GroupName { get; set; }

Property Value

Func<TItem, object>

GroupOrderCallback

获得/设置 组排序回调方法 默认 null 使用内置

[Parameter]
public Func<IEnumerable<IGrouping<object?, TItem>>, IOrderedEnumerable<IGrouping<object?, TItem>>>? GroupOrderCallback { get; set; }

Property Value

Func<IEnumerable<IGrouping<object, TItem>>, IOrderedEnumerable<IGrouping<object, TItem>>>

HeaderTemplate

获得/设置 CardHeard

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

Property Value

RenderFragment

IsAccordion

获得/设置 是否手风琴效果 默认 false 需要开启可收缩设置 Collapsible

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

Property Value

bool

IsVertical

获得/设置 是否为竖向排列 默认为 false

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

Property Value

bool

Items

获得/设置 数据源

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

Property Value

IEnumerable<TItem>

OnCollapseChanged

获得/设置 CollapseItem 展开收缩时回调方法 默认 false 需要开启可收缩设置 Collapsible

[Parameter]
public Func<CollapseItem, Task>? OnCollapseChanged { get; set; }

Property Value

Func<CollapseItem, Task>

OnListViewItemClick

获得/设置 ListView组件元素点击时回调委托

[Parameter]
public Func<TItem, Task>? OnListViewItemClick { get; set; }

Property Value

Func<TItem, Task>

OnQueryAsync

异步查询回调方法

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

Property Value

Func<QueryPageOptions, Task<QueryData<TItem>>>

PageItems

获得/设置 每页数据数量 默认 20

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

Property Value

int

Pageable

获得/设置 是否分页 默认为 false 不分页 设置 FooterTemplate 时分页功能自动被禁用

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

Property Value

bool

Rows

数据集合内部使用

protected IEnumerable<TItem> Rows { get; }

Property Value

IEnumerable<TItem>

TotalCount

获得/设置 数据总条目

protected int TotalCount { get; set; }

Property Value

int

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnClick(TItem)

点击元素事件

protected Task OnClick(TItem item)

Parameters

item TItem

Returns

Task

OnPageLinkClick(int)

点击页码调用此方法

protected Task OnPageLinkClick(int pageIndex)

Parameters

pageIndex int

Returns

Task

OnParametersSetAsync()

protected override Task OnParametersSetAsync()

Returns

Task

QueryAsync(int)

查询按钮调用此方法

public Task QueryAsync(int pageIndex = 1)

Parameters

pageIndex int

Returns

Task

QueryData()

调用 OnQuery 回调方法获得数据源

protected Task QueryData()

Returns

Task