ScanningManagerEvents Summary

_IScanningManagerEvents is the single outgoing interface supported by ScanningManager. Clients may implement event handlers for selected events in the interface. The ScanningManager notifies its client of important events and errors that occur during the life of a scanning session. See also ScanningManager Events and Valid Properties/Methods

All events use the ScanEventArgs interface that provides access to event state information from within the event handlers. See also, ScanEventArgs and ScanningManager Events Valid Combinations

Click to see a diagram showing how the events relate to the scanning cycle.

The list of events is provided below, in the order in which they are implemented for scanning. For complete details, see the topic specific to each event.

Standard Events

Event

Description

SessionInit

ScanTools is ready to scan first sheet of a session (batch).

DocInit

Begins the lifecycle of the current document. This event is fired after ScanTools Plus initializes itself for a new document.

SheetInit

Begins the lifecycle of the current sheet. This event is fired after ScanTools Plus initializes itself for a new sheet, before ScanTools attempts to issue a command to pick the next sheet.

SheetAcquired

A sheet has been scanned and digitized. At this point the sheet has passed basic integrity tests; digitization complete, light check, dark check, skew, and timing mark acquisition.

FormIdentified

A sheet has been successfully identified but grid resolution is not done.

Resolved

For a sheet, grid resolution has been done but the data has not been examined for edit failures. Using Data Services, you can alter data from the sheet.

PreScore

Only if scan-time scoring is enabled; document has been scanned but not scored. Occurs only on last sheet of document. Using Data Services, you can alter data from the document.

XPrint

A sheet has been scanned and is at the print station, but has not been printed or stacked. You can change the print string after it has been formatted for printing, or the stacker destination. Using Data Services, you can alter data from the sheet.

Clip

For imaging scanners only: 5000i and iNSIGHT. Process clips from a single sheet. Using Data Services, you can alter data from the sheet.

SheetStacked

A sheet has been scanned and stacked, but the record has not been written to the data file.

SheetComplete

The last event for the current sheet, ScanTools is done processing this sheet.

DocStacked

A document has been scanned and stacked, but the record has not been written to the data file. Using Data Services, you can alter data from the document.

DocComplete

A document has been scanned and stacked, and the record has been written to the data file.

SessionComplete

A scanning session is complete.

PreTerminate

ScanTools is just about to terminate the scanning session in response to scanner operator actions.

SheetCancelled

Ends the lifecycle of the current sheet. This event fires after ScanTools abandons the processing for the current sheet.

DocCancelled

Ends the lifecycle of the current document. This event fires after ScanTools abandons the processing for the current document.

DocRejected

The document was rejected due to a ScanTools Plus edit failure, or other action by your program.

ServerMessageBox

A ScanTools Plus program non-scanning error has occurred, such as problems with configuration, application definition, profiles, data files, etc.

ScanError

A scanner error has occured. This corresponds to a message displayed by ScanTools Plus in the Scanner Error Dialog.

ScannerButtonPressed

Scanner operator has pressed a button on the scanner to continue scanning during scan error resolution.

DiagDataAvailable

Diagnostic data is available.

ScanTools II Link Deprecated Events

The following events were available in the ScanTools II Link SDK. They are still supported, but have been superceded by the newer events available in ScanTools Plus software. By design, ScanTools II Link events precede equivalent ScanTools Plus events that take the ScanEventArgs argument. The following table shows the correlation of ScanTools Plus events with ScanTools II Link events.

ScanTools Plus Link Events

ScanTools II Link Deprecated Events

SessionInit

 

DocInit

 

SheetInit

 

SheetAcquired

 

FormIdentified

 

Resolved

 

PreScore

 

XPrint

OnSheetAtPrintHead

Clip

 

SheetStacked

 

SheetComplete

 

DocStacked

 

DocComplete

OnDocComplete

SessionComplete

OnSessionComplete

PreTerminate

 

SheetCancelled

 

DocCancelled

 

DocRejected

 

ServerMessageBox

OnGeneralError

ScanError

OnScanError

ScannerButtonPressed

OnScannerButtonPressed

DiagDataAvailable

OnDiagDataAvailable

See also

ScanningManager Summary

How to Implement Event Driven Scanning

How to Diagnose a Scanner

How to Handle General Errors

How to Handle Scanner Errors

 

 

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)

www.scantron.com

Technical Support:

1-800-445-3141

support@scantron.com

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.