Back to Devexpress

GridColumn.ImageIndex Property

windowsforms-devexpress-dot-xtragrid-dot-columns-dot-gridcolumn-ce71c1d4.md

latest3.3 KB
Original Source

GridColumn.ImageIndex Property

Use the ImageIndex setting of the GridColumn.ImageOptions property to assign a column header image by its index in an image collection.

Namespace : DevExpress.XtraGrid.Columns

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

csharp
[Browsable(false)]
[DefaultValue(-1)]
[DXCategory("Appearance")]
[EditorBrowsable(EditorBrowsableState.Never)]
[ImageList("Images")]
[XtraSerializableProperty]
public virtual int ImageIndex { get; set; }
vb
<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<DXCategory("Appearance")>
<DefaultValue(-1)>
<ImageList("Images")>
<XtraSerializableProperty>
Public Overridable Property ImageIndex As Integer

Property Value

TypeDefaultDescription
Int32-1

An integer value that specifies the image by its zero-based index within the source collection; -1 displays 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 is also possible to assign an image to a column header directly using the GridColumn.ImageOptions.Image property.

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

Tip

You can also assign an image by its name in the collection.

csharp
// The image collection is created and populated with images at design time.
barItem.ImageOptions.Image = imageCollection1["technology_32x32"]; 
// Assign an SVG image in the SvgCollection
// barItem.ImageOptions.SvgImage = svgCollection1["technology_32x32"];
vb
' The image collection is created and populated with images at design time.
barItem.ImageOptions.Image = imageCollection1("technology_32x32")
' Assign an SVG image in the SvgCollection
' barItem.ImageOptions.SvgImage = svgCollection1["technology_32x32"];

Read the following help topic for more information: Access and Use DevExpress Icons in Code.

See Also

Images

Column Header

GridColumn Class

GridColumn Members

DevExpress.XtraGrid.Columns Namespace