GridBand.ImageIndex Property

Gets or sets the index of the image displayed within the band header.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[Browsable(false)]
[DXCategory("Appearance")]
[DefaultValue(-1)]
[ImageList("Images")]
[XtraSerializableProperty]
public int ImageIndex { get; set; }
<Browsable(False)>
<DXCategory("Appearance")>
<DefaultValue(-1)>
<ImageList("Images")>
<XtraSerializableProperty>
Public Property ImageIndex As Integer

Property Value

Type Default Description
Int32

-1

A zero-based integer specifying the image by its index within the source collection. -1 if no image is displayed within the band header.

Remarks

The ImageIndex property specifies the index of the required image in the collection of images. The source of images is specified by the ColumnView.Images property.

It's also possible to assign an image to a band header directly using the GridBand.Image property.

The image below shows examples of band header and column header images.

ColumnHeader_Images

See Also