Sign in Join
FPDoc Onlineexperiment

TCustomIcon.Remove procedure

Member of TCustomIconpublicIn unit Graphics

Removes an icon image with the specified attributes.

Declaration

pascal
procedure Remove(AFormat: TPixelFormat; AHeight: Word; AWidth: Word)

Description

Remove is used to locate and delete an icon image with the attributes specified in AFormat, AHeight, and AWidth.

Remove calls GetIndex to get the position in the internal image list where the icon image with the specified attributes is stored. If an image is found, the Delete method is called to the remove the icon image.

The value in Current is modified when it represents an icon image affected by the removal. Current is set to -1 when it contains the index for the icon image removed in the method.

See also

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.