PropertyColumn<TGridItem,TProp> 类

定义

命名空间:

Microsoft.AspNetCore.Components.QuickGrid

程序集:

Microsoft.AspNetCore.Components.QuickGrid.dll

包:

Microsoft.AspNetCore.Components.QuickGrid v8.0.0

Source:

PropertyColumn.cs

表示单元格显示单个值的 QuickGrid<TGridItem> 列。

public class PropertyColumn<TGridItem,TProp> : Microsoft.AspNetCore.Components.QuickGrid.ColumnBase<TGridItem>

type PropertyColumn<'GridItem, 'Prop> = class
    inherit ColumnBase<'GridItem>

Public Class PropertyColumn(Of TGridItem, TProp)
Inherits ColumnBase(Of TGridItem)

类型参数

TGridItem

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

TProp

在列的单元格中显示的值的类型。

继承

Object

ComponentBase

ColumnBase<TGridItem>

PropertyColumn<TGridItem,TProp>

构造函数

PropertyColumn<TGridItem,TProp>()

表示单元格显示单个值的 QuickGrid<TGridItem> 列。

属性

Align	如果指定，则控制此列的表标题和正文单元格的理由。 (继承自 ColumnBase<TGridItem>)
Assets	获取应用程序的 ResourceAssetCollection。 (继承自 ComponentBase)
AssignedRenderMode	获取分配给此组件的 IComponentRenderMode。 (继承自 ComponentBase)
Class	可选的 CSS 类名称。 如果指定，则此列的表标题和正文单元格的类属性中包括此列。 (继承自 ColumnBase<TGridItem>)
ColumnOptions	如果指定，则指示此列具有此关联的选项 UI。 默认情况下，显示此 UI 的按钮将包含在标题单元格中。 如果使用 HeaderTemplate，则留给该模板，以呈现任何相关的“显示选项”UI 并调用网格的 ShowColumnOptionsAsync(ColumnBase<TGridItem>)）。 (继承自 ColumnBase<TGridItem>)
Format	（可选）指定值的格式字符串。 使用此方法需要 TProp 类型来实现 IFormattable。
Grid	获取对封闭 QuickGrid<TGridItem>的引用。 (继承自 ColumnBase<TGridItem>)
HeaderContent	获取或设置将为此列的标题单元格呈现的 RenderFragment。 这允许派生组件更改标头输出。 但是，如果派生组件想要继续遵循该选项，则派生组件负责在该新输出中使用 HeaderTemplate。 (继承自 ColumnBase<TGridItem>)
HeaderTemplate	此列标题单元格的可选模板。 如果未指定，则默认标头模板包括 Title 以及任何适用的排序指示器和选项按钮。 (继承自 ColumnBase<TGridItem>)
InitialSortDirection	指示 IsDefaultSortColumn 为 true 时要排序的方向。 (继承自 ColumnBase<TGridItem>)
IsDefaultSortColumn	指示是否应默认对此列进行排序。 (继承自 ColumnBase<TGridItem>)
PlaceholderTemplate	如果指定，虚拟化网格将使用此模板来呈现尚未加载其数据的单元格。 (继承自 ColumnBase<TGridItem>)
Property	定义要在此列的单元格中显示的值。
RendererInfo	获取运行组件的 RendererInfo。 (继承自 ComponentBase)
Sortable	指示数据是否应按此列进行排序。 默认值可能因列类型而异（例如，如果指定了任何 SortBy 参数，则默认可排序 TemplateColumn<TGridItem>）。 (继承自 ColumnBase<TGridItem>)
SortBy	指定列的排序规则。
Title	列的标题文本。 如果未使用 HeaderTemplate，则会自动呈现此项。 (继承自 ColumnBase<TGridItem>)

方法

BuildRenderTree(RenderTreeBuilder)	表示单元格显示单个值的 QuickGrid<TGridItem> 列。 (继承自 ColumnBase<TGridItem>)
CellContent(RenderTreeBuilder, TGridItem)	由派生组件重写，以提供列单元格的呈现逻辑。
DispatchExceptionAsync(Exception)	将提供的 exception 视为此组件引发的。 这将导致封闭的 ErrorBoundary 转换为失败状态。 如果没有封闭的 ErrorBoundary，它将被视为封闭呈现器中的异常。 如果异常发生在组件生命周期方法之外，但你希望将其视为组件生命周期方法中的异常，这非常有用。 (继承自 ComponentBase)
InvokeAsync(Action)	在关联的呈现器同步上下文上执行提供的工作项。 (继承自 ComponentBase)
InvokeAsync(Func<Task>)	在关联的呈现器同步上下文上执行提供的工作项。 (继承自 ComponentBase)
IsSortableByDefault()	获取一个值，该值指示如果未为 Sortable 参数设置任何值，则此列是否应充当可排序。 除非 Sortable 为 true，否则默认行为不可排序。 派生组件可能会重写此项，以实现替代的默认可排序性规则。 (继承自 ColumnBase<TGridItem>)
OnAfterRender(Boolean)	每次以交互方式呈现组件且 UI 完成更新（例如，元素添加到浏览器 DOM 后）后调用的方法。 在运行此字段时，将填充任何 ElementReference 字段。 此方法不会在预呈现或服务器端呈现期间调用，因为这些进程不会附加到任何实时浏览器 DOM，并且已在 DOM 更新之前完成。 (继承自 ComponentBase)
OnAfterRenderAsync(Boolean)	每次以交互方式呈现组件后调用的方法，UI 已完成更新（例如，元素添加到浏览器 DOM 之后）。 在运行此字段时，将填充任何 ElementReference 字段。 此方法不会在预呈现或服务器端呈现期间调用，因为这些进程不会附加到任何实时浏览器 DOM，并且已在 DOM 更新之前完成。 请注意，组件在完成任何返回 Task后不会自动重新呈现，因为这将导致无限呈现循环。 (继承自 ComponentBase)
OnInitialized()	组件准备好启动时调用的方法，从呈现树中的父级接收其初始参数。 (继承自 ComponentBase)
OnInitializedAsync()	组件准备好启动时调用的方法，从呈现树中的父级接收其初始参数。 如果要执行异步操作并希望组件在完成该操作时刷新，请重写此方法。 (继承自 ComponentBase)
OnParametersSet()	当组件从呈现树中的父级接收参数并且已将传入值分配给属性时调用的方法。
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)