Click or drag to resize

Scanners Class

This property returns the Scanners collection of the engine, which enumerates all available scanners. If the Engine is not initialized, accessing this property raises a trappable error.
Inheritance Hierarchy

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public class Scanners : IproPlusClass, IDisposable

The Scanners type exposes the following members.

Properties
  NameDescription
Public propertyConfigFileLocation
This property is used to get or set the location of the scanner.ini file, which contains the scanners that are configured by the Scanner Wizard.
Public propertyCount
This property returns the number of Scanner objects contained by the collection.
Public propertyCustomerID
Caution note Caution
This API is preliminary and subject to change.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the Scanners
Public methodGetEngine
Returns the Engine object.
Public methodGetEnumerator
Public methodGetItem
This property returns the requested Scanner object from the collection.
Public methodGetPaperSize
This helper method returns the size of the standard paper size defined by PaperFormat.
Public methodLoadSettings
This method loads the settings of the available scanners (e.g. color mode, resolution, etc.) from an external file.
Public methodSaveSettings
This method saves the settings of the available scanners into an external file.
Public methodScannerWizard
This method is used to display the Scanner Wizard to add, remove, or test scanners.
Public methodSelected
Returns the currently selected scanner.
Top
Events
  NameDescription
Public eventOnScanWizardFinished
This event is fired when the Scanner Wizard is ready.
Public eventOnSelectionChanged
This event is fired when the selected scanner is changed.
Public eventOnSettingsLoaded
This event is fired when the scanner settings are loaded.
Top
See Also