GridView.GetGroupRowDisplayText(Int32, Boolean) Method

Returns the text displayed within a specific group row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.2.dll

Declaration

public virtual string GetGroupRowDisplayText(
    int rowHandle,
    bool fullText
)
Public Overridable Function GetGroupRowDisplayText(
    rowHandle As Integer,
    fullText As Boolean
) As String

Parameters

Name Type Description
rowHandle Int32

The handle of the group row.

fullText Boolean

true to include the "[#image]" substring in the returned value in the position specified by the GridView.GroupFormat property; otherwise, false

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 included in the text returned. This points to the default position where an image will be displayed within a group row if data is grouped by a column that uses an image combobox in-place editor.

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 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