This method creates a new memory stream and writes the one clip to the stream. The stream pointer is reset before returning the stream to the caller. The stream is entirely owned and managed by the caller. This method may be well-suited for simple scenarios where you have only one clip, for example, the Comments field in a single sheet document scanning application.
The IClipHelper properties are initially set to the values for the current sheet as defined in the ScanTools Plus application definition just before the FormIdentified event is raised.
NOTE: The API was introduced in version 8.2.
See ScanEventArgs and ScanningManager Events Valid Combinations.
HRESULT GetClipAsStream3(
[in] long xStart;
[in] long yStart;
[in] long cxSpan;
[in] long cySpan;
[in] SideOfSheet SideOfSheet;
[out, retval] IStream** ppIStream);
|
xStart |
The start position off the clip along the X-axis of the form. The X-axis contains the cell positions that match the scanner read head. It is also the axis that contains the form ID marks. |
|
yStart |
The start position off the clip along the y-axis of the form. The y-axis contains the timing marks printed on the guide edge of the form. |
|
cxSpan |
The span of the clip along the x-axis of the form. |
|
cySpan |
The span of the clip along the y-axis of the form. |
|
SideOfSheet |
The side of the sheet to clip. |
| Special Case |
To specify a full page clip, set these to 0: xStart = 0 yStart = 0 cxSpan = 0 cySpan = 0 |
NOTE: The Start and Span members are interpreted on the basis of the ClipHelper.ClipCoordinateSpace property being used. The default for this property is OMR– cells and timing marks.
|
Stream |
Pointer to the memory stream. |
To view an graphic of how to specify a clip, see the following:
Specifying a Clip on the Bottom (or Back) Side
Specifying a Clip on the Top (or Front) Side
ClipHelper.GetClipAsStream method
ClipHelper.GetClipAsStream2 method
Capture Image Clips under Solution Control
|
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. |
||