Class Table<TItem>

Namespace

BootstrapBlazor.Components

Assembly

BootstrapBlazor.dll

Table 组件基类

[CascadingTypeParameter("TItem")]
public class Table<TItem> : BootstrapModuleComponentBase, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable, ITable, IColumnCollection, IModelEqualityComparer<TItem> where TItem : class, new()

Type Parameters

TItem

Inheritance

object

ComponentBase

BootstrapComponentBase

IdComponentBase

BootstrapModuleComponentBase

Table<TItem>

Implements

IComponent

IHandleAfterRender

IHandleEvent

IAsyncDisposable

ITable

IColumnCollection

IModelEqualityComparer<TItem>

Inherited Members

BootstrapModuleComponentBase.OnLoadJSModule()

BootstrapModuleComponentBase.InvokeVoidAsync(string, params object[])

BootstrapModuleComponentBase.InvokeVoidAsync(string, TimeSpan, params object[])

BootstrapModuleComponentBase.InvokeVoidAsync(string, CancellationToken, params object[])

BootstrapModuleComponentBase.InvokeAsync<TValue>(string, params object[])

BootstrapModuleComponentBase.InvokeAsync<TValue>(string, TimeSpan, params object[])

BootstrapModuleComponentBase.InvokeAsync<TValue>(string, CancellationToken, params object[])

BootstrapModuleComponentBase.DisposeAsync()

BootstrapModuleComponentBase.Module

BootstrapModuleComponentBase.ModulePath

BootstrapModuleComponentBase.AutoInvokeInit

BootstrapModuleComponentBase.AutoInvokeDispose

BootstrapModuleComponentBase.Interop

IdComponentBase.RetrieveId()

IdComponentBase.Id

IdComponentBase.ComponentIdGenerator

BootstrapComponentBase.AdditionalAttributes

BootstrapComponentBase.ErrorLogger

BootstrapComponentBase.JSRuntime

BootstrapComponentBase.IsNotRender

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

IModelEqualityComparerExtensions.Equals<TItem>(IModelEqualityComparer<TItem>, TItem?, TItem?)

ExpandableNodeExtensions.SetChildrenCheck<TNode, TItem>(TNode, CheckboxState, TreeNodeCache<TNode, TItem>?)

ExpandableNodeExtensions.SetParentCheck<TNode, TItem>(TNode, CheckboxState, TreeNodeCache<TNode, TItem>?)

ExpandableNodeExtensions.SetParentExpand<TNode, TItem>(TNode, bool)

Constructors

Table()

public Table()

Properties

ActiveRenderMode

获得 渲染模式

protected TableRenderMode ActiveRenderMode { get; }

Property Value

TableRenderMode

AddButtonIcon

获得/设置 新建按钮图标

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

Property Value

string

AddButtonText

获得/设置 新建按钮文本

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

Property Value

string

AddButtonToastContent

获得/设置 新增按钮 Toast 提示 Content 文字

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

Property Value

string

AddButtonToastTitle

获得/设置 新增按钮 Toast 提示 Title 文字

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

Property Value

string

AddModalTitle

获得/设置 新建数据弹窗 Title

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

Property Value

string

AdvanceButtonIcon

获得/设置 高级搜索按钮图标

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

Property Value

string

AdvanceButtonText

获得/设置 高级搜索按钮文本

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

Property Value

string

AdvanceSearchClass

获得 高级搜索样式

protected string? AdvanceSearchClass { get; }

Property Value

string

AdvancedSortButtonIcon

获得/设置 高级排序按钮图标

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

Property Value

string

AdvancedSortButtonText

获得/设置 高级排序按钮文本

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

Property Value

string

AdvancedSortClass

获得 高级排序样式

protected string? AdvancedSortClass { get; }

Property Value

string

AdvancedSortDialogIsDraggable

获得/设置 高级排序框是否可以拖拽 默认 false 不可以拖拽

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

Property Value

bool

AdvancedSortDialogShowMaximizeButton

获得/设置 高级排序框是否显示最大化按钮 默认 false 不显示

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

Property Value

bool

AdvancedSortDialogSize

获得/设置 高级排序框的大小 默认 Medium

[Parameter]
public Size AdvancedSortDialogSize { get; set; }

Property Value

Size

AdvancedSortItems

获得/设置 高级排序，默认为 Empty

[Parameter]
public List<TableSortItem> AdvancedSortItems { get; set; }

Property Value

List<TableSortItem>

AdvancedSortModalTitle

获得/设置 高级排序弹窗文本

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

Property Value

string

AfterExportCallback

获得/设置 导出数据后回调方法 默认 null

[Parameter]
public Func<bool, Task>? AfterExportCallback { get; set; }

Property Value

Func<bool, Task>

AllowDragColumn

获得/设置 是否允许拖放标题栏更改栏位顺序，默认为 false

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

Property Value

bool

AllowResizing

获得/设置 是否允许列宽度调整 默认 false 固定表头时此属性生效

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

Property Value

bool

AutoGenerateColumns

获得/设置 是否自动生成列信息 默认为 false

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

Property Value

bool

AutoRefreshCancelTokenSource

获得/设置 自动刷新 CancellationTokenSource 实例

protected CancellationTokenSource? AutoRefreshCancelTokenSource { get; set; }

Property Value

CancellationTokenSource

AutoRefreshInterval

获得/设置 自动刷新时间间隔 默认 2000 毫秒

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

Property Value

int

AutoScrollLastSelectedRowToView

获得/设置 是否自动将选中行滚动到可视区域 默认 false

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

Property Value

bool

AutoScrollVerticalAlign

获得/设置 选中行滚动到可视区域对齐方式 默认 ScrollToViewAlign.Center

[Parameter]
public ScrollToViewAlign AutoScrollVerticalAlign { get; set; }

Property Value

ScrollToViewAlign

BeforeExportCallback

获得/设置 导出数据前回调方法 默认 null

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

Property Value

Func<Task>

BeforeRowButtonTemplate

获得/设置 BeforeRowButtonTemplate 实例 此模板生成的按钮默认放置到按钮前面如需放置前面 请查看 RowButtonTemplate

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

Property Value

RenderFragment<TItem>

CancelButtonIcon

获得/设置 取消按钮图标

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

Property Value

string

CancelButtonText

获得/设置 取消按钮文本

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

Property Value

string

CancelDeleteButtonText

获得/设置 取消删除按钮文本

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

Property Value

string

CardViewButtonIcon

获得/设置 视图按钮图标

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

Property Value

string

CardViewButtonText

获得/设置 视图按钮文本

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

Property Value

string

CheckboxColumnWidth

获得/设置 复选框宽度 默认 36

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

Property Value

int

CheckboxDisplayText

获得/设置 显示选择框文字 默认为 选择

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

Property Value

string

CheckboxDisplayTextString

获得 选择列显示文字

protected string? CheckboxDisplayTextString { get; }

Property Value

string

ClickToSelect

获得/设置 点击行即选中本行 默认为 false

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

Property Value

bool

ClientTableName

获得/设置 客户端表格名称 默认 null 用于客户端列宽与列顺序持久化功能

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

Property Value

string

CloseButtonIcon

获得/设置 保存按钮图标

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

Property Value

string

CloseButtonText

获得/设置 保存按钮文本

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

Property Value

string

CollapsedTopSearch

