Share via

CheckScanner.DocumentHeight Property

  • Article

2/27/2008

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

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

Syntax

'Declaration
Public MustOverride Property DocumentHeight As Integer

public abstract int DocumentHeight { get; set; }

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

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

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

public abstract function get DocumentHeight () : int

public abstract function set DocumentHeight (value : int)

Remarks

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

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

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

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

Value

Meaning

Illegal

DocumentHeight 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
DocumentWidth