Click or drag to resize

Scanners Class
The Scanners collection lists the set of available Scanner objects.
Inheritance Hierarchy
SystemObject
  OmniPageCSDK.IproPlusIproPlusClass
    OmniPageCSDK.IproPlusScanners

Namespace:  OmniPageCSDK.IproPlus
Assembly:  OmniPageCSDK.IproPlus (in OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
Copy
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
Remarks

Each element represents a physical scanner. The scanner list is loaded from an ini file. The ini file can be altered using the Scanner Wizard. To run the wizard, invoke the ScannerWizard method. Using the wizard you can add, remove and parameterize the available scanners. By default, the ini file is called scanner.ini and stored in the current user's application data. The scanner.ini file can optionally be saved to the All Users application data folder, or into the application binary folder. To change the ini file location, update the ConfigFileLocation property accordingly. If the ConfigFileLocation property changes, the current scanner list is destroyed, and the new scanner.ini file is loaded. Use the SaveSettings and LoadSettings methods to save / restore scanner parameters - like resolution or color mode - stored in the external setting file.

During scanning, the scanner drivers may show their own progress dialogs. To specify a parent window for these dialog boxes, set the WindowHandle property of the Engine object accordingly. Providing a valid window handle is highly recommended to avoid the situation when a window or message is displayed behind the main application window. The WindowHandle property should be set before initializing the scanning subsystem. If the parent window is subject to change after you initialized the scanning system, you need to re-initialize the scanning so the new setting takes effect. To do so, update the value of the ConfigFileLocation property. Changing the ConfigFileLocation property also resets all scanner properties to their default value.

See Also