获得/设置 是否收缩顶部搜索框 默认为 false 不收缩搜索框 是否显示搜索框请设置 SearchMode 值 Top

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

Property Value

bool

ColumnButtonTemplateHeaderText

获得/设置 行内功能按钮列头文本 默认为 操作

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

Property Value

string

ColumnButtonText

获得/设置 列按钮文本

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

Property Value

string

ColumnButtonTitleText

获得/设置 列显示隐藏按钮提示信息文本

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

Property Value

string

ColumnListButtonIcon

获得/设置 列选择下拉框图标

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

Property Value

string

ColumnMinWidth

获得/设置 列最小宽度 默认 null 未设置 可通过 ColumnMinWidth 统一设置

[Parameter]
public int? ColumnMinWidth { get; set; }

Property Value

int?

ColumnOrderCallback

获得/设置 自定义列排序规则 默认 null 未设置 使用内部排序机制 1 2 3 0 -3 -2 -1 顺序

[Parameter]
public Func<IEnumerable<ITableColumn>, IEnumerable<ITableColumn>>? ColumnOrderCallback { get; set; }

Property Value

Func<IEnumerable<ITableColumn>, IEnumerable<ITableColumn>>

Remarks

如果设置 AllowDragColumn 并且设置 ClientTableName 开启客户端持久化后本回调不生效

ColumnToolboxIcon

获得/设置 列工具栏图标 fa-solid fa-gear

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

Property Value

string

ColumnWidthTooltipPrefix

获得/设置 列调整提示前缀文字 默认 null 未设置使用资源文件中文字

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

Property Value

string

Columns

获得 表头集合

public List<ITableColumn> Columns { get; }

Property Value

List<ITableColumn>

ConfirmDeleteButtonText

获得/设置 确认删除按钮文本

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

Property Value

string

ConfirmDeleteContentText

获得/设置 确认删除弹窗文本

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

Property Value

string

CopyColumnButtonIcon

获得/设置 列拷贝按钮图标

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

Property Value

string

CopyColumnCopiedTooltipText

获得/设置 列拷贝完毕后 Tooltip 文字

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

Property Value

string

CopyColumnTooltipText

获得/设置 列拷贝 Tooltip 文字

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

Property Value

string

CsvExportIcon

获得/设置 内置导出 Csv 按钮图标

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

Property Value

string

CustomKeyAttribute

获得/设置 数据主键标识标签 默认为 KeyAttribute

用于判断数据主键标签，如果模型未设置主键时可使用 ModelEqualityComparer 参数自定义判断

数据模型支持联合主键

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

Property Value

Type

CustomerSearchModel

获得/设置 自定义搜索模型 CustomerSearchTemplate

[Parameter]
public ITableSearchModel? CustomerSearchModel { get; set; }

Property Value

ITableSearchModel

CustomerSearchTemplate

获得/设置 自定义搜索模型模板 CustomerSearchModel

[Parameter]
public RenderFragment<ITableSearchModel>? CustomerSearchTemplate { get; set; }

Property Value

RenderFragment<ITableSearchModel>

DataService

获得/设置 数据服务参数 组件采用就近原则 如果提供了 Items > OnQueryAsync > DataService > 全局注入的数据服务 IDataService

[Parameter]
public IDataService<TItem>? DataService { get; set; }

Property Value

IDataService<TItem>

DeleteButtonIcon

获得/设置 删除按钮图标

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

Property Value

string

DeleteButtonText

获得/设置 删除按钮文本

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

Property Value

string

DeleteButtonToastCanNotDeleteContent

获得/设置 删除按钮选项中有无法删除项时 Toast 提示文字

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

Property Value

string

DeleteButtonToastContent

获得/设置 删除按钮 Toast 提示 Content 文字

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

Property Value

string

DeleteButtonToastResultContent

获得/设置 删除按钮结果 Toast 提示 Content 文字

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

Property Value

string

DeleteButtonToastTitle

获得/设置 删除按钮 Toast 提示 Title 文字

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

Property Value

string

DetailColumnWidth

获得/设置 明细行 Row Header 宽度 默认 24

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

Property Value

int

DetailRowTemplate

获得/设置 明细行模板 IsDetails

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

Property Value

RenderFragment<TItem>

DetailRows

明细行集合用于数据懒加载

protected List<TItem> DetailRows { get; }

Property Value

List<TItem>

DialogService

DialogService 服务实例

[Inject]
protected DialogService? DialogService { get; set; }

Property Value

DialogService

DisableAutoSubmitFormByEnter

获得/设置 是否禁用表单内回车自动提交功能 默认 null 未设置

[Parameter]
public bool? DisableAutoSubmitFormByEnter { get; set; }

Property Value

bool?

DisableExtendDeleteButton

获得/设置 是否禁用行内扩展删除按钮 默认 false 不禁用

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

Property Value

bool

DisableExtendDeleteButtonCallback

获得/设置 是否禁用行内扩展删除按钮 默认为 null 未设置时使用 DisableExtendDeleteButton 值

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

Property Value

Func<TItem, bool>

DisableExtendEditButton

获得/设置 是否禁用行内扩展编辑按钮 默认 false 不禁用

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

Property Value

bool

DisableExtendEditButtonCallback

获得/设置 是否禁用行内扩展编辑按钮 默认为 null 未设置时使用 DisableExtendEditButton 值

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

Property Value

Func<TItem, bool>

DoubleClickToEdit

获得/设置 单选模式下双击即编辑本行 默认为 false

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

Property Value

bool

DrawerService

DrawerService 服务实例

[Inject]
protected DrawerService? DrawerService { get; set; }

Property Value

DrawerService

DynamicContext

获得/设置 动态数据上下文实例

[Parameter]
public IDynamicObjectContext? DynamicContext { get; set; }

Property Value

IDynamicObjectContext

EditButtonIcon

获得/设置 编辑按钮图标

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

Property Value

string

EditButtonText

获得/设置 编辑按钮文本

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

Property Value

string

EditButtonToastMoreSelectContent

获得/设置 编辑按钮 Toast 多项选择时提示 Content 文字

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

Property Value

string

EditButtonToastNoSaveMethodContent

获得/设置 编辑按钮 Toast 未提供 Save 方法时提示 Content 文字

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

Property Value

string

EditButtonToastNotSelectContent

获得/设置 编辑按钮 Toast 未选择时提示 Content 文字

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

Property Value

string

EditButtonToastReadonlyContent

获得/设置 编辑按钮 Toast 选择项设置不可编辑时提示 Content 文字

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

Property Value

string

EditButtonToastTitle

获得/设置 编辑按钮 Toast 提示 Title 文字

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

Property Value

string

EditDialogCloseAsync

获得/设置 编辑弹窗关闭前回调方法

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

Property Value

Func<TItem, bool, Task>

EditDialogCloseButtonIcon

获得/设置 保存弹窗中的关闭按钮图标 默认 null 使用当前主题图标

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

Property Value

string

EditDialogCloseButtonText

获得/设置 保存弹窗中的关闭按钮显示文本 默认为资源文件中的 关闭

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

Property Value

string

EditDialogFullScreenSize

获得/设置 编辑框 FullScreenSize 参数 默认 none

[Parameter]
public FullScreenSize EditDialogFullScreenSize { get; set; }

Property Value

FullScreenSize

EditDialogIsDraggable

