GetImageLayout Method

In This Topic

Gets the image layout of the selected TWAIN device.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function GetImageLayout() As ImGearDoubleRectangle

'Usage
 
Dim instance As ImGearTWAIN
Dim value As ImGearDoubleRectangle
 
value = instance.GetImageLayout()

public ImGearDoubleRectangle GetImageLayout()

public: ImGearDoubleRectangle GetImageLayout();

public:
ImGearDoubleRectangle GetImageLayout();

Return Value

ImageGear.Core.ImGearDoubleRectangle that represents the physical bounding box of the region to be acquired.

Note: Use only the Left, Top, Right, and Bottom properties of the return value.

Exceptions

Exception	Description
ImageGear.Core.ImGearException	Thrown if this method is called while there is not an open connection with a Data Source.

Remarks

Prior to calling this method:

Call OpenSource to select the desired Data Source.
Set the ICAP_UNITS capability, if inches (default) is not the desired unit of measure for the returned bounding box.

Note: Only the Left, Top, Right and Bottom properties of the returned ImageGear.Core.ImGearDoubleRectangle should be used. The Width and Height properties should not be used, because they assume endpoint-inclusive semantics. Using endpoint-inclusive semantics, a rectangle with left, top, right, and bottom coordinates all equal to 0 is one pixel wide and one pixel tall. So, for example, the Width property is calculated as Right - Left + 1. This is not appropriate for a TWAIN image layout rectangle.

Reference

ImGearTWAIN Class
ImGearTWAIN Members
ImGearDoubleRectangle Structure

Get Product Support