IMcDisplayEditClear Method

Sub EditClear ( 
	Optional CF_Types As mcWhatCF_Types = mcWhatCF_Types.mcwcftMcImageAoi,
	Optional ClearAoiBoundingRect As Boolean = false,
	<OptionalAttribute> ClearedValue As Object
)

Parameters

CF_Types (Optional)

Type: MediaCy.IQL.Display.ViewermcWhatCF_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)

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.

Reference