获得/设置 编辑框是否可以拖拽 默认 false 不可以拖拽

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

Property Value

bool

EditDialogItemsPerRow

获得/设置 每行显示组件数量 默认为 2

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

Property Value

int

EditDialogLabelAlign

获得/设置 设置 EditDialogRowType Inline 模式下标签对齐方式 默认 None 等效于 Left 左对齐

[Parameter]
public Alignment EditDialogLabelAlign { get; set; }

Property Value

Alignment

EditDialogRowType

获得/设置 设置行内组件布局格式 默认 Inline 布局

[Parameter]
public RowType EditDialogRowType { get; set; }

Property Value

RowType

EditDialogSaveButtonIcon

获得/设置 保存弹窗中的保存按钮图标 默认 null 使用当前主题图标

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

Property Value

string

EditDialogSaveButtonText

获得/设置 保存弹窗中的保存按钮显示文本 默认为资源文件中的 保存

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

Property Value

string

EditDialogShowMaximizeButton

获得/设置 编辑框是否显示最大化按钮 默认 true 显示

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

Property Value

bool

EditDialogSize

编辑框的大小

[Parameter]
public Size EditDialogSize { get; set; }

Property Value

Size

EditFooterTemplate

获得/设置 弹窗 Footer

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

Property Value

RenderFragment<TItem>

EditModalTitle

获得/设置 编辑数据弹窗 Title

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

Property Value

string

EditModalTitleString

获得/设置 编辑弹窗 Title 文字

protected string? EditModalTitleString { get; set; }

Property Value

string

EditMode

获得/设置 组件编辑模式 默认为弹窗编辑行数据 PopupEditForm

[Parameter]
public EditMode EditMode { get; set; }

Property Value

EditMode

EditModel

获得/设置 EditModel 实例

[Parameter]
public TItem? EditModel { get; set; }

Property Value

TItem

EditTemplate

获得/设置 EditTemplate 实例

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

Property Value

RenderFragment<TItem>

EmptyImage

获得/设置 无数据时显示图片路径 默认 null 未设置

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

Property Value

string

EmptyTemplate

获得/设置 无数据时显示模板 默认 null

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

Property Value

RenderFragment

EmptyText

获得/设置 无数据时显示文本 默认取资源文件 英文 NoData 中文 无数据

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

Property Value

string

ExcelExportIcon

获得/设置 内置导出 Excel 按钮图标

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

Property Value

string

ExpandRows

明细行集合用于数据懒加载

protected List<TItem> ExpandRows { get; }

Property Value

List<TItem>

ExportButtonDropdownTemplate

获得/设置 导出按钮下拉菜单模板 默认 null

[Parameter]
public RenderFragment<ITableExportContext<TItem>>? ExportButtonDropdownTemplate { get; set; }

Property Value

RenderFragment<ITableExportContext<TItem>>

ExportButtonIcon

获得/设置 导出按钮图标

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

Property Value

string

ExportButtonText

获得/设置 导出按钮文本

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

Property Value

string

ExportCsvDropdownItemText

获得/设置 内置导出微软 Csv 按钮文本 默认 null 读取资源文件

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

Property Value

string

ExportExcelDropdownItemText

获得/设置 内置导出微软 Excel 按钮文本 默认 null 读取资源文件

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

Property Value

string

ExportPdfDropdownItemText

获得/设置 内置导出 Pdf 按钮文本 默认 null 读取资源文件

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

Property Value

string

ExportToastContent

获得/设置 导出数据提示内容 默认为资源文件

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

Property Value

string

ExportToastInProgressContent

获得/设置 正在导出数据提示内容 默认为资源文件

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

Property Value

string

ExportToastTitle

获得/设置 导出数据弹窗 Title 默认为资源文件 导出数据

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

Property Value

string

ExtendButtonColumnAlignment

获得/设置 行内操作列对齐方式 默认 center

[Parameter]
public Alignment ExtendButtonColumnAlignment { get; set; }

Property Value

Alignment

ExtendButtonColumnWidth

获得/设置 行内操作列宽度 默认为 130

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

Property Value

int

ExtendButtonsColumnClass

获得 按钮列样式表集合

protected string? ExtendButtonsColumnClass { get; }

Property Value

string

FailText

获得/设置 保存失败

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

Property Value

string

FilterIcon

获得/设置 过滤图标 默认 fa-solid fa-filter

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

Property Value

string

Filters

获得 过滤集合

public Dictionary<string, IFilterAction> Filters { get; }

Property Value

Dictionary<string, IFilterAction>

FirstRender

获得/设置 是否为第一次 Render

protected bool FirstRender { get; set; }

Property Value

bool

FixedDetailRowHeaderColumn

获得/设置 是否固定明细行 Header 列 默认为 false 不固定

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

Property Value

bool

FixedExtendButtonsColumn

获得/设置 是否固定扩展按钮列 默认为 false 不固定

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

Property Value

bool

FixedExtendButtonsColumnClassString

获得扩展按钮列固定列样式

protected string? FixedExtendButtonsColumnClassString { get; }

Property Value

string

FixedLineNoColumn

获得/设置 是否固定 LineNo 列 默认为 false 不固定

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

Property Value

bool

FixedMultipleColumn

获得/设置 是否固定多选列 默认为 false 不固定

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

Property Value

bool

FooterTemplate

获得/设置 Table Footer 模板

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

Property Value

RenderFragment<IEnumerable<TItem>>

GearIcon

获得/设置 工具栏移动端按钮图标

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

Property Value

string

GetAdvancedSearchFilterCallback

获得/设置 获得高级搜索条件回调方法 默认 null

[Parameter]
public Func<PropertyInfo, TItem, List<SearchFilterAction>?>? GetAdvancedSearchFilterCallback { get; set; }

Property Value

Func<PropertyInfo, TItem, List<SearchFilterAction>>

GotoNavigatorLabelText

获得/设置 是否显示 Goto 跳转导航文本信息 默认 null

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

Property Value

string

GotoTemplate

获得/设置 Goto 导航模板

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

Property Value

RenderFragment

HeaderClass

获得 thead 样式表集合

protected string? HeaderClass { get; }

Property Value

string

HeaderStyle

获取/设置 表格 thead 样式 TableHeaderStyle，默认为浅色None

[Parameter]
public TableHeaderStyle HeaderStyle { get; set; }

Property Value

TableHeaderStyle

HeaderTextWrap

获得/设置 是否表头允许折行 默认 false 不折行 此设置为 true 时覆盖 HeaderTextWrap 参数值

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

Property Value

bool

Height

获得/设置 Table 高度 默认为 null

[Parameter]
public int? Height { get; set; }

Property Value

int?

Remarks

开启固定表头功能时生效 IsFixedHeader

IndentSize

获得/设置 缩进大小 默认为 16 单位 px

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

Property Value

int

InsertRowMode

获得/设置 新建行位置枚举 默认为 Last 最后

[Parameter]
public InsertRowMode InsertRowMode { get; set; }

Property Value

InsertRowMode

InternalOnSortAsync

获得/设置 内部表头排序时回调方法

protected Func<string, SortOrder, Task>? InternalOnSortAsync { get; set; }

Property Value

Func<string, SortOrder, Task>

InternalPageInfoTemplate

内部 分页信息模板

protected RenderFragment InternalPageInfoTemplate { get; }

Property Value

