ScanSettings ClassTerminal Works - TwainScanning.Net Library
Class used to simplify passing all scan settings when scanning. Most settings are optional, leave individual settings null/empty if they should not be changed or if the current device value should be used.
Inheritance Hierarchy
SystemObject
  TwainScanning.Bridgex86ScanSettings

Namespace: TwainScanning.Bridgex86
Assembly: TwainScanning (in TwainScanning.dll) Version: 1.4.3.0 (1.4.3.0)
Syntax
Copy
public class ScanSettings

The ScanSettings type exposes the following members.

Constructors
  NameDescription
Public methodScanSettings
Initializes a new instance of the ScanSettings class
Top
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Properties
  NameDescription
Public propertyAutoFeed
Should auto feed be used.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.Feeder.Autofeed].

Public propertyAutomaticBorderDetection
Should automatic border detection be used.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.AutomaticAdjustments.AutomaticBorderDetection].

Public propertyBrightness
The brightness to use when scanning.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.ImageAcquire.Brightness].

Public propertyCloseUIAfterAcquire
Close scan window provided by the device or leave it shown.

If not set, will be used.

Public propertyColorMode
Which color mode should be used for scanning.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.ImageType.PixelType] or the alias ColorMode.

Public propertyContrast
The contrast to use when scanning.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.ImageAcquire.Contrast].

Public propertyDevice
Device to use to perform the scan operation.

If not set, the default device will be used.

Public propertyDuplexEnabled
Should duplex scanning be used.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.Duplex.Enabled] or the alias UseDuplex.

Public propertyIgnoreBlankPages
Should blank pages be ignored during scanning.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.AutomaticAdjustments.AutoDiscardBlankPages].

Public propertyImageCount
Maximum number of images to acquire (-1 acquires all available images, 0 is treated as -1).

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using count parameter in Acquire() and AcquireAsync() methods or [!:DataSource.Settings.Transfer.ImageCount].

Public propertyImageQuality
Which quality to use for scanned images, value clamped between 10-100.

Only applied when using the following file formats: PDF, JPEG, PNG. And requires TransferMechanism to be set to Native or Memory.

If not set, the TwainScanning default value will be used.

Public propertyMultiPageScan
If scanning to TIFF or PDF, should scanned images be placed into a multi-page file.

If not set, the TwainScanning default value will be used.

Public propertyOutputFileNamesList
Absolute paths for files to acquire to. Use when specific custom names are required for scan result files. Always provide at least as many as there are items to scan, having more is acceptable, but less is not.

Supported file formats: TIFF (default if extension not specified), PDF, JPEG, BMP, PNG. Use same file format for all files, mixing formats is not supported.

If set, the file name parameter specified in Acquire(String, ScanSettings) will be ignored (mutually exclusive).

Note: When not using Bridgex86, same as using IEnumerable string parameter in any SaveAllTo*() method of an ImageCollector.

Public propertyPageSize
Page size to scan.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.Page.Sizes] or the alias PageSize.

Public propertyPdfProtection
If scanning to PDF, which protection settings to set.

Only applied when using PDF file format. And requires TransferMechanism to be set to Native or Memory.

If not set, the scanned PDF document will not be protected.

Public propertyResolution
Resolution at which to scan.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:Settings.Resolution.X] and [!:Settings.Resolution.Y] or the alias Resolution.

Public propertyRotation
How to rotate the image after scanning.

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.ImageAcquire.Rotation].

Public propertyShowUI
Show scan window provided by the device or scan without showing it.

If not set, will be used.

Public propertyThreshold
The threshold between detecting black and white shades (requires ColorMode to be set to BW).

If not set, the device default value will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.ImageType.Threshold].

Public propertyTiffImageQuality
Which quality to use for scanned images.

Only applied when using TIFF file format. And requires TransferMechanism to be set to Native or Memory.

If not set, the TwainScanning default value will be used.

Public propertyTransferMechanism
Transfer mechanism used to perform the scan operation.

If not set, Native will be used.

Note: When not using Bridgex86, same as using [!:DataSource.Settings.Transfer.Mechanism] or the alias TransferMechanism.

Top
See Also

Reference

TwainScanning.Bridgex86 Namespace