CheckScanner.ImageFormat Property

2/27/2008

Gets or sets the data format of the image file that the device uses when it captures an image.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Property ImageFormat As CheckImageFormats

public abstract CheckImageFormats ImageFormat { get; set; }

public:
virtual property CheckImageFormats ImageFormat {
    CheckImageFormats get () abstract;
    void set (CheckImageFormats value) abstract;
}

/** @property */
public abstract CheckImageFormats get_ImageFormat ()

/** @property */
public abstract void set_ImageFormat (CheckImageFormats value)

public abstract function get ImageFormat () : CheckImageFormats

public abstract function set ImageFormat (value : CheckImageFormats)

Remarks

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

Possible values are defined by the CheckImageFormats enumeration.

The availability of acceptable file types is specified in the CapImageFormat property. ImageFormat must be set before a document is scanned. Any stored data in the ImageData property will not be affected by changing ImageFormat.

ImageFormat is set by the service object, based on the capabilities of the device.

Accessing ImageFormat may cause a PosControlException to be thrown with the following ErrorCodes:

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

CheckScanner Class
CheckScanner Members
Microsoft.PointOfService Namespace
CheckScanner.CapImageFormat Property
CheckImageFormats Enumeration
CheckScanner.ImageData Property