ImageHandle (ImageKit Control/ Layer Property)

This property refers to the image handle of the image set in the LayerNo property.

[C++Builder] imagekitcontrolname->Layer[Index]->ImageHandle[ = unsigned]

[Delphi] imagekitcontrolname.Layer[Index].ImageHandle[ = THandle]

* The index can range from 0 to 99

Reference

The image handle of the image

Explanation

The ImageHandle property refers to the image handle of the image set in the LayerNo property.

When the image set in the LayerNo is loaded, the ImageHandle property value is set.

To disable the image referred to by the ImageHandle property, set the ImageHandle property to 0. By doing this that image data will automatically be freed from the memory. What is more, even without manually freeing image data from the memory by executing the FreeMemory method, whenever the ImageHandle property is reset or when the control is destroyed, the image data is automatically freed from the memory.

In Delphi:

//When the VImageKit1.ImageHandle property value is not 0 (when an image has been loaded)
VImageKit1.LayerNo := 0;
VImageKit1.Layer[0].Transparent := False;
VImageKit1.FileIO.LoadFile(vikLoad);
//The image data in the memory referred to by the ImageKit1.Layer[0].ImageHandle property has been automatically freed.

Setting this value

This value can be set at run-time.

Retrieving this value

This value can be retrieved at run-time.

Differences between ImageKit7/8

This property's type has changed.