GridColumn.Image Property

Gets or sets an image displayed within the Column Header.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[Browsable(false)]
[DXCategory("Appearance")]
[DefaultValue(null)]
public virtual Image Image { get; set; }

VB.NET

<Browsable(False)>
<DXCategory("Appearance")>
<DefaultValue(Nothing)>
Public Overridable Property Image As Image

Property Value

Type	Default	Description
Image	*null*	An image displayed within the column header.

Remarks

It’s possible to assign an image to a column header via either the Image or GridColumn.ImageIndex property. If both properties are set, the image assigned via the Image property has higher priority.

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 Image 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#L29

myGridView1.Columns["Order"].ImageAlignment = StringAlignment.Center;
myGridView1.Columns["ID"].Image = imageCollection1.Images[2];
myGridView1.Columns["ID"].ImageAlignment = StringAlignment.Far;

VB.NET

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

myGridView1.Columns("Order").ImageAlignment = StringAlignment.Center
myGridView1.Columns("ID").Image = imageCollection1.Images(2)
myGridView1.Columns("ID").ImageAlignment = StringAlignment.Far