Back to Devexpress

GroupSummarySortInfoCollection.Add(GridSummaryItem, ColumnSortOrder, GridColumn) Method

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-groupsummarysortinfocollection-dot-add-x28-devexpress-dot-xtragrid-dot-gridsummaryitem-devexpress-dot-data-dot-columnsortorder-devexpress-dot-xtragrid-dot-columns-dot-gridcolumn-x29.md

latest3.2 KB
Original Source

GroupSummarySortInfoCollection.Add(GridSummaryItem, ColumnSortOrder, GridColumn) Method

Initializes a new instance of the GroupSummarySortInfo class with the specified parameters and appends it to the collection.

Namespace : DevExpress.XtraGrid.Columns

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
public GroupSummarySortInfo Add(
    GridSummaryItem summary,
    ColumnSortOrder sortOrder,
    GridColumn groupColumn
)
vb
Public Function Add(
    summary As GridSummaryItem,
    sortOrder As ColumnSortOrder,
    groupColumn As GridColumn
) As GroupSummarySortInfo

Parameters

NameTypeDescription
summaryGridSummaryItem

A GridSummaryItem object representing a summary item used to calculate summary values for groups of rows. If null ( Nothing in Visual Basic) an exception is raised.

| | sortOrder | ColumnSortOrder |

A ColumnSortOrder enumeration value specifying the sort order.

| | groupColumn | GridColumn |

A GridColumn object which defines the nesting level of the group whose rows will be sorted by the summary values.

|

Returns

TypeDescription
GroupSummarySortInfo

The GroupSummarySortInfo object added to the collection. null ( Nothing in Visual Basic) if the View is not grouped by the specified column’s values.

|

See Also

AddRange(GroupSummarySortInfo[])

ClearAndAddRange(GroupSummarySortInfo[])

GroupSummarySortInfoCollection Class

GroupSummarySortInfoCollection Members

DevExpress.XtraGrid.Columns Namespace