GridItemsProviderRequest<TGridItem> Struct

Definition

Namespace:

Microsoft.AspNetCore.Components.QuickGrid

Assembly:

Microsoft.AspNetCore.Components.QuickGrid.dll

Package:

Microsoft.AspNetCore.Components.QuickGrid v9.0.0

Source:

GridItemsProviderRequest.cs

Parameters for data to be supplied by a QuickGrid<TGridItem>'s ItemsProvider.

public readonly struct GridItemsProviderRequest<TGridItem>

type GridItemsProviderRequest<'GridItem> = struct

Public Structure GridItemsProviderRequest(Of TGridItem)

Type Parameters

TGridItem

The type of data represented by each row in the grid.

Inheritance

ValueType

GridItemsProviderRequest<TGridItem>

Properties

CancellationToken	A token that indicates if the request should be cancelled.
Count	If set, the maximum number of items to be supplied. If not set, the maximum number is unlimited.
SortByAscending	Specifies the current sort direction. Rather than inferring the sort rules manually, you should normally call either ApplySorting(IQueryable<TGridItem>) or GetSortByProperties(), since they also account for SortByColumn and SortByAscending automatically.
SortByColumn	Specifies which column represents the sort order. Rather than inferring the sort rules manually, you should normally call either ApplySorting(IQueryable<TGridItem>) or GetSortByProperties(), since they also account for SortByColumn and SortByAscending automatically.
StartIndex	The zero-based index of the first item to be supplied.

Methods

ApplySorting(IQueryable<TGridItem>)	Applies the request's sorting rules to the supplied IQueryable<T>.
GetSortByProperties()	Produces a collection of (property name, direction) pairs representing the sorting rules.