The AcquireParams object provides a generic interface to the Twain, WIA and Portable Devices interfaces of IEvolution. It allows you to use all available acquisition methods without writing separate code for Twain and WIA.

Namespace: HiComponents.IEvolution
Assembly: IEvolution2 (in IEvolution2.dll) Version: 10.0.0.0

Syntax

         
 C#  Visual Basic  Visual C++ 
public class AcquireParams
Public Class AcquireParams
public ref class AcquireParams

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Aborting
Set to false to cancel the acquisition of images (e.g. during the OnProgress event)
AcquireFrameBottom

AcquireFrameBottom is the bottom of the rectangle to acquire measured in inches

Note: Not supported for DCIM retrieval.

AcquireFrameEnabled

If AcquireFrameEnabled is True, it enables the properties AcquireFrameLeft, AcquireFrameRight, AcquireFrameTop and AcquireFrameBottom.

Note: This is only required for API Types of Twain. For other types AcquireFrameEnabled is always true.

AcquireFrameLeft

AcquireFrameLeft is the left of the rectangle to acquire measured in inches.

Note: Not supported for DCIM retrieval

AcquireFrameRight

AcquireFrameRight is the right side of the rectangle to acquire measured in inches.

Note: Not supported for DCIM retrieval.

AcquireFrameTop

AcquireFrameTop is the top of the rectangle to acquire measured in inches.

Note: Not supported for DCIM retrieval. With WIA ensure you set AcquireFrameLeft/AcquireFrameTop before AcquireFrameRight/AcquireFrameBottom.

AutoFeed

If AutoFeed is true, the scanner will automatically feed the next page from the document feeder.

Note: Not supported for DCIM retrieval

BitDepth

Specifies the bit depth (bits per channel) of the image to scan.

Note: Not supported for DCIM retrieval

Brightness

Brightness value.

Note: Not supported for DCIM retrieval

Contrast

Contrast value.

Note: Not supported for DCIM retrieval

DuplexEnabled

If DuplexEnabled is True, the scanner scans both sides of a paper; otherwise, the scanner will scan only one side.

Use this property only within IEImageList component to enable/disable duplex mode.

Note: Not supported for DCIM retrieval

Default: False (Scan only one side)

DuplexSupported

If DuplexSupported is True, the scanner can scans both sides of a paper; otherwise the scanner will scan only one side.

Note: Not supported for DCIM retrieval

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FeederEnabled

FeederEnabled enables the feed loader mechanism when present. Use this property only within IEImageList component to disable the feed loader.

Note: Not supported for DCIM retrieval

FeederLoaded

Use the FeederLoaded property to determine whether there are documents loaded in the Source's feeder.

Note: Not supported for DCIM retrieval

Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsPixelTypeSupported(AcquireParams..::..AcquirePixelType)

Returns true if the device supports acquisition using the specified pixelType.

Notes:

- Twain devices: Checks capabilities of both PixelType and BitDepth

- WIA devices: Always returns true

- DCIM: Returns true for Other, otherwise false

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Orientation

Orientation defines the orientation of the output image. Not all scanners support this capability.

Note: Not supported for DCIM retrieval

PaperDetectable

If PaperDetectable is True, the scanner is able to detect paper.

Note: Not supported for DCIM retrieval

PhysicalHeight

PhysicalHeight is the maximum physical height (Y-axis) the scanner can acquire (measured in inches).

Note: Not supported for DCIM retrieval

PhysicalWidth

PhysicalWidth is the maximum physical width (X-axis) the scanner can acquire (measured in inches).

Note: Not supported for DCIM retrieval

PixelType

PixelType is the type of pixel data that a scanner is capable of acquiring.

Notes:

- Not supported for DCIM retrieval

- Passing ieapOther as the PixelType will acquire using the default/current properties

You can determine what formats the device supports by using IsPixelTypeSupported

Rotation

Specifies how much the Source can/should rotate the scanned image data prior to transfer.

Note: Not supported for DCIM retrieval

SelectedSource
Allows to get and set the current acquiring device. String format is the same used by AcquireParams.Sources[] string list.
Sources

Contains names of all acquisition sources.

Items are formatted as follows:

Device Name||Index of Location||API||Device Type

E.g. My Cool Scanner||3||TWN||SCN

Threshold

Threshold specifies the dividing line between black and white. Allowed values: 0 - 255.

Note: Not supported for DCIM retrieval

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UpdateSources(Boolean, Boolean, Boolean, Boolean)
Update names of all acquisition sources.
VisibleDialog

If True, the camera/scanner user interface is displayed when Acquire is called.

Default: True

Note: Dialogs are never shown for DCIM retrieval

XResolution

XResolution is the DPI (Dots per Inch) in the X-axis.

Note: Not supported for DCIM retrieval

YResolution

YResolution is the DPI (Dots per Inch) in the Y-axis.

Note: Not supported for DCIM retrieval

Inheritance Hierarchy

System..::..Object
  HiComponents.IEvolution..::..AcquireParams

See Also