ImageLayoutFrameTop

Description

Returns the value of the top-most edge of the current image frame (in Unit). This is a read-only property.

Data type

<float>

Syntax

.ImageLayoutFrameTop;

Remarks

The unit of ImageLayoutFrameTop property is determined by Unit property.

The default unit is assumed to be "inches" unless it has been otherwise negotiated between the application and Data Source.

ImageLayoutFrameTop 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 acquire 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 ErrorString or ErrorString for error information.

See also

ImageLayoutFrameLeft
ImageLayoutFrameRight
ImageLayoutFrameBottom
ImageLayoutDocumentNumber
ImageLayoutPageNumber
ImageLayoutFrameNumber

Is this page helpful?

Leave a Reply

Your email address will not be published.