Table of Contents

Class TreeView<TItem>

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

Tree 组件

[CascadingTypeParameter("TItem")]
public class TreeView<TItem> : BootstrapModuleComponentBase, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable, IModelEqualityComparer<TItem>

Type Parameters

TItem
Inheritance
TreeView<TItem>
Implements
Inherited Members
Extension Methods

Constructors

TreeView() 

public TreeView()

Properties

AutoCheckChildren

改变节点状态后自动更新子节点 默认 false

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

Property Value

bool

AutoCheckParent

改变节点状态后自动更新父节点 默认 false

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

Property Value

bool

CanExpandWhenDisabled

获得/设置 当节点被禁用时 IsDisabled 是否可以进行折叠展开操作 默认 false

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

Property Value

bool

ClearSearchIcon

获得/设置 清除搜索栏图标 默认 未设置 使用主题内置图标

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

Property Value

string

ClickToggleCheck

获得/设置 是否点击节点自动切换 Checkbox 状态 默认 false ShowCheckbox 时生效

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

Property Value

bool

ClickToggleNode

获得/设置 是否点击节点时展开或者收缩子项 默认 false

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

Property Value

bool

CustomKeyAttribute 

[Parameter]
public Type CustomKeyAttribute { get; set; }

Property Value

Type

ExpandNodeIcon

获得/设置 Tree Node 展开节点图标

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

Property Value

string

IsAccordion

获得/设置 是否为手风琴效果 默认为 false

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

Property Value

bool

IsDisabled

获得/设置 是否禁用整个组件 默认 false

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

Property Value

bool

IsFixedSearch

获得/设置 是否固定搜索栏 默认 false 不固定

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

Property Value

bool

IsReset

获得/设置 页面刷新是否重置已加载数据 默认 false

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

Property Value

bool

Items

获得/设置 带层次数据集合

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

Property Value

List<TreeViewItem<TItem>>

ModelEqualityComparer

获得/设置 比较数据是否相同回调方法 默认为 null

[Parameter]
public Func<TItem, TItem, bool>? ModelEqualityComparer { get; set; }

Property Value

Func<TItem, TItem, bool>

Remarks

提供此回调方法时忽略 CustomKeyAttribute 属性

NodeIcon

获得/设置 Tree Node 节点图标

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

Property Value

string

OnExpandNodeAsync

获得/设置 点击节点获取子数据集合回调方法

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

Property Value

Func<TreeViewItem<TItem>, Task<IEnumerable<TreeViewItem<TItem>>>>

OnSearchAsync

获得/设置 搜索回调方法 默认 null 未设置

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

Property Value

Func<string, Task>

Remarks

通过设置 ShowSearch 开启

OnTreeItemChecked

获得/设置 树形控件节点选中时回调委托

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

Property Value

Func<List<TreeViewItem<TItem>>, Task>

OnTreeItemClick

获得/设置 树形控件节点点击时回调委托

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

Property Value

Func<TreeViewItem<TItem>, Task>

SearchIcon

获得/设置 搜索栏图标 默认 未设置 使用主题内置图标

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

Property Value

string

SearchTemplate

获得/设置 搜索栏模板 默认 null

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

Property Value

RenderFragment

ShowCheckbox

获得/设置 是否显示 CheckBox 默认 false 不显示

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

Property Value

bool

ShowIcon

获得/设置 是否显示 Icon 图标 默认 false 不显示

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

Property Value

bool

ShowResetSearchButton

获得/设置 是否显示重置搜索栏按钮 默认 true 显示

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

Property Value

bool

ShowSearch

获得/设置 是否显示搜索栏 默认 false 不显示

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

Property Value

bool

ShowSkeleton

获得/设置 是否显示加载骨架屏 默认 false 不显示

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

Property Value

bool

TreeNodeStateCache

节点状态缓存类实例

protected TreeNodeCache<TreeViewItem<TItem>, TItem>? TreeNodeStateCache { get; set; }

Property Value

TreeNodeCache<TreeViewItem<TItem>, TItem>

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClearCheckedItems()

清除 所有选中节点

public void ClearCheckedItems()

Equals(TItem?, TItem?)

比较数据是否相同

public bool Equals(TItem? x, TItem? y)

Parameters

x TItem
y TItem

Returns

bool

GetCheckedItems()

获得 所有选中节点集合

public IEnumerable<TreeViewItem<TItem>> GetCheckedItems()

Returns

IEnumerable<TreeViewItem<TItem>>

OnInitialized() 

protected override void OnInitialized()

OnParametersSet() 

protected override void OnParametersSet()

OnParametersSetAsync() 

protected override Task OnParametersSetAsync()

Returns

Task

SetActiveItem(TreeViewItem<TItem>)

设置选中节点

public void SetActiveItem(TreeViewItem<TItem> item)

Parameters

item TreeViewItem<TItem>

SetActiveItem(TItem)

设置选中节点

public void SetActiveItem(TItem item)

Parameters

item TItem