CheckScannerProperties Class

Definition

A helper class created by POS for .NET to simplify the retrieval and setting of property values for check scanner devices.

public class CheckScannerProperties : Microsoft.PointOfService.BasicServiceObjects.CommonProperties
type CheckScannerProperties = class
    inherit CommonProperties
Public Class CheckScannerProperties
Inherits CommonProperties
Inheritance
CheckScannerProperties

Properties

CapAutoContrast
CapAutoGenerateFileId

Indicates whether the check scanner device can automatically create a file name for the captured image file.

CapAutoGenerateImageTagData

Indicates whether the check scanner device can automatically generate tag data used in reference to the image file for the captured image.

CapAutoSize

Indicates that the height and width of the scanned document will be automatically placed in the DocumentHeight and DocumentWidth properties when the image is captured.

CapColor

Indicates that the check scanner device supports image formats other than bi-tonal.

CapCompareFirmwareVersion (Inherited from CommonProperties)
CapConcurrentMicr

Indicates whether a check’s MICR (Magnetic Ink Character Recognition) data can be captured during a check scanning cycle (single-pass scanning).

CapContrast
CapDefineCropArea

Indicates whether the check scanner device supports a feature that allows cropping of areas of interest within the scan image area defined by the DocumentHeight and DocumentWidth properties.

CapImageFormat

Indicates whether the check scanner device supports a feature that allows cropping of areas of interest within the scan image area defined by the DocumentHeight and DocumentWidth properties.

CapImageTagData

Indicates that the check scanner device can set tag data, as defined by the ImageTagData property, to the image data file stored in the ImageData property.

CapMicrDevice

Indicates that the check scanner device supports a check MICR read function.

CapPowerReporting (Inherited from CommonProperties)
CapStatisticsReporting (Inherited from CommonProperties)
CapStoreImageFiles

Indicates that the check scanner device can store check images in its hardware memory.

CapUpdateFirmware (Inherited from CommonProperties)
CapUpdateStatistics (Inherited from CommonProperties)
CapValidationDevice

Indicates that a check doesn’t have to be removed from the check scanner device prior to performing validation printing.

Color

Specifies the image scan mode for subsequent document scan operations.

ConcurrentMicr

Indicates whether the check scanner device can conduct a MICR read during a check-scanning cycle.

Contrast
DeviceDescription (Inherited from CommonProperties)
DeviceName (Inherited from CommonProperties)
DocumentHeight

Holds the height of the document scanned, or the height of the document to be scanned.

DocumentWidth

Holds the width of the document scanned, or the width of the document to be scanned.

FileId

Holds the file name associated with the image data file.

FileIndex

Holds the file location associated with the image data file.

ImageData

Holds the image data after the RetrieveImage or RetrieveMemory methods are called.

ImageFormat

Holds the data format of the image file that the device will use when it captures an image.

ImageMemoryStatus

Indicates the current memory availability status if the device has the ability to store multiple image files.

ImageTagData

Holds a string that specifies the tag name for the captured image data. The string may be specified by the application or automatically generated by the check scanner device.

MapMode

Specifies the units of measure that are currently valid for the check scanner device.

MaxCropAreas

Specifies the maximum number of crop areas the device can support.

PowerState (Inherited from CommonProperties)
Quality

Sets the resolution of the device when a scan image is to take place. The resolution value is defined as dpi (dots per inch).

QualityList

Defines the resolutions the check scanner device is capable of supporting.

RemainingImagesEstimate

Provides a “best guess” estimate of the remaining number of images that can be stored.

ServiceObjectDescription (Inherited from CommonProperties)
ServiceObjectVersion (Inherited from CommonProperties)
State (Inherited from CommonProperties)

Applies to