GridView.GetGroupSummaryValue(Int32, GridGroupSummaryItem) Method

Returns the value of a specific group summary for a specific data group.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public object GetGroupSummaryValue(
    int rowHandle,
    GridGroupSummaryItem summaryItem
)

VB.NET

Public Function GetGroupSummaryValue(
    rowHandle As Integer,
    summaryItem As GridGroupSummaryItem
) As Object

Parameters

Name	Type	Description
rowHandle	Int32	The handle of the group row which contains the data rows against which the summary is calculated.
summaryItem	GridGroupSummaryItem	A GridGroupSummaryItem object identifying the required group summary.

Returns

Type	Description
Object	An object representing the specified group summary’s value.

Remarks

To get the group summary’s display text the GridView.GetGroupSummaryDisplayText method can be used.

Refer to the Working with Summaries in Code. Custom Summaries document for more information on how summary values can be accessed.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetGroupSummaryValue member must not be invoked for these Views. The GetGroupSummaryValue 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 snippet (auto-collected from DevExpress Examples) contains a reference to the GetGroupSummaryValue(Int32, GridGroupSummaryItem) 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-separately-calculate-a-group-summary-for-a-particular-group-row-e383/CS/Form1.cs#L75

if (e.RowHandle % 2 == 0)
    e.Info.DisplayText = string.Format("Total: {0}", view.GetGroupSummaryValue(e.RowHandle, (GridGroupSummaryItem)view.GroupSummary[0]));
else

VB.NET

how-to-separately-calculate-a-group-summary-for-a-particular-group-row-e383/VB/Form1.vb#L76

If e.RowHandle Mod 2 = 0 Then
    e.Info.DisplayText = String.Format("Total: {0}", view.GetGroupSummaryValue(e.RowHandle, CType(view.GroupSummary(0), GridGroupSummaryItem)))
Else