ClipHelper.WriteClipToStream3 method

This method writes the clip to the specified stream. The stream pointer is at the end of the stream upon return from this method. On input, the stream must either be empty or TIFF or JPEG formatted. The clip is JPEG formatted if you requested JPEG compression (ClipCompressionMethod.cpmJPEG) and for all other compressions, it is TIFF formatted.

When writing a TIFF formatted clip to an empty stream, a standard TIFF header is first written followed by the clip itself. When writing a TIFF formatted clip to a stream that already has a TIFF formatted image, the method appends the clip that is currently being taken. To avoid losing frames or corrupting the stream, do not change the stream pointer while building a multi-frame TIFF.

When writing a JPEG formatted clip, the stream must be empty or an exception will result.

NOTE: The API was introduced in version 8.2.

The clip attributes are defaulted from the ScanTools application definition.

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.

Typical use case is creating multi-page TIFF images for each document. The solution creates a stream during the FormIdentified event, with a check for SheetNumber=1 which implies the start of a new document, performs clipping during the Clip event via WriteClipToStream2 and saves the stream to a file during the DocComplete event. If you reject the document, you should appropriately clean up the memory stream.

NOTE: Use WriteClipToStream instead of WriteClipToStream3 if you want to use the ScanTools Plus application sheet-level settings for the clip attributes.

NOTE:Use WriteClipToStream4 to obtain a full page clip.

Valid

See ScanEventArgs and ScanningManager Events Valid Combinations.

IDL

HRESULT WriteClipToStream3(

[in] long xStart;

[in] long yStart;

[in] long cxSpan;

[in] long cySpan;

[in] SideOfSheet SideOfSheet;  

[in] IStream* Stream); 

Input Parameters

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.WriteClipToStream method

ClipHelper.WriteClipToStream2 method

ClipHelper.WriteClipToStream4 method

Clip.WriteToStream method

Capture Image Clips under Solution Control