RenderFragment

IsAccordion

获得/设置 明细行手风琴效果 默认 false

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

Property Value

bool

IsAdvanceSearch

获得/设置 是否已经处理高级搜索 默认 false

protected bool IsAdvanceSearch { get; set; }

Property Value

bool

IsAutoCollapsedToolbarButton

获得/设置 是否自动收缩工具栏按钮 默认 true

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

Property Value

bool

IsAutoQueryFirstRender

获得/设置 首次加载时是否自动查询数据 默认 true Items 模式下此参数不起作用

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

Property Value

bool

IsAutoRefresh

获得/设置 是否自动刷新表格 默认为 false

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

Property Value

bool

Remarks

此参数在 IsExcel 模式下不生效

IsBordered

获得/设置 是否带边框样式 默认为 false

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

Property Value

bool

IsDetails

获得/设置 是否显示明细行 默认为 null 为空时使用 DetailRowTemplate 进行逻辑判断

[Parameter]
public bool? IsDetails { get; set; }

Property Value

bool?

IsExcel

获得/设置 组件工作模式为 Excel 模式 默认 false

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

Property Value

bool

IsExtendButtonsInRowHeader

获得/设置 扩展按钮是否在前面 默认 false 在行尾

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

Property Value

bool

IsFixedFooter

获得/设置 固定 Footer 默认 false

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

Property Value

bool

IsFixedHeader

获得/设置 固定表头 默认 false

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

Property Value

bool

IsHideFooterWhenNoData

获得/设置 无数据时是否隐藏表格 Footer 默认为 false 不隐藏

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

Property Value

bool

IsKeepSelectedRows

获得/设置 是否保持选择行，默认为 false 不保持

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

Property Value

bool

IsKeyboard

获得/设置 是否支持键盘 ESC 关闭当前弹窗 默认 true 支持

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

Property Value

bool

IsMultipleSelect

获得/设置 是否为多选模式 默认为 false

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

Property Value

bool

Remarks

此参数在 IsExcel 模式下为 true

IsPagination

获得/设置 是否分页 默认为 false

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

Property Value

bool

IsPopoverToolbarDropdownButton

获得/设置 工具栏下拉框按钮是否 IsPopover 默认 false

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

Property Value

bool

IsStriped

获得/设置 是否斑马线样式 默认为 false

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

Property Value

bool

Remarks

此参数在 IsExcel 模式下不生效

IsTracking

获得/设置 组件是否采用 Tracking 模式对编辑项进行直接更新 默认 false

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

Property Value

bool

IsTree

获得/设置 是否为树形数据 默认为 false

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

Property Value

bool

Items

获得/设置 数据集合，适用于无功能仅做数据展示使用，高级功能时请使用 OnQueryAsync 回调委托

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

Property Value

IEnumerable<TItem>

ItemsChanged

获得/设置 数据集合回调方法

[Parameter]
public EventCallback<IEnumerable<TItem>> ItemsChanged { get; set; }

Property Value

EventCallback<IEnumerable<TItem>>

LineNoColumnAlignment

获得/设置 行号内容位置

[Parameter]
public Alignment LineNoColumnAlignment { get; set; }

Property Value

Alignment

LineNoColumnWidth

获得/设置 行号列宽度 默认 60

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

Property Value

int

LineNoText

获得/设置 行号列标题文字 默认为 行号

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

Property Value

string

LoadingTemplate

获得/设置 Loading 模板

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

Property Value

RenderFragment

MaxPageLinkCount

获得/设置 Page up/down 页码数量 默认 5

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

Property Value

int

ModelEqualityComparer

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

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

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

Property Value

Func<TItem, TItem, bool>

MultiHeaderTemplate

获得/设置 多表头模板

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

Property Value

RenderFragment

OnAddAsync

获得/设置 新建按钮回调方法

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

Property Value

Func<Task<TItem>>

OnAfterDeleteAsync

获得/设置 删除后回调委托方法

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

Property Value

Func<List<TItem>, Task>

OnAfterModifyAsync

获得/设置 保存删除后回调委托方法

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

Property Value

Func<Task>

OnAfterRenderCallback

获得/设置 Table 组件渲染完毕回调

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

Property Value

Func<Table<TItem>, bool, Task>

OnAfterSaveAsync

获得/设置 保存后回调委托方法

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

Property Value

Func<TItem, Task>

OnAutoFitContentAsync

获得/设置 自动调整列宽回调方法

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

Property Value

Func<string, Task<float>>

OnBeforeRenderRow

获得/设置 呈现每行之前的回调

[Parameter]
public Action<TItem>? OnBeforeRenderRow { get; set; }

Property Value

Action<TItem>

OnBeforeShowDrawer

获得/设置 抽屉打开之前回调方法 用于设置 DrawerOption 抽屉配置信息

[Parameter]
public Func<DrawerOption, Task>? OnBeforeShowDrawer { get; set; }

Property Value

Func<DrawerOption, Task>

OnClickRowCallback

获得/设置 单击行回调委托方法

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

Property Value

Func<TItem, Task>

OnColumnCreating

获得/设置 列创建时回调委托方法

[Parameter]
public Func<List<ITableColumn>, Task>? OnColumnCreating { get; set; }

Property Value

Func<List<ITableColumn>, Task>

OnColumnVisibleChanged

获得/设置 列改变显示状态回调方法

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

Property Value

Func<string, bool, Task>

OnDeleteAsync

获得/设置 删除按钮异步回调方法

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

Property Value

Func<IEnumerable<TItem>, Task<bool>>

OnDoubleClickCellCallback

获得/设置 双击单元格回调委托

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

Property Value

Func<string, TItem, object, Task>

OnDoubleClickRowCallback

获得/设置 双击行回调委托方法

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

Property Value

Func<TItem, Task>

OnDragColumnEndAsync

获得/设置 拖动列结束回调方法，默认 null 可存储数据库用于服务器端保持列顺序

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

Property Value

Func<string, IEnumerable<ITableColumn>, Task>

OnEditAsync

获得/设置 编辑按钮回调方法

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

Property Value

Func<TItem, Task>

OnExportAsync

获得/设置 导出按钮异步回调方法

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

Property Value

Func<ITableExportDataContext<TItem>, Task<bool>>

OnFilterAsync

获得/设置 表头过滤时回调方法

public Func<Task>? OnFilterAsync { get; }

Property Value

Func<Task>

OnQueryAsync

异步查询回调方法，设置 Items 后无法触发此回调方法

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

Property Value

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

OnResetSearchAsync

重置搜索按钮异步回调方法

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

Property Value

Func<TItem, Task>

OnResizeColumnAsync

获得/设置 设置列宽回调方法

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

Property Value

Func<string, float, Task>

OnSaveAsync

获得/设置 保存按钮异步回调方法

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

Property Value

Func<TItem, ItemChangedType, Task<bool>>

OnSort

获得/设置 点击表头排序时回调方法

[Parameter]
public Func<string, SortOrder, string>? OnSort { get; set; }

Property Value

Func<string, SortOrder, string>

OnToggleDetailRowCallback

获得/设置 展开收起明细行回调方法 第二个参数 true 时表示展开 false 时表示收起

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

Property Value

Func<TItem, bool, Task>

OnTreeExpand

获得/设置 树形数据节点展开式回调委托方法

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

Property Value

