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

Namespace: Dynamsoft.DotNet.TWAIN
Assembly: DynamicDotNetTWAIN (in DynamicDotNetTWAIN.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C#
public int ImageLayoutFrameNumber { get; }
Visual Basic
Public ReadOnly Property ImageLayoutFrameNumber As Integer
	Get

Remarks

The frames are acquired from the same page. The number is reset when a new page is acquired. ImageLayoutFrameNumber property, along with other properties about information of the current image, 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 acquire session, please use capability negotiation. The capability to be negotiated is ICAP_FRAMES. Please refer to How To Negotiate ICAP_FRAMES for details and sample code.

Exceptions

ExceptionCondition
Dynamsoft.DotNet.TWAIN..::..TwainException When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString.

See Also