TdxCustomSmartImage.ActiveFrame Property

Specifies the zero-based index of the stored image’s frame currently displayed by the Smart Image container.

Declaration

property ActiveFrame: LongWord read; write;

Property Value

Type
LongWord

Remarks

You can use this property to change the currently visible frame of a multi-frame image (such as animated GIF and TIFF images containing multiple frames) in the Smart Image container. The ActiveFrame property values range from 0 to the AnimationFrameCount property value minus one.

If the Animation property is set to True, the ActiveFrame property value is incremented by 1 (up to its maximum value) at the end of each time period specified by the AnimationFrameDelay property. If the endless animation mode is enabled (by default) for the stored animated image, assigning a value greater or equal to the AnimationFrameCount property value to the ActiveFrame property (either programmatically or by auto-incrementing) results in starting a new animation loop from the first image frame and setting the ActiveFrame property to 0.

The ActiveFrame property returns 0 if the first or only frame of the stored image is currently displayed.