CustomDrawRowHeaderCellEventArgs.ImageIndex Property

Gets or sets the image displayed within the painted row header cell.

Namespace : DevExpress.XtraVerticalGrid.Events

Assembly : DevExpress.XtraVerticalGrid.v25.2.dll

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

Declaration

C#
VB.NET

csharp

public int ImageIndex { get; set; }

Public Property ImageIndex As Integer

Property Value

Type	Description
Int32

A zero-based integer specifying the image displayed within the painted row header cell, -1 if no image is displayed.

Remarks

Initially, the ImageIndex property contains the zero-based index of the image specified by the ImageIndex option accessible in RowProperties.ImageOptions. This property can be used in the following ways:

read the property value to paint the default image;
change the ImageIndex property value and leave the CustomDrawEventArgs.Handled property set to false. This forces the control to paint the row header cell using the default mechanism but with another image.

The source of images is specified by the vertical grid’s VGridControlBase.ImageList property. The bounding rectangle of the row header cell image can be obtained via the CustomDrawRowHeaderCellEventArgs.ImageRect property.