CalcPreviewTextEventArgs.RowHandle Property

Gets the handle of the row whose preview text is to be generated.

Namespace : DevExpress.XtraGrid.Views.Grid

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

C#
VB.NET

csharp

public int RowHandle { get; }

Public ReadOnly Property RowHandle As Integer

Property Value

Type	Description
Int32

An integer value representing a handle of the row whose preview text is to be generated.

Remarks

The obtained row handle can be used, for instance, to get cell values within the currently processed row. This can be used to construct the preview text for values displayed across several fields. To obtain cell values, use the ColumnView.GetRowCellDisplayText and ColumnView.GetRowCellValue methods.

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

Example

This example customizes the row preview text.

C#
VB.NET

csharp

using DevExpress.XtraGrid.Views.Grid;

   private void gridView1_CalcPreviewText(object sender, CalcPreviewTextEventArgs e) {
    GridView view = sender as GridView;
    if (view == null) return;
    e.PreviewText = "Item: " + e.PreviewText + "; Units: " + 
        view.GetRowCellDisplayText(e.RowHandle, _
        view.Columns["UnitsOnOrder"]) + ".";
   }

Imports DevExpress.XtraGrid.Views.Grid

   Private Sub GridView1_CalcPreviewText(ByVal sender As System.Object, _
     ByVal e As CalcPreviewTextEventArgs) Handles GridView1.CalcPreviewText
      Dim view As GridView = sender
      If view Is Nothing Then
           Return
      End If
      e.PreviewText = "Item: " + e.PreviewText + "; Units: " + _
        view.GetRowCellDisplayText(e.RowHandle, _
        view.Columns("UnitsOnOrder")) + "."
   End Sub