Func<TItem, Task<IEnumerable<TableTreeNode<TItem>>>>

PageCount

获得/设置 分页页码总数 内置规则 PageCount > 1 时显示分页组件

protected int PageCount { get; set; }

Property Value

int

PageIndex

获得/设置 当前页码 默认 1

protected int PageIndex { get; set; }

Property Value

int

PageInfoBodyTemplate

获得/设置 分页信息内容模板 默认 null

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

Property Value

RenderFragment

PageInfoTemplate

获得/设置 分页信息模板

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

Property Value

RenderFragment

PageInfoText

获得/设置 分页信息文字 默认 null

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

Property Value

string

PageItems

获得/设置 默认每页数据数量 默认 0 使用 PageItemsSource 第一个值

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

Property Value

int

PageItemsSource

获得/设置 每页显示数据数量的外部数据源

[Parameter]
public IEnumerable<int>? PageItemsSource { get; set; }

Property Value

IEnumerable<int>

PdfExportIcon

获得/设置 内置导出 Pdf 按钮图标

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

Property Value

string

RefreshButtonIcon

获得/设置 刷新按钮图标

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

Property Value

string

RefreshButtonText

获得/设置 刷新按钮文本

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

Property Value

string

RenderMode

获得/设置 组件布局方式 默认为 Auto

[Parameter]
public TableRenderMode RenderMode { get; set; }

Property Value

TableRenderMode

RenderModeResponsiveWidth

获得/设置 组件布局自适应切换阈值 默认为 768

[Parameter]
public BreakPoint RenderModeResponsiveWidth { get; set; }

Property Value

BreakPoint

ResetSearchButtonIcon

获得/设置 重置按钮图标

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

Property Value

string

ResetSearchButtonText

获得/设置 重置按钮文本

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

Property Value

string

RowButtonTemplate

获得/设置 RowButtonTemplate 实例 此模板生成的按钮默认放置到按钮后面如需放置前面 请查看 BeforeRowButtonTemplate

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

Property Value

RenderFragment<TItem>

RowHeight

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

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

Property Value

float

Remarks

需要设置 ScrollMode 值为 Virtual 时生效

RowTemplate

获得/设置 行模板

[Parameter]
public RenderFragment<TableRowContext<TItem>>? RowTemplate { get; set; }

Property Value

RenderFragment<TableRowContext<TItem>>

Rows

获得 当前表格所有 Rows 集合

public List<TItem> Rows { get; }

Property Value

List<TItem>

SaveButtonIcon

获得/设置 保存按钮图标

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

Property Value

string

SaveButtonText

获得/设置 保存按钮文本

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

Property Value

string

SaveButtonToastContent

获得/设置 保存按钮 Toast 提示 Content 文字

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

Property Value

string

SaveButtonToastResultContent

获得/设置 保存按钮结果 Toast 提示 Content 文字

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

Property Value

string

SaveButtonToastTitle

获得/设置 保存按钮 Toast 提示 Title 文字

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

Property Value

string

ScreenSize

获得/设置 客户端屏幕宽度

protected BreakPoint ScreenSize { get; set; }

Property Value

BreakPoint

ScrollHoverWidth

获得/设置 滚动条 hover 状态下宽度 默认 null 未设置使用 ScrollOptions 配置类中的 ScrollHoverWidth

[Parameter]
public int? ScrollHoverWidth { get; set; }

Property Value

int?

ScrollMode

获得/设置 数据滚动模式

[Parameter]
public ScrollMode ScrollMode { get; set; }

Property Value

ScrollMode

ScrollWidth

获得/设置 滚动条宽度 默认 null 未设置使用 ScrollOptions 配置类中的 ScrollWidth

[Parameter]
public int? ScrollWidth { get; set; }

Property Value

int?

ScrollingDialogContent

获得/设置 编辑弹框是否 Body 出现滚动条 默认 false

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

Property Value

bool

SearchButtonIcon

获得/设置 搜索按钮图标

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

Property Value

string

SearchButtonText

获得/设置 搜索按钮文本

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

Property Value

string

SearchDialogIsDraggable

获得/设置 搜索框是否可以拖拽 默认 false 不可以拖拽

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

Property Value

bool

SearchDialogItemsPerRow

获得/设置 每行显示组件数量 默认为 2

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

Property Value

int

SearchDialogLabelAlign

获得/设置 设置 SearchDialogRowType Inline 模式下标签对齐方式 默认 None 等效于 Left 左对齐

[Parameter]
public Alignment SearchDialogLabelAlign { get; set; }

Property Value

Alignment

SearchDialogRowType

获得/设置 设置行内组件布局格式 默认 Inline 布局

[Parameter]
public RowType SearchDialogRowType { get; set; }

Property Value

RowType

SearchDialogShowMaximizeButton

获得/设置 搜索框是否显示最大化按钮 默认 true 不显示

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

Property Value

bool

SearchDialogSize

获得/设置 搜索框的大小

[Parameter]
public Size SearchDialogSize { get; set; }

Property Value

Size

SearchModalTitle

获得/设置 搜索弹窗文本

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

Property Value

string

SearchMode

获得/设置 搜索栏渲染方式 默认 Popup 弹窗模式

[Parameter]
public SearchMode SearchMode { get; set; }

Property Value

SearchMode

SearchModel

获得/设置 SearchModel 实例

[Parameter]
public TItem SearchModel { get; set; }

Property Value

TItem

SearchPlaceholderText

获得/设置 搜索栏 Placeholder 文本

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

Property Value

string

SearchTemplate

获得/设置 SearchTemplate 实例

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

Property Value

RenderFragment<TItem>

SearchText

获得/设置 搜索关键字 通过列设置的 Searchable 自动生成搜索拉姆达表达式

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

Property Value

string

SearchTooltip

获得/设置 获得/设置 搜索框提示文字

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

Property Value

string

SelectedRows

获得/设置 被选中数据集合

[Parameter]
public List<TItem> SelectedRows { get; set; }

Property Value

List<TItem>

SelectedRowsChanged

获得/设置 选中行变化回调方法

[Parameter]
public EventCallback<List<TItem>> SelectedRowsChanged { get; set; }

Property Value

EventCallback<List<TItem>>

SetRowClassFormatter

获得/设置 行样式格式回调委托

[Parameter]
public Func<TItem, string?>? SetRowClassFormatter { get; set; }

Property Value

Func<TItem, string>

ShowAddButton

获得/设置 是否显示新建按钮 默认为 true 显示

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

Property Value

bool

ShowAdvancedSearch

获得/设置 是否显示高级搜索按钮 默认 true 显示 ShowSearch

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

Property Value

bool

ShowAdvancedSort

获得/设置 是否显示高级排序按钮 默认 false 不显示 />

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

Property Value

bool

ShowCardView

获得/设置 是否显示视图按钮 默认为 false IsExcel 模式下此设置无效

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

Property Value

bool

ShowCheckboxText

获得/设置 是否显示选择框文字 默认为 false

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

Property Value

bool

ShowCheckboxTextColumnWidth

获得/设置 显示文字的复选框列宽度 默认 80

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

Property Value

int

ShowColumnList

获得/设置 是否显示列选择下拉框 默认为 false 不显示 点击下拉框内列控制是否显示后触发 OnColumnVisibleChanged 回调方法

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

Property Value

bool

ShowColumnWidthTooltip

