Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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.v24.2.dll

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

#Declaration

public string GetGroupSummaryDisplayText(
    int rowHandle,
    GridGroupSummaryItem summaryItem
)

#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 Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

The following code snippets (auto-collected from DevExpress Examples) contain references 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.

See Also