GridView.GetGroupRowDisplayText(Int32, Boolean) Method
Returns the text displayed within a specific group row.
public virtual string GetGroupRowDisplayText( int rowHandle, bool fullText )
Public Overridable Function GetGroupRowDisplayText( rowHandle As Integer, fullText As Boolean ) As String
The handle of the group row.
true to include the "[#image]" substring in the returned value in the position specified by the GridView.GroupFormat property; otherwise, false
The text displayed within a specific group row.
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.
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.
- 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.