GridView.GetGroupRowDisplayText(Int32) Method

Returns the text displayed within a specific group row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v23.2.dll

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

Declaration

C#

public string GetGroupRowDisplayText(
    int rowHandle
)

VB.NET

Public Function GetGroupRowDisplayText(
    rowHandle As Integer
) As String

Parameters

Name	Type	Description
rowHandle	Int32	The handle of the group row.

Returns

Type	Description
String	The text displayed within a specific group row.

Remarks

The text returned by this method is constructed according to the format specified by the GridView.GroupFormat property. The “[#image]” substring is not included in the text returned.

For information on row handles, refer to the Rows topic.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetGroupRowDisplayText member must not be invoked for these Views. The GetGroupRowDisplayText 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.

• 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 GetGroupRowDisplayText(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#

winforms-grid-print-group-summary-under-columns/CS/Q250602/MyGridControl.cs#L51

View.GroupFormat = "{0}:{1}";
string groupText = View.GetGroupRowDisplayText(rowHandle);
View.GroupFormat = prefFormat;

VB.NET

winforms-grid-print-group-summary-under-columns/VB/Q250602/MyGridControl.vb#L75

View.GroupFormat = "{0}:{1}"
Dim groupText As String = View.GetGroupRowDisplayText(rowHandle)
View.GroupFormat = prefFormat