VintaSoft Twain .NET SDK 15.3: Documentation for .NET developer
Vintasoft.WiaImageScanning Namespace / WiaDevice Class / SetImageLayout(VintasoftRect) Method
Syntax Exceptions Example Requirements SeeAlso
In This Topic
    SetImageLayout(VintasoftRect) Method (WiaDevice)
    In This Topic
    Sets an image region, in thousandths of an inch, that should be scanned.
    Syntax
    'Declaration
    
    Public Sub SetImageLayout( _
    ByVal rect
    An image region that should be scanned.
    As Vintasoft.Primitives.VintasoftRect _
    )
    public void SetImageLayout(
    Vintasoft.Primitives.VintasoftRect rect
    )
    public: void SetImageLayout(
    Vintasoft.Primitives.VintasoftRect rect
    )
    public:
    void SetImageLayout(
    Vintasoft.Primitives.VintasoftRect rect
    )

    Parameters

    rect
    An image region that should be scanned.
    Exceptions
    ExceptionDescription
    Thrown if device is not opened OR device does not support this functionality.
    Example

    This C#/VB.NET code shows how to acquire image region from WIA device.

    
    ''' <summary>
    ''' Acquires image area from WIA device.
    ''' </summary>
    Public Sub AcquireImageRegionFromWiaDevice()
        ' create WIA device manager
        Using deviceManager As New Vintasoft.WiaImageScanning.WiaDeviceManager()
            ' open WIA device manager
            deviceManager.Open()
    
            ' get count of WIA devices
            Dim deviceCount As Integer = deviceManager.Devices.Count
            If deviceCount = 0 Then
                System.Console.WriteLine("Devices are not found.")
                Return
            End If
    
            ' select the first WIA device
            Dim device As Vintasoft.WiaImageScanning.WiaDevice = deviceManager.Devices(0)
    
            ' open WIA device
            device.Open()
    
            ' get the image layout
            Dim imageLayout As Vintasoft.Primitives.VintasoftRect = device.GetImageLayout()
            ' set the image layout
            device.SetImageLayout(New Vintasoft.Primitives.VintasoftRect(0, 0, imageLayout.Width, imageLayout.Height / 2))
    
            Dim acquiredImage As Vintasoft.WiaImageScanning.WiaAcquiredImage
            Do
                Try
                    ' acquire image from WIA device
                    acquiredImage = device.AcquireImageSync()
                    ' if image is received
                    If acquiredImage IsNot Nothing Then
                        System.Console.WriteLine("Image is acquired.")
                    Else
                        ' if image is not received
                        System.Console.WriteLine("Scan is completed.")
                        Exit Try
                    End If
                Catch ex As System.Exception
                    System.Console.WriteLine(String.Format("Scan is failed: {0}", ex.Message))
                    Exit Try
                End Try
                ' while image is acquired
            Loop While acquiredImage IsNot Nothing
    
            ' close WIA device
            device.Close()
    
            ' close WIA device manager
            deviceManager.Close()
        End Using
    
        System.Console.ReadLine()
    End Sub
    
    
    
    /// <summary>
    /// Acquires image area from WIA image scanner.
    /// </summary>
    public void AcquireImageRegionFromWiaDevice()
    {
        // create WIA device manager
        using (Vintasoft.WiaImageScanning.WiaDeviceManager deviceManager = new Vintasoft.WiaImageScanning.WiaDeviceManager())
        {
            // open WIA device manager
            deviceManager.Open();
    
            // get count of WIA devices
            int deviceCount = deviceManager.Devices.Count;
            if (deviceCount == 0)
            {
                System.Console.WriteLine("Devices are not found.");
                return;
            }
    
            // select the first WIA device
            Vintasoft.WiaImageScanning.WiaDevice device = deviceManager.Devices[0];
    
            // open WIA device
            device.Open();
    
            // get current image layout
            Vintasoft.Primitives.VintasoftRect imageLayout = device.GetImageLayout();
            // set new image layout
            device.SetImageLayout(new Vintasoft.Primitives.VintasoftRect(0, 0, imageLayout.Width, imageLayout.Height / 2));
    
            Vintasoft.WiaImageScanning.WiaAcquiredImage acquiredImage;
            do
            {
                try
                {
                    // acquire image from WIA device
                    acquiredImage = device.AcquireImageSync();
                    // if image is received
                    if (acquiredImage != null)
                    {
                        System.Console.WriteLine("Image is acquired.");
                    }
                    // if image is not received
                    else
                    {
                        System.Console.WriteLine("Scan is completed.");
                        break;
                    }
                }
                catch (System.Exception ex)
                {
                    System.Console.WriteLine(string.Format("Scan is failed: {0}", ex.Message));
                    break;
                }
            }
            // while image is acquired
            while (acquiredImage != null);
    
            // close WIA device
            device.Close();
    
            // close WIA device manager
            deviceManager.Close();
        }
    
        System.Console.ReadLine();
    }
    
    

    Requirements

    Target Platforms: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

    See Also