Class GridLoadEventArgs<TValue>

Provides information about an event-driven grid data request and enables the event handler to return the requested data.

Inheritance

object

GridEventBaseArgs

GridLoadEventArgs<TValue>

Inherited Members

GridEventBaseArgs.PreventRender

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Grids

Assembly: Syncfusion.Blazor.Grids.dll

Syntax

public class GridLoadEventArgs<TValue> : GridEventBaseArgs

Type Parameters

Name	Description
TValue	The type of data displayed in the grid.

Remarks

Instances of this class are supplied to the OnDataLoad event whenever the grid requires data.

The Request property contains the paging, filtering, sorting, searching, grouping, and aggregate metadata associated with the current operation.

Populate Result with the records to display. When total record information is requested, populate Count. When aggregate values are requested from the data source, populate AggregatesResult.

Constructors

GridLoadEventArgs()

Declaration

public GridLoadEventArgs()

Properties

AggregatesResult

Gets or sets the aggregate values returned for the current data request.

Declaration

[JsonIgnore]
public IDictionary<string, object>? AggregatesResult { get; set; }

Property Value

Type	Description
IDictionary<string, object>	An IDictionary<TKey, TValue> containing aggregate results, or null when no aggregate values are returned.

Remarks

Populate this property when the grid requests aggregate values as part of the event-driven data binding process.

The aggregate results should correspond to the aggregate definitions provided in Aggregates.

Count

Gets or sets the total number of records that match the current data request.

Declaration

[JsonIgnore]
public int Count { get; set; }

Property Value

Type	Description
int	An int representing the total number of matching records. The default value is 0.

Remarks

Populate this property when the grid requires the total record count for operations such as paging and virtual scrolling.

The value represents the total number of records that satisfy the current request criteria and is not limited by the requested page size.

Request

Gets or sets the data request information associated with the current grid operation.

Declaration

public DataRequest Request { get; set; }

Property Value

Type	Description
DataRequest	A DataRequest instance containing the paging, filtering, sorting, searching, grouping, selection, expansion, and aggregate metadata requested by the grid.

Remarks

Use this property to determine which records should be retrieved from the underlying data source. The request reflects the current state of the grid and should be used to construct queries against custom services, APIs, repositories, or other external data sources.

Result

Gets or sets the records returned for the current data request.

Declaration

[JsonIgnore]
public IEnumerable? Result { get; set; }

Property Value

Type	Description
IEnumerable	An IEnumerable containing the records that satisfy the current request, or null when no records are returned.

Remarks

Populate this property in the OnDataLoad event handler with the records that should be displayed by the grid.

The returned data should reflect the request metadata provided through Request, including paging, filtering, sorting, searching, and grouping operations.