Table of Contents

Class TableColumn<TItem, TType>

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

表头组件

public class TableColumn<TItem, TType> : BootstrapComponentBase, IComponent, IHandleAfterRender, IHandleEvent, ITableColumn, IEditorItem

Type Parameters

TItem

模型泛型

TType

绑定字段值类型

Inheritance
TableColumn<TItem, TType>
Implements
Inherited Members
Extension Methods

Constructors

TableColumn() 

public TableColumn()

Properties

Align

获得/设置 文字对齐方式 默认为 null 使用 Alignment.None

[Parameter]
public Alignment? Align { get; set; }

Property Value

Alignment?

Columns

获得/设置 Table 实例

[CascadingParameter]
protected IColumnCollection? Columns { get; set; }

Property Value

IColumnCollection

ComponentParameters

获得/设置 组件自定义类型参数集合 默认为 null

[Parameter]
public IEnumerable<KeyValuePair<string, object>>? ComponentParameters { get; set; }

Property Value

IEnumerable<KeyValuePair<string, object>>

ComponentType

获得/设置 组件类型 默认为 null

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

Property Value

Type

CssClass

获得/设置 列 td 自定义样式 默认为 null 未设置

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

Property Value

string

CustomSearch

获得/设置 自定义搜索逻辑

[Parameter]
public Func<ITableColumn, string?, SearchFilterAction>? CustomSearch { get; set; }

Property Value

Func<ITableColumn, string, SearchFilterAction>

DefaultSort

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

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

Property Value

bool

DefaultSortOrder

获得/设置 是否为默认排序规则 默认为 SortOrder.Unset

[Parameter]
public SortOrder DefaultSortOrder { get; set; }

Property Value

SortOrder

EditTemplate

获得/设置 编辑模板

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

Property Value

RenderFragment<TItem>

Editable

获得/设置 当前编辑项是否可编辑 默认为 true

[Parameter]
[Obsolete("已弃用，是否显示使用 Visible 参数，新建时使用 IsVisibleWhenAdd 编辑时使用 IsVisibleWhenEdit 只读使用 Readonly 参数，新建时使用 IsReadonlyWhenAdd 编辑时使用 IsReadonlyWhenEdit 参数; Discarded, use Visible parameter. IsVisibleWhenAdd should be used when creating a new one, and IsVisibleWhenEdit should be used when editing")]
public bool Editable { get; set; }

Property Value

bool

Field

获得/设置 数据绑定字段值

[Parameter]
public TType Field { get; set; }

Property Value

TType

FieldExpression

获得/设置 ValueExpression 表达式

[Parameter]
public Expression<Func<TType>>? FieldExpression { get; set; }

Property Value

Expression<Func<TType>>

FieldName

获得/设置 绑定类字段名称

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

Property Value

string

Filter

获得/设置 相关过滤器

public IFilter? Filter { get; set; }

Property Value

IFilter

FilterTemplate

获得/设置 过滤模板

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

Property Value

RenderFragment

Filterable

获得/设置 是否允许过滤数据 默认为 null

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

Property Value

bool?

Fixed

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

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

Property Value

bool

FormatString

获得/设置 格式化字符串 如时间类型设置 yyyy-MM-dd

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

Property Value

string

Formatter

获得/设置 列格式化回调委托

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

Property Value

Func<object, Task<string>>

GetTooltipTextCallback

获得/设置 鼠标悬停提示自定义内容回调委托 默认 null 使用当前值

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

Property Value

Func<object, Task<string>>

GroupName

获得/设置 当前属性分组 默认 null

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

Property Value

string

GroupOrder

获得/设置 当前属性分组排序 默认 0

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

Property Value

int

HeaderTemplate

获得/设置 表头模板

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

Property Value

RenderFragment<ITableColumn>

HeaderTextEllipsis

获得/设置 是否表头溢出时截断 默认 false 不截断 可配合 HeaderTextTooltip 使用 设置 HeaderTextWrap 为 true 时本参数不生效

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

Property Value

bool

HeaderTextTooltip

获得/设置 是否表头 Tooltip 内容

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

Property Value

string

HeaderTextWrap

获得/设置 是否表头允许折行 默认 false 不折行

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

Property Value

bool

Ignore

获得/设置 当前编辑项是否忽略 默认为 false 当设置为 true 时 UI 不生成此列

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

Property Value

bool?

IsMarkupString

获得/设置 是否为 MarkupString 默认 false

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

Property Value

bool

IsPopover

获得/设置 是否使用 Popover 渲染下拉框 默认 false

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

Property Value

bool

IsReadonlyWhenAdd

获得/设置 新建时此列只读 默认为 null 使用 Readonly 值

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

Property Value

bool?

