You are here: Programmers Reference > Programmer's Reference > DataService > ClientCallback Object

ClientCallback Object

This object is an argument to the DataService.OpenAsync method. The solution creates and owns this JavaScript object. It should contain handlers for callback functions invoked by DataService and ScanningManager. The object can also hold other solution specific information.

These member(s) are invoked by DataService. The handler function takes a single argument of type DataServiceEventArgs.

Member Name Description
OpenCompleted Invoked when background portion of OpenAsync completes. Examine the Error member to see if there were any errors.

These members are invoked by the background portion of ScanningManager's FindAndConfigureScannerAsync method. The handler function takes a single argument of type ScanEventArgs

Member Name Description and Typical Use
ScannerSearch,

Update User Interface.

Use ScannerFound to query user to specify any special hardware options for your scanner

ScannerFound,

Update User Interface.

Use ScannerFound to query user to specify any special hardware options for your scanner

ScannerSearchComplete

Update User Interface.

Use ScannerFound to query user to specify any special hardware options for your scanner

These members are invoked by the background portion of ScanningManager‟s ScanAsync method. The handler function takes a single argument of type ScanEventArgs.

Member Name Description and Typical Use
SessionInit Update User Interface.

SessionComplete

Update User Interface.
ScannerSearch,

Update User Interface.

Use ScannerFound to query user to specify any special hardware options for your scanner

ScannerFound,

Update User Interface.

Use ScannerFound to query user to specify any special hardware options for your scanner

ScannerSearchComplete

Update User Interface.

Use ScannerFound to query user to specify any special hardware options for your scanner

DocInit Clear/ Save document data
DocComplete Clear/ Save document data
DocCancelled Clear/ Save document data
DocRejected Clear/ Save document data
SheetInit Clear/ Save sheet data
SheetComplete Clear/ Save sheet data
SheetCancelled Clear/ Save sheet data
SheetAcquired Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
FormIdentified, Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
Resolved, Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
PreScore, Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
XPrint, Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
SheetStacked, Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
Clip, Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
DocStacked Perform real-time printing and stacking at XPrint Present a correction User Interface at SheetStacked
ScanError, Customize the user experience for errors and alerts.
ServerMessageBox Customize the user experience for errors and alerts.
ScannerButtonPressed Update User Interface when user resumes a scanning session
PreTerminate Intercept user ending scanning session through native User Interface
Wait Update User Interface for lamp warm up or other notifications

Example

In this example, the handlers are defined within an object named “clientCallback”.

clientCallback = {

OpenCompleted : function (dataServiceEventArgs) {}

XPrint : function (scanEventArgs) {}

};

 

 

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.