You are here: Programmers Reference > Programmer's Reference > ClipHelper Interface > ClipHelper Interface Summary

ClipHelper Interface Summary

IClipHelper is the interface that allows solution-controlled image capture. It is returned as a parameter to the ScanEventArgs ClipHelper property. See Capture Image Clips under Solution Control

Use of the IClipHelper does not preclude the native batch image capture in the scanning session, see Capture and Access Clips to/from the Master TIFF file. For example, you can use the ScanTools Plus post-scan editor which uses clips for perfecting data, but do your own image archiving in real-time.

Some scenarios for using ClipHelper include:

Present clips for viewing during scanning, in a scanning progress window.
Store an image in a database column.
Create multi-page TIFF files.
Perform real-time clipping for ICR/OCR operations.
Clip for custom editing operations.
Clip for custom archive operations.
Clip for custom quality control.
Web-client with no access to local file system.
Store data and clips together in a custom format.
One or more clipping regions are determined at runtime.
You use a generic or common ScanTools Plus application (.SDS.StxAppDef) file for several of your solutions.
Evaluate a graybox region of the form for the presence of data, for the purpose of conditional clipping.
You are pulling the clipping information off a data base or XML file.

The alphabetic list of properties and methods is provided below. For complete details, see the topic specific to each property. The defaults listed are the values initialized before the FormIdentified event is fired. Additionally, for the properties noted, if the clip is a Whole Sheet clip, the property is initialized with the value as defined in the ScanTools Plus application Image Clips dialog.

IClipHelper
Properties	Description
Archive	Whether or not this clip is for archiving. Default is False.
Background Offset	Grayscale additional upper filter level. Default is 0; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
BitoneEdgeContrastEnhancement	Whether or not to use the Bitone Edge Contrast Enhancement feature. Default is False; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
BitoneThresholdType	Data type to use for determining bitone point. Default is dataHandPrint; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
BottomImageExists	Whether or not an image of the bottom side is available for the sheet just scanned. No default value.
ClipCoordinateSpace	Which coordinate system to use as reference for defining clip region. Default is csOMR.
ClipDepth	Color depth of clip. Default is cdBitone; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
ClipRotation	Amount of rotation desired, compared to scanned orientation. Default is rotNone.
CombineWithForm	Whether or not to add the background form image to the clip. Default is False.
CompressionMethod	Type of file compression used on the clip. Default is cpmNone; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
EnableBackgroundOffset	Whether or not to use the Grayscale Background Offset feature. Default is False; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
GrayboxCutoff	Determines how significant a mark within the graybox evaluation area must be to be considered data for conditional clipping. Default is 5, initialized at SessionInit event.
ManualBitoneThreshold	When BitoneThresholdType is Manual, number to use as the bitone point. Default is 0; except if Whole Sheet clip, then uses value from ScanTools application definition Image Clips dialog.
Tag	Unique numeric ID for this clip. Default is 0.
TopImageExists	Whether or not an image of the top side is available for the sheet just scanned. No default value.
UnitOfMeasure	When ClipCoordinateSpace is World, unit of measurement to use for clip region. Default is uomEnglish.
Methods	Description
EvaluateGraybox	Determines the presence of data on a region on the sheet using the ClipRegion structure as the input.
EvaluateGraybox2	Determines the presence of data on a region on the sheet using the ClipAttributes structure as the input.
EvaluateGraybox3	Determines the presence of data on a region on the sheet. Inputs are passed by value.
GetClip	Obtain a clip from the IClip interface, using the ClipRegion structure as input.
GetClip2	Obtain a clip from the IClip interface, using the ClipAttributes structure as input.
GetClip3	Obtain a clip from the IClip interface, using clip location and size parameters as input. Inputs are passed by value.
GetClip4	Obtain a clip from the IClip interface, using clip location and size parameters as input/output; i.e. passed by reference.
GetClip5	Obtain a clip for the full page from the IClip intreface.
GetClipAsStream	Creates a new memory stream and writes one clip to it using the ClipRegion structure as the input.
GetClipAsStream2	Creates a new memory stream and writes one clip to it using the ClipAttributes structure as the input.
GetClipAsStream3	Creates a new memory stream and writes the one clip to the stream.
GetClipAsStream4	Creates a new memory stream and writes the one clip that represents the full page image.
WriteClipToFile	Writes one clip to a file using the ClipRegion structure as the input.
WriteClipToFile2	Writes one clip to a file using the ClipAttributes structure as the input.
WriteClipToFile3	Writes one clip to a file using clip location and size parameters as input.
WriteClipToFile4	Writes the full page clip to the specified file, appending the clip to the end of the file.
WriteClipToStream	Appends a clip to a memory stream, using the ClipRegion structure as input.
WriteClipToStream2	Appends a clip to a memory stream, using the ClipAttributes structure as input.
WriteClipToSteam3	Appends the clip to the specified stream.
WriteClipToStream4	Appends the full page clip to the specified stream.

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:

ScanTools Plus Scanning Module WebHelp

(includes Real-Time Character Recognition utilizing NestorReader Help)
ScanTools Plus Application Designer Module WebHelp

(includes Real-Time Character Recognition utilizing NestorReader Help)
ScanTools Plus Download Utility WebHelp
ScanTools Plus User Exits WebHelp
ScanTools Plus Legacy Reference Information WebHelp

(a previous version of ScanTools Plus Help that may help power users)
ScanTools Plus Link SDK WebHelp
(API Help for developers)

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.