LayoutViewColumn.ImageIndex Property

Gets or sets the index of an image in the ColumnView.Images collection that will be displayed within the field's caption.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[XtraSerializableProperty]
[DefaultValue(-1)]
public override int ImageIndex { get; set; }
<XtraSerializableProperty>
<DefaultValue(-1)>
Public Overrides Property ImageIndex As Integer

Property Value

Type Default Description
Int32

-1

An integer value that specifies the index of an image in the ColumnView.Images collection.

Remarks

To display an image within a field's caption, you can assign a collection of images to the ColumnView.Images property, and then associate the required image from this collection with the field via the ImageIndex or LayoutViewField.ImageIndex property (these properties are in sync). The LayoutViewColumn.LayoutViewField object provides options to control the image's alignment and the distance between the image and the field caption.

An image can also be displayed within a field caption by assigning it to the LayoutViewColumn.Image property. If images are specified via both the ImageIndex and Image properties, the image assigned to the Image property will be used.

To dynamically assign images to fields (for instance, depending on a card's or field's state), use the LayoutView.CustomFieldCaptionImage event.

See Also