ImageLayoutDocumentNumber

Description

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

Data type

<int>

Syntax

.ImageLayoutDocumentNumber;

Remarks

The document number, assigned by the Source, that the acquired data originated on. Useful for grouping pages together. Usually a physical representation, this could just as well be a logical construct. Initial value is 1. Increment when a new document is placed into the document feeder (usually tell this has happened when the feeder empties). Reset when no longer acquiring from the feeder.

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

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

See also

ImageLayoutFrameLeft
ImageLayoutFrameTop
ImageLayoutFrameRight
ImageLayoutFrameBottom
ImageLayoutPageNumber
ImageLayoutFrameNumber