IMcDisplayEditCut Method
|
|
Copy the display and/or image to the clipboard then clear the
region that the image data came from.
Namespace:
MediaCy.IQL.Display.Viewer
Assembly:
MediaCy.IQL.Display.Viewer (in MediaCy.IQL.Display.Viewer.dll) Version: 10.0.6912.0
SyntaxSub EditCut (
CF_Types As mcWhatCF_Types,
Optional ClearAoiBoundingRect As Boolean = false,
<OptionalAttribute> ClearedValue As Object
)
Parameters
- CF_Types
- Type: MediaCy.IQL.Display.ViewermcWhatCF_Types
The format(s) to place on the clipboard.
Currently RegisterClipboardFormat("McDisplay Image Aoi"),
RegisterClipboardFormat("McDisplay 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). - ClearAoiBoundingRect (Optional)
- Type: SystemBoolean
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)
- Type: SystemObject
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.
RemarksIf a requested format cannot be honored because the amount of data that would
need to be placed on the clipboard is too large for that format, then that format request
is silently ignored and no such data is placed on the clipboard. Use the
IsActionAvailable property with the WhatAction argument mcwaCanEditCopyBitmap,
mcwaCanEditCopyAoi, mcwaCanEditCopyDisplayArea, mcwaWarnEditCopyAoi or
mcwaWarnEditCopyDisplayArea to determine if a desirec format can be successfully placed on
the clipboard.
See Also