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

ClipHelper.GetClip4 method

Returns the IClip interface which contains an image clip. Uses input parameters that specify the location and dimension of a physical rectangular region of a scannable form. These are the equivalent of a ClipRegion structure; this method is designed as an alternative to the structure, for languages that can not handle a structure.

All parameters for this method are passed by reference. The values returned by ScanTools Plus Link Runtime reflect the actual clip location and size. If the ClipHelper.ClipCoordinateSpace property being used is csWorld, the returned values may be changed by ScanTools Plus Link Runtime.

NOTE: A convenient way to obtain a full sheet clip, if xStart, yStart, cxSpan and cySpan are ALL 0 (zero) and only the SideOfSheet specified, the appropriate side is clipped in its entirety.

Valid

See ScanEventArgs and ScanningManager Events Valid Combinations.

IDL

HRESULT GetClip4(

[in] long* xStart;

[in] long* yStart;

[in] long* cxSpan;

[in] long* cySpan;

[in] SideOfSheet SideOfSheet;

[out, retval] IClip** Clip); 

Input Parameters

xStart

The beginning position 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 beginning position along the y-axis of the form. The y-axis contains the timing marks printed on the guide edge of the form.

cxSpan

The change in position along the x-axis of the form.

cySpan

The change in position along the y-axis of the form.

The Start and Span members are interpreted on the basis of the ClipHelper.ClipCoordinateSpace property being used. The default is OMR – cells and timing marks.

SideOfSheet

const int sosTop – top side

const int sosBottom – bottom side

Special Case

To specify a full page clip, set these to 0:

xStart = 0

yStart = 0

cxSpan = 0

cySpan = 0

Return Values

IClip

Pointer to the IClip interface that holds the clip taken during scanning.

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

See also

ClipHelper.GetClip method

ClipHelper.GetClip2 method

ClipHelper.GetClip3 method

ClipHelper.GetClip4 method

ClipHelper.GetClip5 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)

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.