GridColumn.ImageIndex Property

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

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[Browsable(false)]
[DXCategory("Appearance")]
[DefaultValue(-1)]
[ImageList("Images")]
[XtraSerializableProperty]
public virtual int ImageIndex { get; set; }

VB.NET

<Browsable(False)>
<DXCategory("Appearance")>
<DefaultValue(-1)>
<ImageList("Images")>
<XtraSerializableProperty>
Public Overridable Property ImageIndex As Integer

Property Value

Type	Default	Description
Int32	-1	An integer value specifying the image by its zero-based index within the source collection. -1 to display no image.

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 column header directly using the GridColumn.Image property.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ImageIndex 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-export-a-grid-column-with-an-image-in-its-caption-e5048/CS/MyXtraGrid/Form1.cs#L26

{
    myGridView1.Columns["Name"].ImageIndex = 0;
    myGridView1.Columns["Order"].ImageIndex = 1;

VB.NET

how-to-export-a-grid-column-with-an-image-in-its-caption-e5048/VB/MyXtraGrid/Form1.vb#L28

Private Sub SetImagesToColumnsHeader()
    myGridView1.Columns("Name").ImageIndex = 0
    myGridView1.Columns("Order").ImageIndex = 1