Share via


ColumnBase<TGridItem> 类

定义

中列的 QuickGrid<TGridItem>抽象基类。

public abstract class ColumnBase<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase
type ColumnBase<'GridItem> = class
    inherit ComponentBase
Public MustInherit Class ColumnBase(Of TGridItem)
Inherits ComponentBase

类型参数

TGridItem

网格中每一行表示的数据类型。

继承
ColumnBase<TGridItem>
派生

构造函数

ColumnBase<TGridItem>()

构造 的 ColumnBase<TGridItem>实例。

属性

Align

如果指定,则控制此列的表标题和正文单元格的对齐方式。

Class

可选的 CSS 类名。 如果指定,则此列的表标题和正文单元格的类属性中会包含此属性。

ColumnOptions

如果指定,则指示此列具有此关联选项 UI。 默认情况下,用于显示此 UI 的按钮将包含在标题单元格中。

如果使用 HeaderTemplate ,则由该模板来呈现任何相关的“显示选项”UI 并调用网格 ShowColumnOptionsAsync(ColumnBase<TGridItem>) 的) 。

Grid

获取对封闭 QuickGrid<TGridItem>的 的引用。

HeaderContent

获取或设置 RenderFragment 将为此列的标题单元格呈现的 。 这允许派生组件更改标头输出。 但是,如果派生组件想要继续遵循该选项,则它们负责 HeaderTemplate 在该新输出中使用。

HeaderTemplate

此列标题单元格的可选模板。 如果未指定,则默认标头模板包括 Title 以及任何适用的排序指示器和选项按钮。

InitialSortDirection

指示要按哪个方向排序(如果 IsDefaultSortColumn 为 true)。

IsDefaultSortColumn

指示是否应默认对此列进行排序。

PlaceholderTemplate

如果指定,虚拟化网格将使用此模板来呈现尚未加载数据的单元格。

Sortable

指示数据是否应按此列进行排序。

默认值可能因列类型 (而异,例如, TemplateColumn<TGridItem> 如果指定了任何 SortBy 参数) ,则默认可排序。

SortBy

指定列的排序规则。

Title

列的标题文本。 如果未 HeaderTemplate 使用 ,则会自动呈现。

方法

BuildRenderTree(RenderTreeBuilder)

中列的 QuickGrid<TGridItem>抽象基类。

CellContent(RenderTreeBuilder, TGridItem)

由派生组件替代,为列的单元格提供呈现逻辑。

DispatchExceptionAsync(Exception)

将提供的 exception 视为由此组件引发的 。 这将导致封闭的 ErrorBoundary 转换为失败状态。 如果没有封闭的 ErrorBoundary,则将它视为封闭呈现器中的异常。

如果异常发生在组件生命周期方法之外,但你希望将其视为组件生命周期方法中的异常,这非常有用。

(继承自 ComponentBase)
InvokeAsync(Action)

在关联的呈现器同步上下文中执行提供的工作项。

(继承自 ComponentBase)
InvokeAsync(Func<Task>)

在关联的呈现器同步上下文中执行提供的工作项。

(继承自 ComponentBase)
IsSortableByDefault()

获取一个值,该值指示如果未为 Sortable 参数设置值,则此列是否应充当可排序。 除非为 true,否则 Sortable 默认行为不可排序。

派生组件可以重写此规则,以实现替代的默认可排序性规则。

OnAfterRender(Boolean)

每次组件以交互方式呈现且 UI 完成更新 ((例如,在元素添加到浏览器 DOM) 之后)之后调用的方法。 在运行此字段时,任何 ElementReference 字段都将填充。

在预呈现或服务器端呈现期间不会调用此方法,因为这些进程不会附加到任何实时浏览器 DOM,并且已在更新 DOM 之前完成。

(继承自 ComponentBase)
OnAfterRenderAsync(Boolean)

每次以交互方式呈现组件且 UI 完成更新 ((例如,在元素添加到浏览器 DOM) 之后)之后调用的方法。 在运行此字段时,任何 ElementReference 字段都将填充。

在预呈现或服务器端呈现期间不会调用此方法,因为这些进程不会附加到任何实时浏览器 DOM,并且已在更新 DOM 之前完成。

请注意,组件不会在返回 Task的任何 完成后自动重新呈现,因为这将导致无限呈现循环。

(继承自 ComponentBase)
OnInitialized()

在组件准备好启动时从呈现树中的父级接收其初始参数时调用的方法。

(继承自 ComponentBase)
OnInitializedAsync()

在组件准备好启动时从呈现树中的父级接收其初始参数时调用的方法。

如果要执行异步操作并希望组件在操作完成时刷新,请重写此方法。

(继承自 ComponentBase)
OnParametersSet()

当组件从呈现树中的父级接收参数,并且传入值已分配给属性时调用的方法。

(继承自 ComponentBase)
OnParametersSetAsync()

当组件从呈现树中的父级接收参数,并且传入值已分配给属性时调用的方法。

(继承自 ComponentBase)
SetParametersAsync(ParameterView)

设置组件父级在呈现树中提供的参数。

(继承自 ComponentBase)
ShouldRender()

返回一个标志,指示组件是否应呈现。

(继承自 ComponentBase)
StateHasChanged()

通知组件其状态已更改。 如果适用,这将导致组件重新呈现。

(继承自 ComponentBase)

显式接口实现

IComponent.Attach(RenderHandle)

中列的 QuickGrid<TGridItem>抽象基类。

(继承自 ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()

中列的 QuickGrid<TGridItem>抽象基类。

(继承自 ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)

中列的 QuickGrid<TGridItem>抽象基类。

(继承自 ComponentBase)

适用于