ScanEventArgs is the interface that provides access to event state information from within the event handlers. It is used by all ScanningManager events. The event state is factored into two main properties – Document and Sheet that map to the current document or sheet being scanned.
When the ScanningManager class invokes a callback during the background portion of ScanAsync or FindAndConfigureScannerAsync, it passes an instance of ScanEventArgs as the argument to the handler function. It contains the information required to interact with the runtime.
It also holds the information passed to DataService.OpenAsync.
See Also:
The alphabetic list of properties and methods is provided below. For complete details, see the topic specific to each property.
|
IScanEventArgs |
|
|---|---|
|
Properties |
Description |
|
Returns an object of type Scanner that represents the currently active scanner. |
|
|
Whether or not to cancel a document during scanning. |
|
|
Cancel the scanning termination process and continue scanning. |
|
| ClientCallback | This is the clientCallback argument passed to DataService.OpenAsync. This applies to a web scanning session, otherwise null. |
| ClientContext | This is the clientContext argument passed to DataService.OpenAsync. This applies to a web scanning session, otherwise null. |
|
Returns the ClipHelper Interface that allows you to perform scan-time image clipping independent of the ScanTools Plus application. |
|
|
Returns the Document Interface that allows access to the document currently being scanned. |
|
|
Returns the ScanErrors Interface that is the collection of all possible runtime scanner error messages. |
|
|
Returns the name of the equivalent ScanTools Plus user exit point at this point in the scanning cycle. |
|
| Hold | Implements a holding pattern that allows end users access to your solution’s user interface while your solution is handling a scanning event on the same thread (typically the main thread of the solution process). |
|
Returns the parent window handle. |
|
|
Returns the iNAMEHelper Interface that allows solution control of the ScanTools iNAME merge process at scan time. |
|
|
Returns the OmrHelper Interface which allows access to the OMR buffer. |
|
|
Whether or not to reject a document during scanning. |
|
|
Which scanner button was used to resolve a scanner error. |
|
|
Returns the ServerMessage Interface which represents one ScanTools Plus program message. |
|
|
Returns the Sheet Interface that allows access to the sheet currently being scanned. |
|
|
Handling of sheets not processed at the SessionComplete and ScanError events. |
|
|
Only if ScanTools Plus user exit implemented. Module handle of the user exit dll loaded by ScanTools Plus. |
|
|
Methods |
Description |
|
Used to determine whether or not a specific field has been resolved. |
|
See Help on Help for additional information on using this help file. See Scantron Technical Support for additional information on technical support and training options. See the ScanTools Suite System Requirements for further details on hardware and software requirements. ScanTools is a suite of products; the specific information you want may appear in the help for a different module. If you don't find what you're looking for here, try one of the following:
|
Scantron Corporation
Customer Service (forms, products, and services): 1-800-SCANTRON (722-6876) Technical Support: 1-800-445-3141 |
|
|
Copyright © 1998-2012 Scantron Corporation. All rights reserved. Use permitted only under license. www.scantron.com. No part of the Help or user guides may be reproduced in any form, or by any means, without express permission from Scantron Corporation. LINKS TO THIRD PARTY SITES This help system may contain links to third party websites ("Linked Sites"). The Linked Sites are not under the control of Scantron and Scantron is not responsible for the content of any Linked Site, including without limitation any link contained in a Linked Site or any changes or modifications to a Linked Site. Scantron is not responsible for web casting or any other form of transmission received from any Linked Site. Scantron provides Users with the ability to link the Assessment System to the Linked Sites as a convenience to you, and the inclusion of any link does not imply endorsement by Scantron of the Linked Site or any association with its operators. |
||