Поделиться через


QuickGrid<TGridItem> Класс

Определение

Компонент, отображающий сетку.

[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

Тип данных, представленных каждой строкой в сетке.

Наследование
QuickGrid<TGridItem>
Атрибуты
Реализации

Конструкторы

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 или IQueryable, производных от него.

Необходимо указать либо Items, либо ItemsProvider, но не оба.

ItemSize

Это применимо только при использовании Virtualize. Он определяет ожидаемую высоту в пикселях для каждой строки, что позволяет механизму виртуализации получить правильное количество элементов для сопоставления размера дисплея и обеспечить точную прокрутку.

ItemsProvider

Обратный вызов, предоставляющий данные для сетки.

Необходимо указать либо Items, либо ItemsProvider, но не оба.

OverscanCount

Это применимо только при использовании Virtualize. Он определяет, сколько дополнительных элементов будет отображаться до и после видимого региона, чтобы уменьшить частоту отрисовки во время прокрутки. Хотя более высокие значения могут повысить плавность прокрутки, отрисовка дополнительных элементов вне экрана, они также могут увеличить время начальной загрузки. Рекомендуется найти баланс на основе размера набора данных и требований к пользовательскому интерфейсу. Значение по умолчанию — 3.

Pagination

При необходимости связывает этот экземпляр QuickGrid<TGridItem> с моделью PaginationState, что приводит к выборке сетки и отрисовке только текущей страницы данных.

Обычно это используется вместе с компонентом Paginator или другой логикой пользовательского интерфейса, которая отображает и обновляет предоставленный экземпляр PaginationState.

RendererInfo

Возвращает RendererInfo, на котором выполняется компонент.

(Унаследовано от ComponentBase)
Theme

Имя темы с значением по умолчанию "default". Это влияет на то, какие правила стилизации соответствуют таблице.

Virtualize

Если значение true, сетка будет отображаться с помощью виртуализации. Обычно это используется в сочетании с прокруткой и приводит к тому, что сетка извлекает и отрисовывает только данные вокруг текущего окна просмотра прокрутки. Это может значительно повысить производительность при прокрутке больших наборов данных.

Если вы используете Virtualize, необходимо указать значение для ItemSize и убедиться, что каждая строка отображается с одинаковой высотой константы.

Как правило, предпочтительнее не использовать Virtualize, если объем отрисовываемых данных мал или используется разбиение на страницы.

Методы

BuildRenderTree(RenderTreeBuilder)

Компонент, отображающий сетку.

DispatchExceptionAsync(Exception)

Обрабатывает предоставленный exception как создаваемый этим компонентом. Это приведет к переходу заключающей границы ошибки в состояние сбоя. Если границы ошибок не заключены, он будет рассматриваться как исключение из заключиющего отрисовщика.

Это полезно, если исключение возникает за пределами методов жизненного цикла компонента, но вы хотите обработать его так же, как исключение из метода жизненного цикла компонента.

(Унаследовано от ComponentBase)
DisposeAsync()

Компонент, отображающий сетку.

InvokeAsync(Action)

Выполняет предоставленный рабочий элемент в контексте синхронизации связанного отрисовщика.

(Унаследовано от ComponentBase)
InvokeAsync(Func<Task>)

Выполняет предоставленный рабочий элемент в контексте синхронизации связанного отрисовщика.

(Унаследовано от ComponentBase)
OnAfterRender(Boolean)

Метод вызывается после каждого запуска компонента в интерактивном режиме, а пользовательский интерфейс завершил обновление (например, после добавления элементов в браузер DOM). Все поля ElementReference будут заполнены по времени выполнения.

Этот метод не вызывается во время предварительной отрисовки или отрисовки на стороне сервера, так как эти процессы не подключены к DOM в динамическом браузере и уже завершены до обновления DOM.

(Унаследовано от ComponentBase)
OnAfterRenderAsync(Boolean)

Метод вызывается после каждого отрисовки компонента в интерактивном режиме, и пользовательский интерфейс завершил обновление (например, после добавления элементов в браузер DOM). Все поля ElementReference будут заполнены по времени выполнения.

Этот метод не вызывается во время предварительной отрисовки или отрисовки на стороне сервера, так как эти процессы не подключены к DOM в динамическом браузере и уже завершены до обновления DOM.

Обратите внимание, что компонент не выполняет автоматическую отрисовку после завершения любого возвращаемого Task, так как это приведет к бесконечному циклу отрисовки.

OnInitialized()

Метод вызывается, когда компонент готов к запуску, получив свои начальные параметры от родительского элемента в дереве отрисовки.

(Унаследовано от ComponentBase)
OnInitializedAsync()

Метод вызывается, когда компонент готов к запуску, получив свои начальные параметры от родительского элемента в дереве отрисовки.

Переопределите этот метод, если вы будете выполнять асинхронную операцию и хотите, чтобы компонент обновлялся после завершения этой операции.

(Унаследовано от ComponentBase)
OnParametersSet()

Метод вызывается, когда компонент получил параметры от родительского элемента в дереве отрисовки, а входящие значения были назначены свойствам.

(Унаследовано от ComponentBase)
OnParametersSetAsync()

Метод вызывается, когда компонент получил параметры от родительского элемента в дереве отрисовки, а входящие значения были назначены свойствам.

RefreshDataAsync()

Указывает сетке повторно получить и отобразить текущие данные из предоставленного источника данных (Items или ItemsProvider).

SetParametersAsync(ParameterView)

Задает параметры, предоставляемые родительским элементом компонента в дереве отрисовки.

(Унаследовано от ComponentBase)
ShouldRender()

Возвращает флаг, указывающий, должен ли компонент отображаться.

(Унаследовано от ComponentBase)
ShowColumnOptionsAsync(ColumnBase<TGridItem>)

Отображает пользовательский интерфейс ColumnOptions для указанного столбца, закрывая любой другой пользовательский интерфейс параметров столбца, отображаемый ранее.

SortByColumnAsync(ColumnBase<TGridItem>, SortDirection)

Задает текущий столбец сортировки сетки указанным column.

StateHasChanged()

Уведомляет компонент о том, что его состояние изменилось. Если применимо, это приведет к повторной отрисовки компонента.

(Унаследовано от ComponentBase)

Явные реализации интерфейса

IComponent.Attach(RenderHandle)

Компонент, отображающий сетку.

(Унаследовано от ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()

Компонент, отображающий сетку.

(Унаследовано от ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)

Компонент, отображающий сетку.

(Унаследовано от ComponentBase)

Применяется к