ImageLayoutFrameNumber

Description

Returns the frame number of the current image. This is a read-only property.

Data type

<int>

Syntax

.ImageLayoutFrameNumber;

Usually a chronological index of the acquired frame. These frames are related to one another in some way; usually they were acquired from the same page. The Source assigns these values. Initial value is 1. Reset when a new page is acquired.

ImageLayoutFrameNumber property, along with other properties about the current image information, is valid only in OnPreTransfer and OnPostTransfer event.

The frame information here is only about the current frame. To get the information about all the frames to be transferred in an acquisition session, please use capability negotiation.

The capability to be negotiated is ICAP_FRAMES (4372). Please refer to How To Negotiate ICAP_FRAMES for details and sample code.

When an error occurs, check ErrorCode or ErrorString for error information.

See also

ImageLayoutFrameLeft
ImageLayoutFrameTop
ImageLayoutFrameRight
ImageLayoutFrameBottom
ImageLayoutDocumentNumber
ImageLayoutPageNumber