获得/设置 是否显示列宽提示信息，默认 false 显示

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

Property Value

bool

ShowCopyColumnTooltip

获得/设置 CopyColumn Tooltip 默认 true

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

Property Value

bool

ShowDefaultButtons

获得/设置 是否显示按钮列 默认为 true

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

Property Value

bool

Remarks

本属性设置为 true 新建编辑删除按钮设置为 false 可单独控制每个按钮是否显示

ShowDeleteButton

获得/设置 是否显示删除按钮 默认为 true 行内是否显示请使用 ShowExtendDeleteButton 与 ShowExtendDeleteButtonCallback

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

Property Value

bool

ShowDeleteButtonCallback

获得/设置 是否显示行内扩展删除按钮 默认为 null 未设置时使用 ShowExtendDeleteButton 值

[Parameter]
[Obsolete("This callback is obsolete. Use ShowExtendDeleteButtonCallback instead. 已过期，请使用 ShowExtendDeleteButtonCallback 参数")]
public Func<TItem, bool>? ShowDeleteButtonCallback { get; set; }

Property Value

Func<TItem, bool>

ShowDetailRow

获得/设置 是否显示每行的明细行展开图标

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

Property Value

Func<TItem, bool>

Remarks

此参数在 IsExcel 模式下不生效

ShowEditButton

获得/设置 是否显示编辑按钮 默认为 true 行内是否显示请使用 ShowExtendEditButton 与 ShowExtendEditButtonCallback

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

Property Value

bool

ShowEditButtonCallback

获得/设置 是否显示行内扩展编辑按钮 默认为 null 未设置时使用 ShowExtendEditButton 值

[Parameter]
[Obsolete("This callback is obsolete. Use ShowExtendEditButtonCallback instead. 已过期，请使用 ShowExtendEditButtonCallback 参数")]
public Func<TItem, bool>? ShowEditButtonCallback { get; set; }

Property Value

Func<TItem, bool>

ShowEmpty

获得/设置 是否显示无数据空记录 默认 false 不显示

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

Property Value

bool

ShowExportButton

获得/设置 是否显示导出按钮 默认为 false 不显示

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

Property Value

bool

ShowExportCsvButton

获得/设置 是否显示 Csv 导出按钮 默认为 false 显示

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

Property Value

bool

ShowExportExcelButton

获得/设置 是否显示 Excel 导出按钮 默认为 true 显示

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

Property Value

bool

ShowExportPdfButton

获得/设置 是否显示 Pdf 导出按钮 默认为 false 显示

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

Property Value

bool

ShowExtendButtons

获得/设置 是否显示扩展按钮 默认为 false

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

Property Value

bool

ShowExtendDeleteButton

获得/设置 是否显示行内扩展删除按钮 默认 true 显示

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

Property Value

bool

ShowExtendDeleteButtonCallback

获得/设置 是否显示行内扩展删除按钮 默认为 null 未设置时使用 ShowExtendDeleteButton 值

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

Property Value

Func<TItem, bool>

ShowExtendEditButton

获得/设置 是否显示行内扩展编辑按钮 默认 true 显示

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

Property Value

bool

ShowExtendEditButtonCallback

获得/设置 是否显示行内扩展编辑按钮 默认为 null 未设置时使用 ShowExtendEditButton 值

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

Property Value

Func<TItem, bool>

ShowFilterHeader

获得/设置 是否显示过滤表头 默认 false 不显示

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

Property Value

bool

ShowFooter

获得/设置 是否显示表脚 默认为 false

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

Property Value

bool

ShowGotoNavigator

获得/设置 是否显示 Goto 跳转导航

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

Property Value

bool

ShowLineNo

获得/设置 是否显示行号列 默认为 false

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

Property Value

bool

ShowLoading

获得/设置 查询时是否显示正在加载中动画 默认为 false

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

Property Value

bool

ShowLoadingInFirstRender

获得/设置 首次加载是否显示加载动画 默认 true 显示 设置 ShowSkeleton 值覆盖此参数

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

Property Value

bool

ShowMultiFilterHeader

获得/设置 是否显示过滤表头 默认 false 不显示

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

Property Value

bool

ShowPageInfo

获得/设置 是否显示 PageInfo 内容 默认 true 显示

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

Property Value

bool

ShowRefresh

获得/设置 是否显示刷新按钮 默认为 true

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

Property Value

bool

ShowResetButton

获得/设置 是否显示清空搜索按钮 默认 true 显示 ShowSearch

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

Property Value

bool

ShowRowCheckboxCallback

获得/设置 表格行是否显示选择框 默认全部显示 此属性在 IsMultipleSelect 参数为 true 时生效

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

Property Value

Func<TItem, bool>

ShowSearch

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

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

Property Value

bool

ShowSearchButton

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

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

Property Value

bool

ShowSearchText

获得/设置 是否显示搜索文本框 默认为 true 显示搜索文本框 ShowSearch

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

Property Value

bool

ShowSearchTextTooltip

获得/设置 是否显示搜索框提示文本 默认 true

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

Property Value

bool

ShowSkeleton

获得/设置 首次加载是否显示加载骨架屏 默认 false 不显示 使用 ShowLoadingInFirstRender 参数值

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

Property Value

bool

ShowToastAfterExport

获得/设置 导出数据后是否弹出 Toast 提示框 默认 true

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

Property Value

bool

ShowToastAfterSaveOrDeleteModel

获得/设置 保存、删除失败后是否显示 Toast 提示框 默认为 true 显示

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

Property Value

bool

ShowToastBeforeExport

获得/设置 导出数据前是否弹出 Toast 提示框 默认 true

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

Property Value

bool

ShowToolbar

获得/设置 是否显示工具栏 默认 false 不显示

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

Property Value

bool

ShowTopPagination

获得/设置 是否在顶端显示分页 默认为 false

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

Property Value

bool

ShowUnsetGroupItemsOnTop

获得/设置 未分组编辑项布局位置 默认 false 在尾部

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

Property Value

bool

SortAscText

获得/设置 升序排序时 tooltip 显示文字 默认点击降序

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

Property Value

string

SortDescText

获得/设置 降序排序时 tooltip 显示文字 默认取消排序

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

Property Value

string

SortIcon

获得/设置 默认图标 fa-solid fa-sort

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

Property Value

string

SortIconAsc

获得/设置 升序图标 fa-solid fa-sort-up

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

Property Value

string

SortIconDesc

获得/设置 降序图标 fa-solid fa-sort-down

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

Property Value

string

SortName

获得/设置 排序字段名称

protected string? SortName { get; set; }

Property Value

string

SortOrder

获得/设置 排序方式

protected SortOrder SortOrder { get; set; }

Property Value

SortOrder

SortString

获得/设置 多列排序顺序 默认为空 多列时使用逗号分割 如："Name, Age desc"

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

Property Value

string

StartIndex

获得/设置 当前行

protected int StartIndex { get; set; }

Property Value

int

SuccessText

获得/设置 保存成功文字

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

Property Value

string

TableColumns

获得/设置 TableHeader 实例

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

Property Value

RenderFragment<TItem>

TableExtensionToolbarBeforeTemplate

获得/设置 表格 Toolbar 按钮模板

表格工具栏右侧按钮模板，模板中内容出现在默认按钮前面

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

Property Value

RenderFragment

TableExtensionToolbarTemplate

