Description

Copy the display and/or image to the clipboard then clear the region that the image data came from.

Return Type

None  

Syntax

object.EditCut CF_Types, [ClearAoiBoundingRect], [ClearedValue]

The EditCut Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McDisplay.
CF_TypesRequired. A mcWhatCF_Types enumeration, as described in settings.

mcWhatCF_Types : The format(s) to place on the clipboard. Currently RegisterClipboardFormat("%McDisplay:IQL~McDisplay% Image Aoi"), RegisterClipboardFormat("%McDisplay:IQL~McDisplay% %Image Display:IQL~Image Display% Area"), CF_ENHMETAFILE and CF_DIB, are supported; they are enumerated in that order for IDataObject.EnumFormatEtc. These formats correspond to CF_Types mcwcftMcImageAoi, mcwcftMcImageDisplayArea, mcwcftCF_ENHMETAFILE and mcwcftCF_DIB, respectively. The mcWhatCF_Types may be OR'ed together to multiple types on the clipboard, but this is generally quite costly, since the rendered data can be very large. Normally only one of the image formats and one display format would be placed on the clipboard (e.g., CF_Types of mcwcftMcImageAoi + mcwcftCF_ENHMETAFILE).

ClearAoiBoundingRectOptional. A Boolean value.

VARIANT_BOOL : If TRUE, then the bounding rectangle of the AOI is cleared rather than just the AOI foreground when the mcwcftMcImageAoi flag is set in the mcWhatCF_Types argument. This only has an effect for irregular or multiple AOI's. The default is FALSE, so that only foreground regions of irregular AOI's are cleared.

ClearedValueOptional. A Variant value.

VARIANT : The new pixel value to be applied to the image data. Either a single floating point value or an array of values, one for each channel. If only one value is given, then this value is applied to each channel (except for HSI and HSL types, where it is only applied to the Intensity or Luminance channel, with the others being zeroed). If not given, then the default value is 0.0.

Settings

The settings for CF_Types are:

ConstantValueDescription
 mcwcftNone0

No clipboard format bits

 mcwcftMcImageAoi1

Private format holding the image area under the AOI of the ImageToDisplay

 mcwcftMcImageDisplayArea2

Private format holding the displayed portion of the ImageToDisplay

 mcwcftCF_ENHMETAFILE16

Enhanced Metafile (EMF) format

 mcwcftCF_DIB32

Device Independent Bitmap (DIB) format

 mcwcftCF_BITMAP64

Device-dependent BITMAP format. This is legal only for the EditGetClipboardImage method. If you want to save a bitmap format to the clipboard, use mcwcftCF_DIB instead.

 mcwcftCF_EMBEDDEDOBJECT128

A format holding the image area under the AOI as an “IQApp Image Document” embedded OLE object.

 mcwcftCF_METAFILEPICT256

Windows Metafile (WMF) format