IsReadonlyWhenEdit

获得/设置 编辑时此列只读 默认为 null 使用 Readonly 值

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

Property Value

bool?

IsVisibleWhenAdd

获得/设置 新建时是否此列显示 默认为 null 使用 Visible 值

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

Property Value

bool?

IsVisibleWhenEdit

获得/设置 编辑时是否此列显示 默认为 null 使用 Visible 值

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

Property Value

bool?

Items

获得/设置 额外数据源一般用于下拉框或者 CheckboxList 这种需要额外配置数据源组件使用

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

Property Value

IEnumerable<SelectedItem>

Lookup

获得/设置 字典数据源 常用于外键自动转换为名称操作

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

Property Value

IEnumerable<SelectedItem>

LookupServiceData

获得/设置 ILookupService 服务获取 Lookup 数据集合键值自定义数据，通过 LookupServiceKey 指定键值

[Parameter]
public object? LookupServiceData { get; set; }

Property Value

object

LookupServiceKey

获得/设置 ILookupService 服务获取 Lookup 数据集合键值 常用于外键自动转换为名称操作，可以通过 LookupServiceData 传递自定义数据

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

Property Value

string

LookupStringComparison

获得/设置 字典数据源字符串比较规则 默认 OrdinalIgnoreCase 大小写不敏感

[Parameter]
public StringComparison LookupStringComparison { get; set; }

Property Value

StringComparison

OnCellRender

获得/设置 单元格回调方法

[Parameter]
public Action<TableCellArgs>? OnCellRender { get; set; }

Property Value

Action<TableCellArgs>

Order

获得/设置 显示顺序

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

Property Value

int

PlaceHolder

获得/设置 placeholder 文本 默认为 null

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

Property Value

string

PropertyType

获得/设置 绑定列类型

public Type? PropertyType { get; set; }

Property Value

Type

Readonly

获得/设置 当前编辑项是否只读 默认为 false

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

Property Value

bool?

Rows

获得/设置 Textarea 行数 默认为 0

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

Property Value

int

SearchTemplate

获得/设置 搜索模板

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

Property Value

RenderFragment<TItem>

Searchable

获得/设置 是否参与搜索 默认为 null

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

Property Value

bool?

ShowCopyColumn

获得/设置 是否可以拷贝列 默认 null 不可以

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

Property Value

bool?

ShowHeaderTooltip

获得/设置 是否表头显示 Tooltip 默认 false 不显示 可配合 HeaderTextEllipsis 使用 设置 HeaderTextWrap 为 true 时本参数不生效

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

Property Value

bool

ShowLabelTooltip

获得/设置 是否显示标签 Tooltip 多用于标签文字过长导致裁减时使用 默认 null

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

Property Value

bool?

ShowSearchWhenSelect

获得/设置 字段数据源下拉框是否显示搜索栏 默认 false 不显示

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

Property Value

bool

ShowTips

获得/设置 字段鼠标悬停提示

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

Property Value

bool?

ShownWithBreakPoint

获得/设置 显示节点阈值 默认值 BreakPoint.None 未设置

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

Property Value

BreakPoint

SkipValidate

获得/设置 是否不进行验证 默认为 false

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

Property Value

bool

Sortable

获得/设置 是否允许排序 默认为 null

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

Property Value

bool?

Step

获得/设置 步长 默认为 null 设置 any 时忽略检查

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

Property Value

string

Template

获得/设置 显示模板

[Parameter]
public RenderFragment<TableColumnContext<TItem, TType>>? Template { get; set; }

Property Value

RenderFragment<TableColumnContext<TItem, TType>>

Text

获得/设置 表头显示文字

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

Property Value

string

TextEllipsis

获得/设置 本列文本超出省略 默认为 null

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

Property Value

bool?

TextWrap

获得/设置 本列是否允许换行 默认为 null

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

Property Value

bool?

ToolboxTemplate

获得/设置 列工具栏模板 默认 null

[Parameter]
public RenderFragment<ITableColumn>? ToolboxTemplate { get; set; }

Property Value

RenderFragment<ITableColumn>

ValidateRules

获得/设置 自定义验证集合

[Parameter]
public List<IValidator>? ValidateRules { get; set; }

Property Value

List<IValidator>

Visible

获得/设置 当前编辑项是否显示 默认为 null 未设置时为 true

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

Property Value

bool?

Width

获得/设置 列宽 默认为 auto

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

Property Value

int?

Methods

GetDisplayName()

获取绑定字段显示名称方法

public virtual string GetDisplayName()

Returns

string

GetFieldName()

获取绑定字段信息方法

public string GetFieldName()

Returns

string

OnInitialized()

组件初始化方法

protected override void OnInitialized()