Share this page
IScanner Interface
| HP.Sprinter.Scanners.API Namespace : IScanner Interface |
The main scanner interface, declaring scanner properties, methods for handling the scan data, and the scan method.
Object Model
Syntax
public interface IScanner
Remarks
Implementation of this interface is mandatory.
Public Properties
| Name | Description | |
|---|---|---|
 | AutExecutionTypeCompatibility | The type of application this scanner is compatible with. |
| Description | A short description of the scanner. |
| Icon | The scanner's icon. |
| ID | The scanner ID. |
| RequieredControlsRunTimeExtendedProperties | Requiered run time properties for the controls the scanner will work on. |
| Settings | Run-time settings key-value collection. |
| SettingsView | Settings UI control. |
| VisualName | The scanner's display name. The name can be localized. |
Public Methods
| Name | Description | |
|---|---|---|
 | AbortScan | Halts the scan run. |
| GetAggregatedResult | Returns an aggregation of the input results. |
| GetCustomActions | Returns the custom actions that apply to the result. |
| ResetSettings | Deletes user settings. After ResetSettings returns, the values returned by Settings are used. |
| Scan | Processes the data passed from Sprinter. |
Public Events
| Name | Description | |
|---|---|---|
 | ScanResultFound | The scanner fires this event when a result is found in the scanned data. |
