Share via

CheckScanner.DocumentWidth Property

  • Article

2/27/2008

Gets or sets the width of the document scanned or the width of the document to be scanned.

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

Syntax

'Declaration
Public MustOverride Property DocumentWidth As Integer

public abstract int DocumentWidth { get; set; }

public:
virtual property int DocumentWidth {
    int get () abstract;
    void set (int value) abstract;
}

/** @property */
public abstract int get_DocumentWidth ()

/** @property */
public abstract void set_DocumentWidth (int value)

public abstract function get DocumentWidth () : int

public abstract function set DocumentWidth (value : int)

Remarks

Width is expressed in the unit of measure defined by the MapMode property.

If the CapAutoSize property is set to true, the width of the scanned document is automatically put in DocumentWidth when the image is captured. If CapAutoSize is set to false, the width of the document must be set in DocumentWidth by the application before scanning a document.

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

Accessing DocumentWidth may cause a PosControlException to be thrown with the following ErrorCodes.

Value

Meaning

Illegal

DocumentWidth has been set to a value less than 0 (zero).

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.CapAutoSize Property
MapMode
CheckScanner.DocumentHeight Property