The ImageKit Scan interface exposes properties and methods for retrieving images from scan devices and digital cameras.
The ways in which the ImageKit10 retrieves images:
| Scan Device or Camera | Scan Results | Scan Mode |
|---|---|---|
| Image scanner (document plate) | Scans single images | Can scan using manufacturer's user interface or using a customer interface |
| Image scanner (ADF) | Scans multiple images | Can scan using manufacturer's user interface or using a customer interface |
| Digital camera | Scans multiple images | Can scan using manufacturer's user interface or using a customer interface |
| Film scanner | Scans multiple images | Can scan using manufacturer's user interface only |
Order for executing scan methods:
[LoadTwain]
|
Initialize (Necessary)
|
GetDataSourceInfo, List, Select
|
[OpenDataSource]
|
GetBitDepth, GetCapEnumToFloat,
GetCapEnumToString, GetCapRange, GetPhysicalSize, GetMinimumSize,
IsCapSupported
|
Exec
|
[CloseDataSource]
|
Terminate (Necessary)
|
[FreeTwain]
Important:
Although it is not necessary to execute the LoadTwain/FreeTwain or
the OpenDataSource/CloseDataSource method pairs, it is highly
recommended that you do so.
Aside from the LoadTwain/FreeTwain and the Initialize/Terminate
method pairs, the order that you execute other methods is not so
important. In general, you can execute any methods in any
order that is necessary. However, the LoadTwain/FreeTwain and the
Initialize/Terminate method pairs must be executed in the order
presented above. Furthermore, if the OpenDataSource/CloseDataSource
method pair is also used, then the scanning methods you execute
must be done so after the OpenDataSource method. Please refer to
the scan order shown above.
Property List
| Custom Properties | Explanation |
|---|---|
| AdjustGamma | Sets the gamma adjustment coefficient |
| AutoBright | Sets whether to automatically adjust the brightness |
| BitDepth | Sets the number of bits per pixel in the scanned image |
| BitDepthReduction | Sets the method used to reduce the bit depth when scanning in 1 bit color |
| Border | Sets whether or not border correction is used |
| BorderColor | Adjusts the border color |
| BorderDetection | Enables automatic border detection |
| Brightness | Sets the scan brightness. |
| Cancel | Sets whether or not the scan process is canceled |
| ColorBWRatio | Sets the allowable ratio of color pixels in a document for the scanner to scan in black and white. |
| Compression | Sets the compression method used when an image is transferred via memory |
| Contrast | Sets the scan contrast |
| DataSourceIndex | Refers to the current datasource as retreived by the List method |
| DataSourceName | Sets the name of the scan device |
| DataSourceNameList | Refers to the list of scan devices retrieved by the List method |
| Deskew | Sets whether or not deskew is enabled |
| DropoutColor | Sets the dropout color |
| DynamicThreshold | Sets the dynamic threshold level |
| ExtUiMode | Sets whether or not the extended user interface is used |
| FileFormat | Sets the file format when saving a file using file transfer. |
| FileName | Sets the file name when saving a file using file transfer or using memory transfer with compression. |
| FocusPosition | Sets the focus position |
| FpuException | Sets whether or not FPU exception errors are disabled |
| Gamma | Sets the gamma correction |
| HalfTone | Sets the halftone. |
| Highlight | Sets the scanning highlight |
| IgnoreBackColor | Sets whether or not the background color of the document is ignored when automatically determining whether to scan in black and white or in color |
| ImageFilter | Sets the image filter |
| ImageMerge | Sets a double sided composition |
| Indicator | Sets whether or not the indicator is displayed when scanning |
| InformationFileName | Sets the filename and path were the information file is saved |
| JpegQuality | Sets the JpegQuality when using file or memory transfer with JPEG compression. |
| Manufacturer | Refers to to the scan device manufacturer's name |
| MoireFilter | Sets the level for the Moire filter |
| NoiseFilter | Sets the noise reduction filter |
| Orientation | Sets the orientation of the paper |
| OverScan | Sets how over scanning is handled |
| PageCount | Sets the number of images to be scanned |
| PaperSize | Sets the size of the paper |
| PixelType | Sets the type of image scanned |
| ProductFamily | Refers to the scan device product family name |
| ProductName | Refers to the scan device product name |
| ProtocolMajor | Refers to the TWAIN Major version number |
| ProtocolMinor | Refers to the TWAIN minor version number |
| RangeCurrent | Refers to the current setting for a specified functionality |
| RangeDefault | Refers to the default setting for a specified functionality |
| RangeMax | Refers to the maximum setting for a specified functionality |
| RangeMin | Refers to the minimum setting for a specified functionality |
| RangeStep | Refers to a range of possible setting values for the specified functionality |
| RectBottom | Sets the bottom position of the area on the image to be scanned |
| RectLeft | Sets the left position of the area on the image to be scanned |
| RectRight | Sets the right position of the area on the image to be scanned |
| RectTop | Sets the top position of the area on the image to be scanned |
| RemoveHole | Sets how punch holes are handled |
| RotateBack | Sets whether or not the back side of the page is rotated when scanning on both sides using an ADF |
| Rotation | Sets the angle of rotation for the image |
| ScanCount | Refers to the number of images that have been scanned |
| ScanMode | Sets the scanning mode |
| ScanningSpeed | Increases the speed at which a document is scanned |
| Shadow | Sets the shadow |
| Sharpness | Sets the level of sharpness |
| SkipBlankPage | Sets how blank pages are handled |
| SkipBlankThreshold | Sets the threshold for determining if a page is blank and whether it will be skipped |
| SourceMajor | Refers to the major version number of the scan device |
| SourceMinor | Refers to the minor version number of the scan device |
| SourceVersionInfo | Refers to the scan device's version information |
| TextEnhancement | Sets the text enhancement |
| Threshold | Sets the scanning threshold |
| TransferMode | Sets whether native, file, or memory transfer is used |
| UiMode | Sets whether the scan driver's user interface is used or if a custom built user interface is used. |
| UnitFlag | Sets whether the scan units are determined by the scan device or by the ImageKit |
| UnitMode | Sets the units of measurement |
| XResolution | Sets the horizontal scan resolution |
| XScaling | Sets the horizontal scaling (magnification) |
| YResolution | Sets the vertical scan resolution |
| YScaling | Sets the vertical scaling (magnification) |
Differences from ImageKit7/8/9/10 ActiveX
Properties that have been deleted: DsNameCount, HalfToneList
Properties that have been changed:
DsName --> DataSourceName
DsNameList --> DataSourceNameList
HalfTone --> Halftone
Method List
| Custom Method | Explanation |
|---|---|
| ClearProperty | Resets the scan control properties |
| CloseDataSource | Closes the scan device |
| Execute | Retrieves an image from a TWAIN scan device |
| FreeTwain | Frees the TWAIN DLL |
| GetBitDepth | Retrieves the bit depth supported by the scan device |
| GetCapEnumToFloat | Retrieves the possible setting values for a specified property of the scan device |
| GetCapEnumToString | Retrieves the possible setting values for a specified property of the scan device |
| GetCapRange | Retrieves the range of possible setting values for a specified functionality of the scan device |
| GetDataSourceInfo | retrieves information about the specified scan device, such as manufacturer, product name, etc |
| GetMinimumSize | Retrieves the smallest size that can be scanned with a given scan device |
| GetPhysicalSize | Retrieves the largest physical size that can be scanned with a given scan device |
| Initialize | Starts the TWAIN process |
| IsCapSupported | Confirms whether or not a functionality is supported by the scan device |
| IsOpenDataSource | Checks whether or not the scan device is open |
| List | Lists the scan devices |
| LoadTwain | Loads the TWAIN DLL |
| OpenDataSource | Opens the scan device |
| Select | Selects the scan device |
| Terminate | Ends the TWAIN process |
Differences from ImageKit7/8/9/10 ActiveX
Methods that have been changed:
CloseDS --> CloseDataSource
Exec --> Execute
GetCapEnum --> GetCapEnumToFloat, GetCapEnumToString
GetDSInfo --> GetDataSourceInfo
IsOpenDS --> IsOpenDataSource
OpenDS --> OpenDataSource