Description
A portion of the image is cleared to a given value.
-
Return Type
-
None
-
Syntax
-
object.EditClear [CF_Types], [ClearAoiBoundingRect], [ClearedValue]
The EditClear Method syntax has these parts: |
| object | An expression evaluating to an object of type McDisplay. | | CF_Types | Optional. A mcWhatCF_Types enumeration, as described in settings. mcWhatCF_Types : The Image EditCopy formats for which to clear the image. The only relevant formats are mcwcftMcImageAoi (clears the AOI) and mcwcftMcImageDisplayArea (clears the Display area). The mcWhatCF_Types may be OR'ed together to clear both areas.
| | ClearAoiBoundingRect | Optional. 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.
| | ClearedValue | Optional. 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:
|
 | mcwcftNone | 0 |
No clipboard format bits
|
| mcwcftMcImageAoi | 1 |
Private format holding the image area under the AOI of the ImageToDisplay
|
| mcwcftMcImageDisplayArea | 2 |
Private format holding the displayed portion of the ImageToDisplay
|
| mcwcftCF_ENHMETAFILE | 16 |
Enhanced Metafile (EMF) format
|
| mcwcftCF_DIB | 32 |
Device Independent Bitmap (DIB) format
|
| mcwcftCF_BITMAP | 64 |
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_EMBEDDEDOBJECT | 128 |
A format holding the image area under the AOI as an “IQApp Image Document” embedded OLE object.
|
| mcwcftCF_METAFILEPICT | 256 |
Windows Metafile (WMF) format
|
|
EditClear Method (McDisplay)
