VintaSoft Twain .NET SDK 15.4: Documentation for .NET developer
Vintasoft.EsclImageScanning Namespace / EsclDevice Class / AddScanRegion(VintasoftRect,EsclScanUnitOfMeasure) Method
Syntax Exceptions Example Requirements SeeAlso
In This Topic
AddScanRegion(VintasoftRect,EsclScanUnitOfMeasure) Method (EsclDevice)
In This Topic
Adds the scan region to the scan regions of this eSCL device.
Syntax
'Declaration

Public Sub AddScanRegion( _
ByVal scanRegion
Scan region in units of measure specified by "unitOfMeasure" parameter.
As Vintasoft.Primitives.VintasoftRect, _
ByVal unitOfMeasure
eSCL unit of measure.
As EsclScanUnitOfMeasure _
)

Parameters

scanRegion
Scan region in units of measure specified by "unitOfMeasure" parameter.
unitOfMeasure
eSCL unit of measure.
Exceptions
ExceptionDescription
Thrown if scan region has not correct coordinates OR maximum count of scan regions is reached.
Example

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


''' <summary>
''' Acquires image area from eSCL device.
''' </summary>
Public Sub AcquireImageRegionFromEsclDevice()
    ' create eSCL device manager
    Using deviceManager As New Vintasoft.EsclImageScanning.EsclDeviceManager()
        ' open eSCL device manager
        deviceManager.Open()

        ' wait while the eSCL device manager searches for eSCL devices
        System.Threading.Thread.Sleep(deviceManager.DeviceSearchTimeout)
        ' get count of eSCL 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 eSCL device
        Dim device As Vintasoft.EsclImageScanning.EsclDevice = deviceManager.Devices(0)

        ' open eSCL device
        device.Open()


        Dim scanRegionWidth As Integer = 1000
        Dim scanMaxWidth As Integer? = device.GetScanMaxWidth(Vintasoft.EsclImageScanning.EsclScanUnitOfMeasure.ThreeHundredthsOfInches)
        If scanMaxWidth.HasValue Then
            scanRegionWidth = scanMaxWidth.Value
        End If

        Dim scanRegionHeight As Integer = 1000
        Dim scanMaxHeight As Integer? = device.GetScanMaxHeight(Vintasoft.EsclImageScanning.EsclScanUnitOfMeasure.ThreeHundredthsOfInches)
        If scanMaxHeight.HasValue Then
            scanRegionHeight = scanMaxHeight.Value
        End If
        ' set new scan area
        device.AddScanRegion(
            New Vintasoft.Primitives.VintasoftRectI(0, 0, scanRegionWidth, scanRegionHeight / 2),
            Vintasoft.EsclImageScanning.EsclScanUnitOfMeasure.ThreeHundredthsOfInches)


        Dim acquiredImage As Vintasoft.EsclImageScanning.EsclAcquiredImage
        Do
            Try
                ' acquire image from eSCL 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 eSCL device
        device.Close()

        ' close eSCL device manager
        deviceManager.Close()
    End Using

    System.Console.ReadLine()
End Sub


/// <summary>
/// Acquires image area from eSCL device.
/// </summary>
public void AcquireImageRegionFromEsclDevice()
{
    // create eSCL device manager
    using (Vintasoft.EsclImageScanning.EsclDeviceManager deviceManager = new Vintasoft.EsclImageScanning.EsclDeviceManager())
    {
        // open eSCL device manager
        deviceManager.Open();

        // wait while the eSCL device manager searches for eSCL devices
        System.Threading.Thread.Sleep(deviceManager.DeviceSearchTimeout);
        // get count of eSCL devices
        int deviceCount = deviceManager.Devices.Count;
        if (deviceCount == 0)
        {
            System.Console.WriteLine("Devices are not found.");
            return;
        }

        // select the first eSCL device
        Vintasoft.EsclImageScanning.EsclDevice device = deviceManager.Devices[0];

        // open eSCL device
        device.Open();


        double scanRegionWidth = 1000;
        double? scanMaxWidth = device.GetScanMaxWidth(Vintasoft.EsclImageScanning.EsclScanUnitOfMeasure.ThreeHundredthsOfInches);
        if (scanMaxWidth.HasValue)
            scanRegionWidth = scanMaxWidth.Value;

        double scanRegionHeight = 1000;
        double? scanMaxHeight = device.GetScanMaxHeight(Vintasoft.EsclImageScanning.EsclScanUnitOfMeasure.ThreeHundredthsOfInches);
        if (scanMaxHeight.HasValue)
            scanRegionHeight = scanMaxHeight.Value;
        // set new scan area
        device.AddScanRegion(
            new Vintasoft.Primitives.VintasoftRect(0, 0, scanRegionWidth, scanRegionHeight / 2),
            Vintasoft.EsclImageScanning.EsclScanUnitOfMeasure.ThreeHundredthsOfInches);


        Vintasoft.EsclImageScanning.EsclAcquiredImage acquiredImage;
        do
        {
            try
            {
                // acquire image from eSCL 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 eSCL device
        device.Close();

        // close eSCL 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

See Also