ScanSettings Class

Terminal 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.3.0.0 (1.3.0.0)

Syntax

C++

Copy

public class ScanSettings

Public Class ScanSettings

public ref class ScanSettings

type ScanSettings =  class end

The ScanSettings type exposes the following members.

Constructors

	Name	Description
	ScanSettings	Initializes a new instance of the ScanSettings class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	AutoFeed	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].
	AutomaticBorderDetection	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].
	Brightness	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].
	CloseUIAfterAcquire	Close scan window provided by the device or leave it shown. If not set, will be used.
	ColorMode	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.
	Contrast	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].
	Device	Device to use to perform the scan operation. If not set, the default device will be used.
	DuplexEnabled	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.
	IgnoreBlankPages	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].
	ImageCount	Maximum number of images to acquire (-1 acquires all available images). 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].
	ImageQuality	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.
	MultiPageScan	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.
	PageSize	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.
	Resolution	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.
	Rotation	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].
	ShowUI	Show scan window provided by the device or scan without showing it. If not set, will be used.
	Threshold	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].
	TiffImageQuality	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.
	TransferMechanism	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

Reference

TwainScanning.Bridgex86 Namespace