[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'Graphics' (#lcl)

# TCustomIcon.MaskHandleAllocated

True if a handle has been allocated for the mask in the image.

## Declaration

Source position: graphics.pp line 1667

`public function TCustomIcon.MaskHandleAllocated: Boolean; override;`

## Function result

True when the MaskHandle has been allocated for the icon image.

## Description

MaskHandleAllocated is an overridden method used to determine if a handle for the image mask has been allocated in the class instance. MaskHandleAllocated implements the abstract virtual method defined in the ancestor class.

The return value is True when Current contains a value other than -1, and the MaskHandle for the TIconImage in the shared image list has a non-zero value.

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

- Assign
- AssignImage
- BitmapHandleNeeded
- MaskHandleNeeded
- CreateMask
- SetTransparentColor
- SetBitmapHandle
- SetMaskHandle

## See also

TCustomIcon.Assign |  | Copies values from the specified persistent object into the current class instance.
TCustomIcon.AssignImage |  | Copies image data from the source image to the current icon image.
TCustomIcon.MaskHandleNeeded |  | Ensures that a handle for the mask in the icon is valid.
TRasterImage.BitmapHandle |  | BitmapHandle - the Handle that has been allocated for the Bitmap.
TRasterImage.Mask |  | Applies the color used for transparent pixels to the image.
TRasterImage.MaskHandle |  | The handle allocated for the Bitmap Mask.
TRasterImage.MaskHandleAllocated |  | MaskHandleAllocated - returns True if a handle has been allocated for the Mask.