QuickGrid<TGridItem> 类

定义

命名空间:

Microsoft.AspNetCore.Components.QuickGrid

程序集:

Microsoft.AspNetCore.Components.QuickGrid.dll

包:

Microsoft.AspNetCore.Components.QuickGrid v8.0.0

Source:

QuickGrid.razor

显示网格的组件。

[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	获取或设置将应用于所创建元素的其他属性的集合。
Assets	获取应用程序的 ResourceAssetCollection。 (继承自 ComponentBase)
AssignedRenderMode	获取分配给此组件的 IComponentRenderMode。 (继承自 ComponentBase)
ChildContent	定义此实例的子组件。 例如，可以通过添加派生自 ColumnBase<TGridItem> 基类的组件来定义列。
Class	可选的 CSS 类名称。 如果给定，则会将其包含在呈现表的类属性中。
ItemKey	（可选）为每个呈现的行定义 @key 的值。 通常，这应该用于为每个数据项指定唯一标识符，例如主键值。 这允许网格根据行元素和数据项的唯一标识符保留关联，即使 TGridItem 实例被新副本替换（例如，针对基础数据存储的新查询之后）。 如果未设置，@key 将是 TGridItem 实例本身。
Items	网格的可查询数据源。 这可能是使用 AsQueryable(IEnumerable) 扩展方法或 EntityFramework DataSet 或派生自它的 IQueryable 转换为可查询的内存中数据。 应提供 Items 或 ItemsProvider，但不应同时提供两者。
ItemSize	这仅适用于使用 Virtualize。 它为每个行定义预期的高度（以像素为单位），使虚拟化机制能够提取正确的项数以匹配显示大小并确保准确的滚动。
ItemsProvider	一个回调，用于为网格提供数据。 应提供 Items 或 ItemsProvider，但不应同时提供两者。
Pagination	（可选）将此 QuickGrid<TGridItem> 实例与 PaginationState 模型链接，导致网格仅提取和呈现数据的当前页。 这通常与 Paginator 组件或其他显示和更新提供的 PaginationState 实例的其他 UI 逻辑结合使用。
RendererInfo	获取运行组件的 RendererInfo。 (继承自 ComponentBase)
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)