TwainPRO 9 User Assistance Dashboard
TwainPRO 9 for .NET - User Guide
Introduction
What is TwainPRO?
What is The ImagXpress Product Family?
Getting Support
Copyright Information
Getting Started
Operating Requirements
Installing on a Development Machine
Upgrading from TwainPRO 8 to TwainPRO 9
Upgrading Runtime Licensing
Samples
Licensing
Evaluation Licensing
Toolkit Licensing
Assigned Toolkit License
License Manager
Product Editions
Registration
Registering When Connected to the Internet
Registering When Disconnected from the Internet
Developing Code
Runtime Licensing
Automatically Reported Runtime (Node-Locked)
Licensing API
License Pools
License Configuration Files
LDK vs. SLU
Server Licensing Utility (SLU)
Licensing Development Kit (LDK)
Deployment Proxy Service (DPS)
Manually Reported Runtime (Non-Node-Locked)
Solution Name
Solution Key
OEM License Key
Licensing Glossary
Software License Agreement
Distributing Applications & Deployment
Verify You're Using the Latest Service Pack
Distributing TwainPRO
Concepts
Overview of TwainPRO
Overview of TWAIN
Supported File Formats
Glossary
How To
Select the DSM Version
Quick Start - Acquire a TWAIN Image
Open a TWAIN Session
Set the Application's TWAIN Identity
Enable Extended Capabilities
Set the Transfer Mode
Enable Multi-Page Scanning
Select a Data Source
Open the TWAIN Session
Negotiate Capabilities
Check Capabilities
Set Capabilities
Set Image DPI
Acquire Images and Image Information
Define a Caption
Specify Image Layout
Initiate a Scanning Session
Transfer & Save Images
Fast Saving Multi-page TIFF Files
Access Extended Image Information
Multiple Image Acquisition
Pass Image Data between Accusoft Components
End a TWAIN Session
Debug
TwainPRO 9 for .NET - API Reference
Accusoft.TwainPro9.Net Assembly
Overview
Namespaces
Accusoft.TwainProSdk Namespace
Overview
Classes
ApplicationIdentity
Overview
Members
Methods
Dispose Method
Properties
Manufacturer Property
ProductFamily Property
ProductName Property
VersionInfo Property
CapabilityContainer
Overview
Members
Properties
Capability Property
CapabilityContainerArray
Overview
Members
CapabilityContainerArray Constructor
CapabilityContainerArray Constructor(Int32)
CapabilityContainerArray Constructor(Capability)
CapabilityContainerArray Constructor(AdvancedCapability)
Properties
Values Property
CapabilityContainerEnum
Overview
Members
CapabilityContainerEnum Constructor
CapabilityContainerEnum Constructor(Int32)
CapabilityContainerEnum Constructor(Capability)
CapabilityContainerEnum Constructor(AdvancedCapability)
Properties
CurrentValue Property
DefaultValue Property
Values Property
CapabilityContainerFrame
Overview
Members
CapabilityContainerFrame Constructor
CapabilityContainerFrame Constructor(Int32)
CapabilityContainerFrame Constructor(Capability)
CapabilityContainerFrame Constructor(AdvancedCapability)
Properties
Value Property
CapabilityContainerOneValue
Overview
Members
CapabilityContainerOneValueCollection
Overview
Members
Methods
Add Method
Contains Method
CopyTo Method
IndexOf Method
Insert Method
Remove Method
Properties
Item Property
CapabilityContainerOneValueFloat
Overview
Members
CapabilityContainerOneValueFloat Constructor
CapabilityContainerOneValueFloat Constructor(Int32)
CapabilityContainerOneValueFloat Constructor(Capability)
CapabilityContainerOneValueFloat Constructor(AdvancedCapability)
Properties
Value Property
CapabilityContainerOneValueString
Overview
Members
CapabilityContainerOneValueString Constructor
CapabilityContainerOneValueString Constructor(Int32)
CapabilityContainerOneValueString Constructor(Capability)
CapabilityContainerOneValueString Constructor(AdvancedCapability)
Properties
Value Property
CapabilityContainerRange
Overview
Members
CapabilityContainerRange Constructor
CapabilityContainerRange Constructor(Int32)
CapabilityContainerRange Constructor(Capability)
CapabilityContainerRange Constructor(AdvancedCapability)
Properties
Default Property
Maximum Property
Minimum Property
Step Property
Value Property
CapabilityNotSupportedException
Overview
Members
CapabilityNotSupportedException Constructor
CapabilityNotSupportedException Constructor()
CapabilityNotSupportedException Constructor(Int32)
CapabilityNotSupportedException Constructor(String)
CapabilityNotSupportedException Constructor(Int32,String)
CapabilityNotSupportedException Constructor(String,Exception)
Caption
Overview
Members
Methods
Dispose Method
Properties
Area Property
Clip Property
Font Property
ForeColor Property
HorizontalAlignment Property
ShadowText Property
Text Property
VerticalAlignment Property
ClipboardException
Overview
Members
ClipboardException Constructor
ClipboardException Constructor()
ClipboardException Constructor(Int32)
ClipboardException Constructor(String)
ClipboardException Constructor(Int32,String)
ClipboardException Constructor(String,Exception)
CompressedImageNotAvailableException
Overview
Members
CompressedImageNotAvailableException Constructor
CompressedImageNotAvailableException Constructor()
CompressedImageNotAvailableException Constructor(Int32)
CompressedImageNotAvailableException Constructor(String)
CompressedImageNotAvailableException Constructor(Int32,String)
CompressedImageNotAvailableException Constructor(String,Exception)
DataSourceCollection
Overview
Members
DataSourceCollection Constructor
Methods
Contains Method
CopyTo Method
Dispose Method
IndexOf Method
Properties
Current Property
Item Property
DataSourceInvalidOperationException
Overview
Members
DataSourceInvalidOperationException Constructor
DataSourceInvalidOperationException Constructor()
DataSourceInvalidOperationException Constructor(Int32)
DataSourceInvalidOperationException Constructor(String)
DataSourceInvalidOperationException Constructor(Int32,String)
DataSourceInvalidOperationException Constructor(String,Exception)
ExtendedImageInfoContainer
Overview
Members
Properties
ExtendedImageInfo Property
Values Property
ExtendedImageInfoContainerValue
Overview
Members
ExtendedImageInfoContainerValueCollection
Overview
Members
Methods
Add Method
Contains Method
CopyTo Method
IndexOf Method
Insert Method
Remove Method
Properties
Item Property
ExtendedImageInfoContainerValueFloat
Overview
Members
Properties
Value Property
ExtendedImageInfoContainerValueString
Overview
Members
Properties
Value Property
FileCreateException
Overview
Members
FileCreateException Constructor
FileCreateException Constructor()
FileCreateException Constructor(Int32)
FileCreateException Constructor(String)
FileCreateException Constructor(Int32,String)
FileCreateException Constructor(String,Exception)
FileOpenException
Overview
Members
FileOpenException Constructor
FileOpenException Constructor()
FileOpenException Constructor(Int32)
FileOpenException Constructor(String)
FileOpenException Constructor(Int32,String)
FileOpenException Constructor(String,Exception)
FileReadException
Overview
Members
FileReadException Constructor
FileReadException Constructor()
FileReadException Constructor(Int32)
FileReadException Constructor(String)
FileReadException Constructor(Int32,String)
FileReadException Constructor(String,Exception)
FileWriteException
Overview
Members
FileWriteException Constructor
FileWriteException Constructor()
FileWriteException Constructor(Int32)
FileWriteException Constructor(String)
FileWriteException Constructor(Int32,String)
FileWriteException Constructor(String,Exception)
FtpOptions
Overview
Members
Properties
NetworkCredentials Property
ProxySettings Property
FtpTransferException
Overview
Members
FtpTransferException Constructor
FtpTransferException Constructor()
FtpTransferException Constructor(Int32)
FtpTransferException Constructor(String)
FtpTransferException Constructor(Int32,String)
FtpTransferException Constructor(String,Exception)
ImageNotAvailableException
Overview
Members
ImageNotAvailableException Constructor
ImageNotAvailableException Constructor()
ImageNotAvailableException Constructor(Int32)
ImageNotAvailableException Constructor(String)
ImageNotAvailableException Constructor(Int32,String)
ImageNotAvailableException Constructor(String,Exception)
IndexOutOfRangeException
Overview
Members
IndexOutOfRangeException Constructor
IndexOutOfRangeException Constructor()
IndexOutOfRangeException Constructor(Int32)
IndexOutOfRangeException Constructor(String)
IndexOutOfRangeException Constructor(Int32,String)
IndexOutOfRangeException Constructor(String,Exception)
InternalErrorException
Overview
Members
InternalErrorException Constructor
InternalErrorException Constructor()
InternalErrorException Constructor(Int32)
InternalErrorException Constructor(String)
InternalErrorException Constructor(Int32,String)
InternalErrorException Constructor(String,Exception)
InternetFilesNotInstalledException
Overview
Members
InternetFilesNotInstalledException Constructor
InternetFilesNotInstalledException Constructor()
InternetFilesNotInstalledException Constructor(Int32)
InternetFilesNotInstalledException Constructor(String)
InternetFilesNotInstalledException Constructor(Int32,String)
InternetFilesNotInstalledException Constructor(String,Exception)
InvalidBitDepthException
Overview
Members
InvalidBitDepthException Constructor
InvalidBitDepthException Constructor()
InvalidBitDepthException Constructor(Int32)
InvalidBitDepthException Constructor(String)
InvalidBitDepthException Constructor(Int32,String)
InvalidBitDepthException Constructor(String,Exception)
InvalidLicenseException
Overview
Members
InvalidLicenseException Constructor
InvalidLicenseException Constructor()
InvalidLicenseException Constructor(Int32)
InvalidLicenseException Constructor(String)
InvalidLicenseException Constructor(Int32,String)
InvalidLicenseException Constructor(String,Exception)
InvalidPropertyException
Overview
Members
InvalidPropertyException Constructor
InvalidPropertyException Constructor()
InvalidPropertyException Constructor(Int32)
InvalidPropertyException Constructor(String)
InvalidPropertyException Constructor(Int32,String)
InvalidPropertyException Constructor(String,Exception)
Licensing
Overview
Members
Licensing Constructor
Methods
Dispose Method
SetOEMLicenseKey Method
SetSolutionKey Method
SetSolutionName Method
Properties
EvaluationMode Property
LoadSettingsException
Overview
Members
LoadSettingsException Constructor
LoadSettingsException Constructor()
LoadSettingsException Constructor(Int32)
LoadSettingsException Constructor(String)
LoadSettingsException Constructor(Int32,String)
LoadSettingsException Constructor(String,Exception)
OperationCancelledException
Overview
Members
OperationCancelledException Constructor
OperationCancelledException Constructor()
OperationCancelledException Constructor(Int32)
OperationCancelledException Constructor(String)
OperationCancelledException Constructor(Int32,String)
OperationCancelledException Constructor(String,Exception)
OutOfMemoryException
Overview
Members
OutOfMemoryException Constructor
OutOfMemoryException Constructor()
OutOfMemoryException Constructor(Int32)
OutOfMemoryException Constructor(String)
OutOfMemoryException Constructor(Int32,String)
OutOfMemoryException Constructor(String,Exception)
PegasusFilesNotInstalledException
Overview
Members
PegasusFilesNotInstalledException Constructor
PegasusFilesNotInstalledException Constructor()
PegasusFilesNotInstalledException Constructor(Int32)
PegasusFilesNotInstalledException Constructor(String)
PegasusFilesNotInstalledException Constructor(Int32,String)
PegasusFilesNotInstalledException Constructor(String,Exception)
PropertyOrMethodNotAvailableException
Overview
Members
PropertyOrMethodNotAvailableException Constructor
PropertyOrMethodNotAvailableException Constructor()
PropertyOrMethodNotAvailableException Constructor(Int32)
PropertyOrMethodNotAvailableException Constructor(String)
PropertyOrMethodNotAvailableException Constructor(Int32,String)
PropertyOrMethodNotAvailableException Constructor(String,Exception)
SaveOptions
Overview
Members
SaveOptions Constructor
Properties
Format Property
FtpOptions Property
Jpeg Property
Pdf Property
Pic Property
Png Property
Tiff Property
SaveOptionsJpeg
Overview
Members
Properties
Chrominance Property
Luminance Property
Progressive Property
SubSampling Property
SaveOptionsPdf
Overview
Members
Properties
Chrominance Property
Compression Property
EncodeModeCompression Property
FileOrganizationCompression Property
InvertedRegion Property
LoosenessCompression Property
Luminance Property
MultiPage Property
Progressive Property
SubSampling Property
SwapBlackAndWhite Property
SaveOptionsPic
Overview
Members
Properties
Chrominance Property
Luminance Property
Password Property
Progressive Property
SubSampling Property
SaveOptionsPng
Overview
Members
Properties
BackgroundColor Property
Filter Property
Interlaced Property
SwapRedAndBlue Property
TransparencyColor Property
UseBackgroundColor Property
UseTransparencyColor Property
SaveOptionsTiff
Overview
Members
Properties
Compression Property
IFDOffset Property
JpegChrominance Property
JpegLuminance Property
JpegSubSampling Property
MultiPage Property
UseIFDOffset Property
ScannedEventArgs
Overview
Members
ScannedEventArgs Constructor
Properties
Cancel Property
PendingTransfers Property
ScannedImage Property
ScannedImage
Overview
Members
Methods
CopyTo Method
CopyToClipboard Method
CutToClipboard Method
Dispose Method
GetExtendedImageInfo Method
GetExtendedImageInfo(ExtendedImageInfo) Method
GetExtendedImageInfo(Int32) Method
SaveFile Method
SaveFile(String) Method
SaveFile(String,SaveOptions) Method
SaveSourceCompressedImageToFile Method
SaveSourceCompressedImageToStream Method
SaveStream Method
SaveToFile Method
SaveToFile(String) Method
SaveToFile(String,SaveOptions) Method
SaveToStream Method
ToBitmap Method
ToHbitmap Method
ToHdib Method
TransferTo Method
Properties
ScannedImageData Property
ScannedImageData
Overview
Members
Methods
Dispose Method
Properties
BitsPerPixel Property
Compression Property
Height Property
PixelType Property
ResolutionX Property
ResolutionY Property
Width Property
ScanningEventArgs
Overview
Members
ScanningEventArgs Constructor
Properties
Cancel Property
PendingTransfers Property
ScannedImageData Property
SequenceException
Overview
Members
SequenceException Constructor
SequenceException Constructor()
SequenceException Constructor(Int32)
SequenceException Constructor(String)
SequenceException Constructor(Int32,String)
SequenceException Constructor(String,Exception)
SourceCompressedImageOnlyException
Overview
Members
SourceCompressedImageOnlyException Constructor
SourceCompressedImageOnlyException Constructor()
SourceCompressedImageOnlyException Constructor(Int32)
SourceCompressedImageOnlyException Constructor(String)
SourceCompressedImageOnlyException Constructor(Int32,String)
SourceCompressedImageOnlyException Constructor(String,Exception)
StringIsTooLongException
Overview
Members
StringIsTooLongException Constructor
StringIsTooLongException Constructor()
StringIsTooLongException Constructor(Int32)
StringIsTooLongException Constructor(String)
StringIsTooLongException Constructor(Int32,String)
StringIsTooLongException Constructor(String,Exception)
TiffTagItemNotFoundException
Overview
Members
TiffTagItemNotFoundException Constructor
TiffTagItemNotFoundException Constructor()
TiffTagItemNotFoundException Constructor(Int32)
TiffTagItemNotFoundException Constructor(String)
TiffTagItemNotFoundException Constructor(Int32,String)
TiffTagItemNotFoundException Constructor(String,Exception)
TiffTagNotFoundException
Overview
Members
TiffTagNotFoundException Constructor
TiffTagNotFoundException Constructor()
TiffTagNotFoundException Constructor(Int32)
TiffTagNotFoundException Constructor(String)
TiffTagNotFoundException Constructor(Int32,String)
TiffTagNotFoundException Constructor(String,Exception)
TwainDevice
Overview
Members
TwainDevice Constructor
Methods
CloseSession Method
DisplayUserInterface Method
Dispose Method
GetCapability Method
GetCapability(Capability) Method
GetCapability(AdvancedCapability) Method
GetCapability(Int32) Method
GetCapabilityConstantDescription Method
GetCustomDataSourceData Method
IsCapabilitySupported Method
IsCapabilitySupported(Capability) Method
IsCapabilitySupported(AdvancedCapability) Method
IsCapabilitySupported(Int32) Method
LoadSettings Method
OpenDataSourceManager Method
OpenSession Method
SaveSettings Method
SelectSource Method
SetCapability Method
SetCustomDataSourceData Method
StartSession Method
Properties
ApplicationIdentity Property
Caption Property
CloseOnCancel Property
CloseSessionAfterAcquisition Property
DataSourceManagerVersion Property
DataSourceManagerVersionInUse Property
EnableExtendedCapabilities Property
EnableExtendedImageInfo Property
ImageLayout Property
MaximumImages Property
ShowUserInterface Property
TransferMode Property
Events
Scanned Event
Scanning Event
TwainDllLoadException
Overview
Members
TwainDllLoadException Constructor
TwainDllLoadException Constructor()
TwainDllLoadException Constructor(Int32)
TwainDllLoadException Constructor(String)
TwainDllLoadException Constructor(Int32,String)
TwainDllLoadException Constructor(String,Exception)
TwainException
Overview
Members
TwainException Constructor
TwainException Constructor()
TwainException Constructor(Int32)
TwainException Constructor(String)
TwainException Constructor(Int32,String)
TwainException Constructor(String,Exception)
Properties
ConditionCode Property
ConditionDescription Property
TwainPro
Overview
Members
TwainPro Constructor
TwainPro Constructor()
TwainPro Constructor(IContainer)
Methods
AboutBox Method
Properties
Debug Property
DebugErrorLevel Property
DebugLogFile Property
ErrorLevel Property
Licensing Property
ParentWindowHandle Property
Version Property
TwainProCompressedImageOnlyException
Overview
Members
TwainProCompressedImageOnlyException Constructor
TwainProCompressedImageOnlyException Constructor()
TwainProCompressedImageOnlyException Constructor(Int32)
TwainProCompressedImageOnlyException Constructor(String)
TwainProCompressedImageOnlyException Constructor(Int32,String)
TwainProCompressedImageOnlyException Constructor(String,Exception)
TwainProException
Overview
Members
TwainProException Constructor
TwainProException Constructor()
TwainProException Constructor(Int32,String)
TwainProException Constructor(Int32)
TwainProException Constructor(String)
TwainProException Constructor(String,Exception)
Properties
ErrorNumber Property
UnsupportedFileFormatException
Overview
Members
UnsupportedFileFormatException Constructor
UnsupportedFileFormatException Constructor()
UnsupportedFileFormatException Constructor(Int32)
UnsupportedFileFormatException Constructor(String)
UnsupportedFileFormatException Constructor(Int32,String)
UnsupportedFileFormatException Constructor(String,Exception)
ValueOutOfRangeException
Overview
Members
ValueOutOfRangeException Constructor
ValueOutOfRangeException Constructor()
ValueOutOfRangeException Constructor(Int32)
ValueOutOfRangeException Constructor(String)
ValueOutOfRangeException Constructor(Int32,String)
ValueOutOfRangeException Constructor(String,Exception)
Enumerations
AdvancedCapability
AdvancedCapabilityAlarm
AdvancedCapabilityAudioFileFormat
AdvancedCapabilityAutoSize
AdvancedCapabilityBarcodeDetectionSearchMode
AdvancedCapabilityBitDepthReduction
AdvancedCapabilityBitOrder
AdvancedCapabilityCameraSide
AdvancedCapabilityClearBuffers
AdvancedCapabilityCompression
AdvancedCapabilityDeviceEvent
AdvancedCapabilityFeederAlignment
AdvancedCapabilityFeederOrder
AdvancedCapabilityFeederPocket
AdvancedCapabilityFeederType
AdvancedCapabilityFileFormat
AdvancedCapabilityFilter
AdvancedCapabilityFlash
AdvancedCapabilityFlipRotation
AdvancedCapabilityIccProfile
AdvancedCapabilityImageFilter
AdvancedCapabilityJobControl
AdvancedCapabilityJpegQuality
AdvancedCapabilityLightPath
AdvancedCapabilityLightSource
AdvancedCapabilityNoiseFilter
AdvancedCapabilityOverScan
AdvancedCapabilityPixelFlavor
AdvancedCapabilityPlanarChunky
AdvancedCapabilityPowerSupply
AdvancedCapabilityPrinter
AdvancedCapabilityPrinterMode
AdvancedCapabilitySegmented
Capability
CapabilityConstants
ConditionCode
DataSourceManagerVersion
EncodeModeCompression
ErrorLevel
EvaluationMode
ExtendedImageInfo
ExtendedImageInfoConstants
FileOrganizationCompression
Filter
HorizontalAlignment
Orientation
PdfCompression
PixelType
ScannedImageCompression
ScannedImageFormat
SubSampling
SupportedSizes
TiffCompression
TransferMode
VerticalAlignment
Delegates
ScannedEventHandler
ScanningEventHandler