TWAIN ActiveX/Plug-in Windows/Mac HTTP Control/SDK

CutFrameToClipboard Method

Description

Cuts the image data in the specified area to the system clipboard in DIB format.

Support information

ActiveX Edition	Plug-in Edition	Mac Edition
Since V6.0	Since V6.0	Since V6.4

Syntax

ObjectName.CutFrameToClipboard(short sImageIndex, Int32 iLeft, Int32 iTop, Int32 iRight, Int32 iBottom)

Parameters

short sImageIndex: Specifies the index of image in buffer. The index is 0-based.

Int32 iLeft: Specifies the x-coordinate of the upper-left corner of the rectangle.

Int32 iTop: Specifies the y-coordinate of the upper-left corner of the rectangle.

Int32 iRight: Specifies the x-coordinate of the lower-right corner of the rectangle.

Int32 iBottom: Specifies the y-coordinate of the lower-right corner of the rectangle.

Return value

True indicates success. False indicates failure.

Remarks

The fill color can be assigned by calling BackgroundFillColor. This method cuts the image data of selected area into the clipboard. The valid area is the intersection of specified area (defined by the input parameters) and the whole image. If the intersection is invalid, an error will be thrown out.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.