Vcl.Graphics.TWICImage.FrameIndex

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property FrameIndex: LongWord read FFrameIndex write FFrameIndex;

C++

__property System::LongWord FrameIndex = {read=FFrameIndex, write=FFrameIndex, nodefault};

Properties

Type Visibility Source Unit Parent
property public
Vcl.Graphics.pas
Vcl.Graphics.hpp
Vcl.Graphics TWICImage

Description

Allows you to indicate the desired frame from a multi-frame image.

The .tiff image format often holds multiple images, such as scanned or faxed documents. Each sub-image is called frame.

You set FrameIndex to indicate the desired frame from a multi-frame image (such as a multi-frame TIFF file). When loading from the image file, the frame is loaded if it exists, otherwise an EInvalidOperation exception is raised.

FrameIndex default is 0, which is valid on images without multiple frames.

See also