GridViewCustomBindingDataArgsBase.Data Property

Gets or sets a list of currently requested model characteristics (depending upon which delegated method is being implemented, it can be a list of data rows, or a list of grouping information objects, or a list of calculated summary values).

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public IEnumerable Data { get; set; }

VB.NET

Public Property Data As IEnumerable

Property Value

Type	Description
IEnumerable	An object supporting the IEnumerable interface and containing a list of values currently requested to populate the grid’s custom view model.

Remarks

The Data property is the main property that must be set when implementing different custom binding method delegates. Refer to Implementation of Typed Method Delegates to learn more.

The following table lists which characteristics need to be defined via the Data property for specific delegate types.

Delegate Type	Characteristics to Return
GridViewCustomBindingGetDataHandler	A list of the requested data rows to be returned from a custom model. Starting position is specified by the GridViewCustomBindingGetDataArgs.StartDataRowIndex property, and the number of rows to return is defined by the GridViewCustomBindingGetDataArgs.DataRowCount property.
GridViewCustomBindingGetSummaryValuesHandler	A list of summary values calculated for each summary item within the GridViewCustomBindingGetSummaryValuesArgs.SummaryItems collection.
GridViewCustomBindingGetGroupingInfoHandler	A list that contains grouping information (the group value - key, and the number of data rows within the group - count) on group rows relating to the processed grouping operation performed on a column specified by GridViewCustomBindingGetGroupingInfoArgs.FieldName property.
GridViewCustomBindingGetUniqueHeaderFilterValuesHandler	A list of unique values from a data field specified by the GridViewCustomBindingGetUniqueHeaderFilterValuesArgs.FieldName property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Data property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-mvc-grid-custom-binding-and-xpo/CS/XPCustomBindingExample/XPO/XpoBindingHandlers.cs#L35

    data.TopReturnedObjects = e.DataRowCount;
    e.Data = data;
}

asp-net-mvc-grid-master-detail-and-custom-binding/CS/Example/Models/DetailCustomBindingModel.cs#L16

public static void GetData(GridViewCustomBindingGetDataArgs e) {
    e.Data = Model
        .ApplyFilter(e.State.FilterExpression)

asp-net-mvc-grid-custom-binding-with-sorting-paging/CS/Sample/Models/CustomBindingModel.cs#L18

public static void GetData(GridViewCustomBindingGetDataArgs e) {
    e.Data = Model
        .ApplySorting(e.State.SortedColumns)

VB.NET

asp-net-mvc-grid-custom-binding-and-xpo/VB/XPCustomBindingExample/XPO/XpoBindingHandlers.vb#L35

    data.TopReturnedObjects = e.DataRowCount
    e.Data = data
End Sub

asp-net-mvc-grid-master-detail-and-custom-binding/VB/Example/Models/DetailCustomBindingModel.VB#L19

Public Shared Sub GetData(ByVal e As GridViewCustomBindingGetDataArgs)
    e.Data = Model.ApplyFilter(e.State.FilterExpression).ApplySorting(e.State.SortedColumns).Skip(e.StartDataRowIndex).Take(e.DataRowCount)
End Sub

asp-net-mvc-grid-custom-binding-with-sorting-paging/VB/Sample/Models/CustomBindingModel.vb#L24

Public Shared Sub GetData(ByVal e As GridViewCustomBindingGetDataArgs)
    e.Data = Model.ApplySorting(e.State.SortedColumns).Skip(e.StartDataRowIndex).Take(e.DataRowCount)
End Sub