TCustomIcon.BitmapHandleAllocated function

Declaration

function BitmapHandleAllocated: Boolean; override

Function result

Description

BitmapHandleAllocated is an overridden Boolean function which indicates if a handle for the icon image has been allocated in the class instance. BitmapHandleAllocated implements the abstract virtual method defined in the ancestor class.

The return value is True when Current has a valid image index for the icon image, and the handle for the TIconImage in the shared icon has a non-zero value.

BitmapHandleAllocated is called from methods that required a valid image handle prior to performing actions using the image data. For example:

• Assign
• BitmapHandleNeeded
• MaskHandleNeed
• Draw
• EndUpdate
• SetMaskHandle

See also

• BitmapHandleAllocated