TileItem.ImageIndex Property

Gets or sets the index of the image within the TileControl.Images collection that should serve as the TileItem's glyph.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

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

Property Value

Type Default Description
Int32

-1

An Int32 value indicating an index of the image within the TileControl.Images collection that should serve as the TileItem's glyph.

Remarks

The most common way to set a TileItem's glyph is to use its TileItem.Image or TileItemElement.Image property (the latter is available via the TileItem.Elements member) . Alternatively, you can create a custom images collection and assign it to the TileControl.Images property. When this is done, use the ImageIndex or TileItemElement.ImageIndex property to use one of the images stored in the TileControl.Images collection as the TileItem's glyph. See the Tile Item Structure topic to learn more.

NOTE

Since a tile item can have multiple icons provided via the TileItem.Elements collection, the ImageIndex property affects an image in the first collection item only. For this reason, we recommend the TileItemElement.ImageIndex property rather than the ImageIndex property to customize all the tile's elements.

See Also