Skip to main content
A newer version of this page is available. .

ToolTipController.ImageIndex Property

Gets or sets the index of an image to be displayed within tooltips.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v19.1.dll

Declaration

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

Property Value

Type Default Description
Int32 -1

The integer value specifying the index of an image to be displayed within tooltips.

Remarks

You can use the ToolTipController.ImageList property to specify the list of images that can be displayed within tooltips. The ImageIndex property specifies the index of an image within this list. If this property is set to a valid index, all tooltips will display the corresponding image.

To display different images within different tooltips, handle the ToolTipController.BeforeShow event, and use the event’s ToolTipControllerShowEventArgs.ImageIndex parameter to specify the index of an image to be displayed in the tooltip being currently processed. It’s also possible to specify a custom image for a tooltip directly via the event’s ToolTipControllerShowEventArgs.ToolTipImage parameter.

See Also