GridView.GetGroupSummaryDisplayText(Int32, GridGroupSummaryItem) Method

Returns the text representation of the specified group summary‘s value for a specific data group.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public string GetGroupSummaryDisplayText(
    int rowHandle,
    GridGroupSummaryItem summaryItem
)

VB.NET

Public Function GetGroupSummaryDisplayText(
    rowHandle As Integer,
    summaryItem As GridGroupSummaryItem
) As String

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
String	A string representing the group summary’s display text.

Remarks

A group summary’s value for a specific data group can be retrieved via the GridView.GetGroupSummaryValue method. The GetGroupSummaryDisplayText method formats the summary’s value according to the summary item’s format specified by the GridSummaryItem.DisplayFormat property.

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 GetGroupSummaryDisplayText member must not be invoked for these Views. The GetGroupSummaryDisplayText 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 GetGroupSummaryDisplayText(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-conditionally-hide-summaries-in-group-rows-e1354/CS/ConditionallyHideSumsInGroupRows/Form1.cs#L44

}
string summaryText = gridView1.GetGroupSummaryDisplayText(e.RowHandle, summary);
info.GroupText += summaryText;

VB.NET

how-to-conditionally-hide-summaries-in-group-rows-e1354/VB/ConditionallyHideSumsInGroupRows/Form1.vb#L44

End Select
Dim summaryText As String = gridView1.GetGroupSummaryDisplayText(e.RowHandle, summary)
info.GroupText += summaryText