获得/设置 表格 Toolbar 按钮模板

表格工具栏右侧按钮模板，模板中内容出现在默认按钮后面

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

Property Value

RenderFragment

TableFooter

获得/设置 TableFooter 实例

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

Property Value

RenderFragment<IEnumerable<TItem>>

TableSize

获得/设置 表格组件大小 默认为 Normal 正常模式

[Parameter]
public TableSize TableSize { get; set; }

Property Value

TableSize

TableToolbarBeforeTemplate

获得/设置 表格 Toolbar 按钮模板

表格工具栏左侧按钮模板，模板中内容出现在默认按钮前面

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

Property Value

RenderFragment

TableToolbarTemplate

获得/设置 表格 Toolbar 按钮模板

表格工具栏左侧按钮模板，模板中内容出现在默认按钮后面

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

Property Value

RenderFragment

Toast

ToastService 服务实例

[Inject]
protected ToastService? Toast { get; set; }

Property Value

ToastService

TotalCount

获得/设置 数据总条目

protected int TotalCount { get; set; }

Property Value

int

TreeExpandIcon

获得/设置 数型结构展开小箭头图标

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

Property Value

string

TreeIcon

获得/设置 数型结构小箭头图标

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

Property Value

string

TreeNodeCache

节点缓存类实例

protected ExpandableNodeCache<TableTreeNode<TItem>, TItem>? TreeNodeCache { get; set; }

Property Value

ExpandableNodeCache<TableTreeNode<TItem>, TItem>

TreeNodeConverter

获得/设置 生成树状结构回调方法

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

Property Value

Func<IEnumerable<TItem>, Task<IEnumerable<TableTreeNode<TItem>>>>

TreeNodeLoadingIcon

获得/设置 数型结构正在加载图标

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

Property Value

string

UnsetText

获得/设置 未设置排序时 tooltip 显示文字 默认点击升序

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

Property Value

string

UpdateButtonText

获得/设置 更新按钮文本

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

Property Value

string

VirtualizeElement

获得/设置 内置虚拟化组件实例

protected Virtualize<TItem>? VirtualizeElement { get; set; }

Property Value

Virtualize<TItem>

WrapperClassName

获得 wrapper 样式表集合

protected string? WrapperClassName { get; }

Property Value

string

Methods

AddAsync()

新建按钮方法

public Task AddAsync()

Returns

Task

AutoFitContentCallback(string)

列宽自适应回调方法 由 JavaScript 脚本调用

[JSInvokable]
public Task<float> AutoFitContentCallback(string fieldName)

Parameters

fieldName string

当前列名称

Returns

Task<float>

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

CancelSave()

取消保存方法

protected void CancelSave()

CheckActive(TItem)

检查当前行是否被选中方法

protected virtual bool CheckActive(TItem val)

Parameters

val TItem

Returns

bool

CheckShownWithBreakpoint(ITableColumn)

检查当前列是否显示方法

protected bool CheckShownWithBreakpoint(ITableColumn col)

Parameters

col ITableColumn

Returns

bool

ClearSearchClick()

重置搜索按钮调用此方法

protected Task ClearSearchClick()

Returns

Task

ClickBeforeDelete(TItem)

行尾列按钮点击回调此方法

protected Func<Task<bool>> ClickBeforeDelete(TItem item)

Parameters

item TItem

Returns

Func<Task<bool>>

ClickRow(TItem)

单选模式下选择行时调用此方法

protected Task ClickRow(TItem val)

Parameters

val TItem

Returns

Task

ConfirmDelete()

确认删除按钮方法

protected Task<bool> ConfirmDelete()

Returns

Task<bool>

DeleteAsync()

删除数据方法

protected Task DeleteAsync()

Returns

Task

DisposeAsync(bool)

Dispose 方法

protected override ValueTask DisposeAsync(bool disposing)

Parameters

disposing bool

Returns

ValueTask

DoubleClickRow(TItem)

双击行回调此方法

protected Task DoubleClickRow(TItem item)

Parameters

item TItem

Returns

Task

DragColumnCallback(int, int)

重置列方法 由 JavaScript 脚本调用

[JSInvokable]
public Task DragColumnCallback(int originIndex, int currentIndex)

Parameters

originIndex int

currentIndex int

Returns

Task

EditAsync()

编辑按钮方法

public Task EditAsync()

Returns

Task

Equals(TItem?, TItem?)

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

Parameters

x TItem

y TItem

Returns

bool

ExpandDetailRow(TItem)

明细行功能中切换行状态时调用此方法

public Task ExpandDetailRow(TItem item)

Parameters

item TItem

Returns

Task

GetAdvanceSearches()

获得 SearchModel 中过滤条件

protected List<IFilterAction> GetAdvanceSearches()

Returns

List<IFilterAction>

GetAdvancedSortList()

获得 AdvancedSortItems 中过滤条件

protected IEnumerable<string> GetAdvancedSortList()

Returns

IEnumerable<string>

GetCellClassString(ITableColumn, bool, bool)

获得 Cell 文字样式

protected string? GetCellClassString(ITableColumn col, bool hasChildren, bool inCell)

Parameters

col ITableColumn

hasChildren bool

inCell bool

Returns

string

GetCellStyleString(ITableColumn)

获得列单元格 Style 用于设置文本超长溢出

protected string? GetCellStyleString(ITableColumn col)

Parameters

col ITableColumn

Returns

string

GetColumnToolboxIconClassString()

获取指定列头样式字符串

protected string? GetColumnToolboxIconClassString()

Returns

string

GetCustomerSearches()

获得 CustomerSearchModel 中过滤条件 SearchTemplate 模板中的条件无法获得

protected IEnumerable<IFilterAction> GetCustomerSearches()

Returns

IEnumerable<IFilterAction>

GetDetailBarClassString(TItem)

明细行首小图标单元格样式

protected string? GetDetailBarClassString(TItem item)

Parameters

item TItem

Returns

string

GetDetailCaretClassString(TItem)

获得明细行小图标样式

protected string? GetDetailCaretClassString(TItem item)

Parameters

item TItem

Returns

string

GetDetailRowClassString(TItem)

获得明细行样式

protected string? GetDetailRowClassString(TItem item)

Parameters

item TItem

Returns

string

GetFixedCellClassString(ITableColumn, string?)

获得指定列头固定列样式

protected string? GetFixedCellClassString(ITableColumn col, string? cellClass = null)

Parameters

col ITableColumn

cellClass string

Returns

string

GetFixedCellStyleString(ITableColumn, int)

获得指定列头固定列样式

protected string? GetFixedCellStyleString(ITableColumn col, int margin = 0)

Parameters

col ITableColumn

margin int

Returns

string

GetFixedExtendButtonsColumnStyleString(int)

获得扩展按钮列固定列样式

protected string? GetFixedExtendButtonsColumnStyleString(int margin = 0)

Parameters

margin int

Returns

string

GetHeaderCellClassString(ITableColumn)

获得列头单元格样式

protected string? GetHeaderCellClassString(ITableColumn col)

Parameters

col ITableColumn

Returns

string

GetHeaderClassString(ITableColumn, bool)

获取指定列头样式字符串

protected string? GetHeaderClassString(ITableColumn col, bool isFilterHeader = false)

Parameters

col ITableColumn

isFilterHeader bool

Returns

string

