Skip to main content

ToolTipControllerShowEventArgs.ImageIndex Property

Gets or sets the index of an image from the ImageList to display in the tooltip.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v23.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

[EditorBrowsable(EditorBrowsableState.Never)]
public int ImageIndex { get; set; }

Property Value

Type Description
Int32

The index of a custom image to display in the tooltip.

Remarks

The ToolTipController enables you to display custom images within the tooltip. For this purpose, assign the image list containing your images to the ToolTipControllerShowEventArgs.ImageList or ToolTipController.ImageList property and specify the index of the image to display via the ImageIndex property.

To display predefined icons in tooltips, use ToolTipControllerShowEventArgs.IconType. This property is in effect if ToolTipControllerShowEventArgs.ImageList is null or if ImageIndex does not refer to a valid image from ToolTipControllerShowEventArgs.ImageList (less than 0 or greater than the last image index).

It’s also possible to display custom images in the tooltip that are not stored in any image list. To do this, assign the required image directly to the ToolTipControllerShowEventArgs.ToolTipImage property.

See Also