RowObjectCustomDrawEventArgs.RowHandle Property

Gets the handle of the row whose corresponding element is being painted.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public int RowHandle { get; }

VB.NET

Public ReadOnly Property RowHandle As Integer

Property Value

Type	Description
Int32	An integer value representing the row handle.

Remarks

When handling the GridView.CustomDrawRowPreview event, the RowHandle property returns the data row handle. This handle identifies the row whose preview section is being painted. When handling either the GridView.CustomDrawGroupRow or GridView.CustomDrawRowFooter event, the RowHandle property returns the group row handle that identifies the painted element. Finally, when handling the GridView.CustomDrawFooter event, the property returns the GridControl.InvalidRowHandle field value. This is becauset the View footer doesn’t correspond to any row.

Use the RowHandle property to identify the painted element and obtain row data. In this case, you can implement conditional painting based on the element position or the row’s data.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RowHandle property.

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#

how-to-separately-calculate-a-group-summary-for-a-particular-group-row-e383/CS/Form1.cs#L74

if (e.Column.FieldName == "HP")
    if (e.RowHandle % 2 == 0)
        e.Info.DisplayText = string.Format("Total: {0}", view.GetGroupSummaryValue(e.RowHandle, (GridGroupSummaryItem)view.GroupSummary[0]));

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/CS/GroupRowSummaryHelper.cs#L34

info = e.Info as GridGroupRowInfo;
int level = view.GetRowLevel(e.RowHandle);
int row = view.GetDataRowHandleByGroupRowHandle(e.RowHandle);

how-to-display-an-image-in-a-group-row-e5041/CS/Helpers/GroupRowPaintHelper.cs#L42

    return null;
var rowExpanded = view.GetRowExpanded(e.RowHandle);
var imgIndex = rowExpanded ? 1 : 0;

creating-quick-column-customization-popup-window-e991/CS/E991/GridViewQuickColumnCustomization.cs#L53

void View_CustomDrawRowIndicator(object sender, RowIndicatorCustomDrawEventArgs e) {
    if (e.RowHandle == GridControl.InvalidRowHandle) {
        // You may assign your own image list e.Info.Images to show the custom image.

how-to-conditionally-hide-summaries-in-group-rows-e1354/CS/ConditionallyHideSumsInGroupRows/Form1.cs#L44

}
string summaryText = gridView1.GetGroupSummaryDisplayText(e.RowHandle, summary);
info.GroupText += summaryText;

VB.NET

how-to-separately-calculate-a-group-summary-for-a-particular-group-row-e383/VB/Form1.vb#L75

If e.Column.FieldName = "HP" Then
    If e.RowHandle Mod 2 = 0 Then
        e.Info.DisplayText = String.Format("Total: {0}", view.GetGroupSummaryValue(e.RowHandle, CType(view.GroupSummary(0), GridGroupSummaryItem)))

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/VB/GroupRowSummaryHelper.vb#L32

info = TryCast(e.Info, GridGroupRowInfo)
Dim level As Integer = view.GetRowLevel(e.RowHandle)
Dim row As Integer = view.GetDataRowHandleByGroupRowHandle(e.RowHandle)

how-to-display-an-image-in-a-group-row-e5041/VB/Helpers/GroupRowPaintHelper.vb#L38

If images Is Nothing Then Return Nothing
Dim rowExpanded = view.GetRowExpanded(e.RowHandle)
Dim imgIndex = If(rowExpanded, 1, 0)

creating-quick-column-customization-popup-window-e991/VB/E991/GridViewQuickColumnCustomization.vb#L79

Private Sub View_CustomDrawRowIndicator(ByVal sender As Object, ByVal e As RowIndicatorCustomDrawEventArgs)
    If e.RowHandle = GridControl.InvalidRowHandle Then
        ' You may assign your own image list e.Info.Images to show the custom image.

how-to-conditionally-hide-summaries-in-group-rows-e1354/VB/ConditionallyHideSumsInGroupRows/Form1.vb#L44

End Select
Dim summaryText As String = gridView1.GetGroupSummaryDisplayText(e.RowHandle, summary)
info.GroupText += summaryText