QuickGrid<TGridItem> 类

定义

命名空间:

Microsoft.AspNetCore.Components.QuickGrid

程序集:

Microsoft.AspNetCore.Components.QuickGrid.dll

包:

Microsoft.AspNetCore.Components.QuickGrid v8.0.0

显示网格的组件。

[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable

[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
type QuickGrid<'GridItem> = class
    inherit ComponentBase
    interface IAsyncDisposable

Public Class QuickGrid(Of TGridItem)
Inherits ComponentBase
Implements IAsyncDisposable

类型参数

TGridItem

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

继承

Object

ComponentBase

QuickGrid<TGridItem>

属性

CascadingTypeParameterAttribute

实现

IAsyncDisposable

构造函数

QuickGrid<TGridItem>()

构造 的 QuickGrid<TGridItem>实例。

属性

AdditionalAttributes	获取或设置将应用于所创建元素的其他特性的集合。
ChildContent	定义此实例的子组件。 例如，可以通过添加派生自基类的组件来 ColumnBase<TGridItem> 定义列。
Class	可选的 CSS 类名称。 如果给定，则此属性将包含在呈现表的类属性中。
ItemKey	（可选）在每个呈现的行上为 @key 定义值。 通常，这应该用于为每个数据项指定唯一标识符，例如主键值。 这允许网格根据行元素和数据项的唯一标识符保留关联，即使 TGridItem 实例替换为新的副本 (，例如，在对基础数据存储) 进行新查询之后也是如此。 如果未设置， @key 将是 TGridItem 实例本身。
Items	网格的可查询数据源。 这可能是使用 AsQueryable(IEnumerable) 扩展方法转换为可查询的内存中数据，也可以是 EntityFramework DataSet 或 IQueryable 派生自它的 。 应提供 或 ItemsProvider，但不能同时提供Items两者。
ItemSize	仅当使用 Virtualize时才适用。 它定义了每行的预期高度（以像素为单位），使虚拟化机制能够提取正确数量的项，以匹配显示大小并确保准确的滚动。
ItemsProvider	为 rid 提供数据的回调。 应提供 或 ItemsProvider，但不能同时提供Items两者。
Pagination	（可选）将此 QuickGrid<TGridItem> 实例与 PaginationState 模型链接，使网格仅提取和呈现当前页的数据。 这通常与 Paginator 组件或显示和更新提供的 PaginationState 实例的一些其他 UI 逻辑结合使用。
Theme	主题名称，默认值为“default”。 这会影响哪些样式规则与表匹配。
Virtualize	如果为 true，将使用虚拟化呈现网格。 这通常与滚动结合使用，导致网格仅提取和呈现当前滚动视区周围的数据。 这可以极大地提高滚动浏览大型数据集时的性能。 如果使用 Virtualize，则应为 ItemSize 提供值，并且必须确保每行以相同的常量高度呈现。 一般情况下，如果呈现的数据量较小，或者使用的是分页，最好不要 Virtualize 使用 。

方法

BuildRenderTree(RenderTreeBuilder)	显示网格的组件。
DispatchExceptionAsync(Exception)	将提供的 exception 视为由此组件引发的 。 这将导致封闭的 ErrorBoundary 转换为失败状态。 如果没有封闭的 ErrorBoundary，它将被视为封闭呈现器中的异常。 如果异常发生在组件生命周期方法之外，但你希望将其视为组件生命周期方法中的异常，则这非常有用。 (继承自 ComponentBase)
DisposeAsync()	显示网格的组件。
InvokeAsync(Action)	在关联的呈现器同步上下文中执行提供的工作项。 (继承自 ComponentBase)
InvokeAsync(Func<Task>)	在关联的呈现器同步上下文中执行提供的工作项。 (继承自 ComponentBase)
OnAfterRender(Boolean)	每次组件以交互方式呈现且 UI 完成更新 (（例如，在将元素添加到浏览器 DOM) 之后）之后调用的方法。 将在运行此字段时填充任何 ElementReference 字段。 在预呈现或服务器端呈现期间不会调用此方法，因为这些进程未附加到任何实时浏览器 DOM，并且已在更新 DOM 之前完成。 (继承自 ComponentBase)
OnAfterRenderAsync(Boolean)	每次以交互方式呈现组件且 UI 完成更新 (（例如，在将元素添加到浏览器 DOM) 之后）之后调用的方法。 将在运行此字段时填充任何 ElementReference 字段。 在预呈现或服务器端呈现期间不会调用此方法，因为这些进程未附加到任何实时浏览器 DOM，并且已在更新 DOM 之前完成。 请注意，组件不会在完成任何返回 Task的 后自动重新呈现，因为这将导致无限呈现循环。
OnInitialized()	从呈现树中的父组件接收了其初始参数后，在组件准备好启动时调用的方法。 (继承自 ComponentBase)
OnInitializedAsync()	从呈现树中的父组件接收了其初始参数后，在组件准备好启动时调用的方法。 如果要执行异步操作并希望组件在完成该操作时刷新，请重写此方法。 (继承自 ComponentBase)
OnParametersSet()	当组件从呈现树中的父级接收参数并将传入值分配给属性时调用的方法。 (继承自 ComponentBase)
OnParametersSetAsync()	当组件从呈现树中的父级接收参数并将传入值分配给属性时调用的方法。
RefreshDataAsync()	指示网格从提供的数据源重新提取和呈现当前数据， (Items 或 ItemsProvider) 。
SetParametersAsync(ParameterView)	设置组件父级在呈现树中提供的参数。 (继承自 ComponentBase)
ShouldRender()	返回一个标志，指示组件是否应呈现。 (继承自 ComponentBase)
ShowColumnOptionsAsync(ColumnBase<TGridItem>)	ColumnOptions显示指定列的 UI，关闭之前显示的任何其他列选项 UI。
SortByColumnAsync(ColumnBase<TGridItem>, SortDirection)	将网格的当前排序列设置为指定的 column。
StateHasChanged()	通知组件其状态已更改。 如果适用，这将导致重新呈现组件。 (继承自 ComponentBase)

显式接口实现

IComponent.Attach(RenderHandle)	显示网格的组件。 (继承自 ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()	显示网格的组件。 (继承自 ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)	显示网格的组件。 (继承自 ComponentBase)