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.v20.1.dll

Declaration

public string GetGroupSummaryDisplayText(
    int rowHandle,
    GridGroupSummaryItem summaryItem
)
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.

See Also