Sign in Join
FPDoc Onlineexperiment

TCustomBitBtn.HotImageIndex property

Member of TCustomBitBtnpublicIn unit Buttons

Ordinal position for the bitmap displayed when the button control is hot (hovered).

Declaration

pascal
property HotImageIndex: TImageIndex index bsHot read GetImageIndex write SetImageIndex default - 1;

Description

HotImageIndex is a TImageIndex property with the ordinal position for the bitmap displayed on the button when it is hot (under the mouse cursor - hovered). It refers to the position in the Images property where the associated image data is stored. The default value for the property is -1, and indicates that an explicit value has not been assigned to the property.

The Lazarus IDE provides a property editor that allows selection of one of the Images from a drop-down image list. The position for the selected image is stored as the property value in the Object Inspector.

Added in LCL version 2.3.0. Available since version 3.0.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.