ScanSourceSettings Object (IScanSourceSettings Interface)

This object provides access to the scanning settings of a source.

Note: By default, the scanning area rectangle is not set (all the properties PaperBottom, PaperLeft, PaperRight, PaperTop are set to 0). In this case, the scanning area will be selected by the scanner, which will generally mean the whole available scanning area.

Properties

Name Type Description
Application Engine, read-only Returns the Engine object.
Main settings
ColorMode ScanColorModeEnum

Sets image type (black-and-white, gray, color).

The default value of this property depends on the scanner.

CompressionType ScanCompressionTypeEnum

Specifies the type of compression to be used for the scanned images. Please note that the possible type of compression depends on the image's colority.

The default value of this property depends on the scanner.

Brightness int

Specifies the brightness of the scanned image (0-100). It is only valid when the BrightnessControl property is set to SBC_Manual.

The default value of this property depends on the scanner.

BrightnessControl ScanBrightnessControlEnum

Sets brightness control mode.

The default value of this property depends on the scanner.

Resolution int

Specifies image resolution. This property can be any number in the range from 100 to 1200, but for best recognition results we recommend that you set image resolution to a number divisible by 100 in the range from 200 to 600.

The default value of this property depends on the scanner.

RotationAngle ScanRotationAngleEnum

Sets image rotation angle (once the image has been scanned).

The default value of this property depends on the scanner.

Paper size
PaperSize ScanPaperSizeEnum

Sets paper size.

The default value of this property depends on the scanner.

PaperBottom int

Sets the coordinate of the bottom border of the scanning area rectangle (in milli-inch). It is only valid if PaperSize = SPS_Custom.

By default, this property is set to 0.

PaperLeft int

Sets the coordinate of the left border of the scanning area rectangle (in milli-inch). It is only valid if PaperSize = SPS_Custom.

By default, this property is set to 0.

PaperRight int

Sets the coordinate of the right border of the scanning area rectangle (in milli-inch). It is only valid if PaperSize = SPS_Custom.

By default, this property is set to 0.

PaperTop int

Sets the coordinate of the top border of the scanning area rectangle (in milli-inch). It is only valid if PaperSize = SPS_Custom.

By default, this property is set to 0.

Additional settings
MultipleImagesEnabled VARIANT_BOOL

Specifies whether multi-page scanning is enabled.

By default, this property is set to FALSE.

Note: If scanning options are set in FineReader Engine dialog box to use the automatic feeder, the value of this property is ignored and multi-page scanning is enabled. This is because automatic feeder is supposed to be used for multi-page scanning.

PauseBetweenPagesMode ScanPauseModeEnum

Sets the required delay between scanned pages (no pause, delay for specified number of seconds, prompt for next page).

By default, this property is equal to SPM_None.

Delay int

Sets the pause between pages in sec. It is only valid if PauseBetweenPagesMode = SPM_PresetDelay.

Note: Some scanners with automatic document feeder may ignore the value of this property.

By default, this property is 0.

PaperFeedMode ScanPaperFeedModeEnum

Specifies whether an automatic document feeder must be used.

The default value of this property depends on the scanner: if the scanner has a flatbed, it is equal to SPFM_Flatbed. If not, it is SPFM_AutoFeeder.

DuplexMode VARIANT_BOOL

Specifies whether duplex scanning must be used.

Note: If DuplexMode is set to TRUE you must also set MultipleImagesEnabled to TRUE.

By default, this property is set to FALSE.

CorrectSkew VARIANT_BOOL

Setting this property to TRUE enables automatic skew correction, if this feature is supported by the scan source (see ScanSourceCapabilities::CorrectSkewSupported).

By default, this property is set to FALSE.

DiscardBlankPages VARIANT_BOOL

Setting this property to TRUE enables automatic removal of blank pages, if this feature is supported by the scan source (see ScanSourceCapabilities::DiscardBlankPagesSupported).

By default, this property is set to FALSE.

Related objects

Object Diagram

Samples

This object is used in the Scanning code sample.

See also

ScanManager

Scanning

Working with Properties

24.03.2023 8:51:52

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.