GetHeaderWrapperClassString(ITableColumn)

获取指定列头样式字符串

protected string? GetHeaderWrapperClassString(ITableColumn col)

Parameters

col ITableColumn

Returns

string

GetIconClassString(string)

获取指定列头样式字符串

protected string? GetIconClassString(string fieldName)

Parameters

fieldName string

Returns

string

GetPageItemsSource()

获得 分页数据源

protected List<SelectedItem> GetPageItemsSource()

Returns

List<SelectedItem>

GetRowClassString(TItem, string?)

获得 Body 内行样式

protected string? GetRowClassString(TItem item, string? css = null)

Parameters

item TItem

css string

Returns

string

GetSearches()

通过列集合中的 Searchable 列与 SearchText 拼装 IFilterAction 集合

protected List<IFilterAction> GetSearches()

Returns

List<IFilterAction>

GetSelectedRows()

获取当前 Table 选中的所有行数据

protected IEnumerable<TItem> GetSelectedRows()

Returns

IEnumerable<TItem>

GetShowExtendDeleteButton(TItem)

是否显示行内删除按钮

protected bool GetShowExtendDeleteButton(TItem item)

Parameters

item TItem

Returns

bool

GetShowExtendEditButton(TItem)

是否显示行内编辑按钮

protected bool GetShowExtendEditButton(TItem item)

Parameters

item TItem

Returns

bool

GetTreeClassString(bool)

树形数据展开小箭头

protected string? GetTreeClassString(bool isExpand)

Parameters

isExpand bool

Returns

string

GetTreeStyleString(int)

树形数据小箭头缩进

protected string? GetTreeStyleString(int degree)

Parameters

degree int

Returns

string

GetValue(ITableColumn, TItem)

获得 指定单元格数据方法

protected RenderFragment GetValue(ITableColumn col, TItem item)

Parameters

col ITableColumn

item TItem

Returns

RenderFragment

GetVisibleColumns()

获得当前可见列集合

public IEnumerable<ITableColumn> GetVisibleColumns()

Returns

IEnumerable<ITableColumn>

HeaderCheckState()

获得 表头行是否选中状态

protected CheckboxState HeaderCheckState()

Returns

CheckboxState

InternalToggleLoading(bool)

显示/隐藏 Loading 遮罩

protected ValueTask InternalToggleLoading(bool state)

Parameters

state bool

true 时显示，false 时隐藏

Returns

ValueTask

InvokeInitAsync()

call JavaScript method

protected override Task InvokeInitAsync()

Returns

Task

LoopQueryAsync()

周期性查询方法

protected Task LoopQueryAsync()

Returns

Task

OnAfterRenderAsync(bool)

OnAfterRenderAsync 方法

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnCheck(CheckboxState, TItem)

点击选择复选框时触发此方法

protected Task OnCheck(CheckboxState state, TItem val)

Parameters

state CheckboxState

val TItem

Returns

Task

OnClickCardView()

protected void OnClickCardView()

OnClickHeader(ITableColumn)

点击列进行排序方法

protected Func<Task> OnClickHeader(ITableColumn col)

Parameters

col ITableColumn

Returns

Func<Task>

OnClickRefreshAsync()

刷新按钮回调方法

protected Task OnClickRefreshAsync()

Returns

Task

OnHeaderCheck(CheckboxState, TItem)

点击 Header 选择复选框时触发此方法

protected virtual Task OnHeaderCheck(CheckboxState state, TItem val)

Parameters

state CheckboxState

val TItem

Returns

Task

OnInitialized()

OnInitialized 方法

protected override void OnInitialized()

OnInitializedAsync()

OnInitializedAsync 方法

protected override Task OnInitializedAsync()

Returns

Task

OnPageItemsValueChanged(int)

每页记录条数变化是调用此方法

protected Task OnPageItemsValueChanged(int pageItems)

Parameters

pageItems int

Returns

Task

OnPageLinkClick(int)

点击页码调用此方法

protected Task OnPageLinkClick(int pageIndex)

Parameters

pageIndex int

Returns

Task

OnParametersSet()

OnParametersSet 方法

protected override void OnParametersSet()

QueryAsync(int?)

查询按钮调用此方法 参数 pageIndex 默认值 null 保持上次页码 第一页页码为 1

public Task QueryAsync(int? pageIndex = null)

Parameters

pageIndex int?

Returns

Task

QueryData()

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

protected Task QueryData()

Returns

Task

RenderCell(ITableColumn, TItem, ItemChangedType)

渲染单元格方法

protected RenderFragment RenderCell(ITableColumn col, TItem item, ItemChangedType changedType)

Parameters

col ITableColumn

item TItem

changedType ItemChangedType

Returns

RenderFragment

RenderExcelCell(ITableColumn, TItem, ItemChangedType)

渲染 Excel 单元格方法

protected RenderFragment RenderExcelCell(ITableColumn col, TItem item, ItemChangedType changedType)

Parameters

col ITableColumn

item TItem

changedType ItemChangedType

Returns

RenderFragment

ResetFilters()

Reset all Columns Filter

public Task ResetFilters()

Returns

Task

ResetSearchClick()

重置查询方法

protected Task ResetSearchClick()

Returns

Task

ResetSortAsync()

Reset all Columns Sort

public Task ResetSortAsync()

Returns

Task

ResetVisibleColumns(IEnumerable<ColumnVisibleItem>)

设置 列可见方法

public void ResetVisibleColumns(IEnumerable<ColumnVisibleItem> columns)

Parameters

columns IEnumerable<ColumnVisibleItem>

ResizeColumnCallback(int, float)

设置列宽方法 由 JavaScript 脚本调用

[JSInvokable]
public Task ResizeColumnCallback(int index, float width)

Parameters

index int

width float

Returns

Task

RowCheckState(TItem)

获得 当前行是否被选中

protected CheckboxState RowCheckState(TItem item)

Parameters

item TItem

Returns

CheckboxState

SaveAsync(EditContext, ItemChangedType)

保存数据

protected Task SaveAsync(EditContext context, ItemChangedType changedType)

Parameters

context EditContext

changedType ItemChangedType

Returns

Task

SaveModelAsync(EditContext, ItemChangedType)

保存数据方法

protected Task<bool> SaveModelAsync(EditContext context, ItemChangedType changedType)

Parameters

context EditContext

changedType ItemChangedType

Returns

Task<bool>

SearchClick()

查询方法

protected Task SearchClick()

Returns

Task

ShowEditDialog(ItemChangedType)

弹出编辑对话框方法

protected Task ShowEditDialog(ItemChangedType changedType)

Parameters

changedType ItemChangedType

Returns

Task

ShowEditDrawer(ItemChangedType)

弹出编辑抽屉方法

protected Task ShowEditDrawer(ItemChangedType changedType)

Parameters

changedType ItemChangedType

Returns

Task

ShowSearchDialog()

高级查询按钮点击时调用此方法

protected Task ShowSearchDialog()

Returns

Task

ToggleLoading(bool)

显示/隐藏 Loading 遮罩

public ValueTask ToggleLoading(bool state)

Parameters

state bool

true 时显示，false 时隐藏

Returns

ValueTask

ToggleTreeRow(TItem)

展开收缩树形数据节点方法

protected Func<Task> ToggleTreeRow(TItem item)

Parameters

item TItem

Returns

Func<Task>