Skip to main content

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.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

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

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.

Tip

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

// 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