ImageGear .NET v25.2 - Updated
ImageGear.Twain Assembly / ImageGear.TWAIN Namespace / ImGearTWAIN Class / SetImageLayout Method

The image layout of the selected TWAIN device.

NOTE: Only Left, Top, Right, and Bottom properties of ImageGear.Core.ImGearDoubleRectangle are relevant in setting the image layout.





In This Topic
    SetImageLayout Method
    In This Topic
    Sets the image layout of the selected TWAIN device.
    Syntax
    'Declaration
     
    Public Sub SetImageLayout( _
       ByVal imageLayout As ImGearDoubleRectangle _
    ) 
    'Usage
     
    Dim instance As ImGearTWAIN
    Dim imageLayout As ImGearDoubleRectangle
     
    instance.SetImageLayout(imageLayout)
    public void SetImageLayout( 
       ImGearDoubleRectangle imageLayout
    )
    public: void SetImageLayout( 
       ImGearDoubleRectangle imageLayout
    ) 
    public:
    void SetImageLayout( 
       ImGearDoubleRectangle imageLayout
    ) 

    Parameters

    imageLayout

    The image layout of the selected TWAIN device.

    NOTE: Only Left, Top, Right, and Bottom properties of ImageGear.Core.ImGearDoubleRectangle are relevant in setting the image layout.

    Exceptions
    ExceptionDescription
    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 Left, Top, Right, and Bottom properties of ImageGear.Core.ImGearDoubleRectangle are relevant in setting the image layout. 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.

    See Also