GridView.GetGroupSummaryValues(Int32) Method

Returns summary values calculated for a particular group.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public virtual Hashtable GetGroupSummaryValues(
    int rowHandle
)

VB.NET

Public Overridable Function GetGroupSummaryValues(
    rowHandle As Integer
) As Hashtable

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the desired group by the corresponding group row handle.

Returns

Type	Description
Hashtable	A Hashtable object containing summary values calculated for a particular group.

Remarks

Key values of the returned hashtable are summary items (GridGroupSummaryItem objects). Values are the summary values calculated using the corresponding summary item’s settings. Thus, you can use index notation to access a particular summary item’s value. The desired summary item should be specified as the index parameter.

The summary text displayed within a particular group row can be obtained using the GridView.GetGroupSummaryText method. To determine the summary text displayed within a particular group footer cell, use the GridView.GetRowFooterCellText method.

Please refer to the Working with Summaries in Code. Custom Summaries topic for additional information.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetGroupSummaryValues member must not be invoked for these Views. The GetGroupSummaryValues member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetGroupSummaryValues(Int32) method.

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#

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/CS/GroupRowSummaryHelper.cs#L44

{
    Hashtable values = view.GetGroupSummaryValues(e.RowHandle);
    foreach (GridGroupSummaryItem item in items)

how-to-show-multiple-group-summary-items-in-the-same-group-footer-cell-in-bandedgridview-e4900/CS/MyGridCtrl/MyBandedGridViewInfo.cs#L34

rowHandle = rowHandle >= 0 ? -1 : rowHandle;
var groupSummary = View.GetGroupSummaryValues(rowHandle);
var myGroupSummaryList = new List<DictionaryEntry>();

how-to-show-multiple-group-summary-values-in-the-same-group-footer-cell-e3607/CS/MultiGroupSummary/MyGridControl/MyGridViewInfo.cs#L35

rowHandle = rowHandle >= 0 ? -1 : rowHandle;
var groupSummary = View.GetGroupSummaryValues(rowHandle);
var myGroupSummaryList = new List<DictionaryEntry>();

VB.NET

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/VB/GroupRowSummaryHelper.vb#L40

Public Sub DrawSummaryValues(ByVal e As RowObjectCustomDrawEventArgs, ByVal view As GridView, ByVal items As ArrayList)
    Dim values As Hashtable = view.GetGroupSummaryValues(e.RowHandle)
    For Each item As GridGroupSummaryItem In items

how-to-show-multiple-group-summary-items-in-the-same-group-footer-cell-in-bandedgridview-e4900/VB/MyGridCtrl/MyBandedGridViewInfo.vb#L36

rowHandle = If(rowHandle >= 0, -1, rowHandle)
Dim groupSummary = View.GetGroupSummaryValues(rowHandle)
Dim myGroupSummaryList = New List(Of DictionaryEntry)()

how-to-show-multiple-group-summary-values-in-the-same-group-footer-cell-e3607/VB/MultiGroupSummary/MyGridControl/MyGridViewInfo.vb#L37

rowHandle = If(rowHandle >= 0, -1, rowHandle)
Dim groupSummary = View.GetGroupSummaryValues(rowHandle)
Dim myGroupSummaryList = New List(Of DictionaryEntry)()