CreateImage Method (McDisplay)
      
 

Description

Returns a new instance of an McImage that requires no cast when GetDibBlock is called.

Remarks The created McImage holds a snapshot of the current display as a DIB. The new McImage is not part of the Images collection and it is initally not Visible. It has a name based on the ImageToDisplay.Name with “_Display” appended.

Return Type

A McImage object.  

Syntax

object.CreateImage ([CreateMonochrome])

The CreateImage Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McDisplay.
CreateMonochromeOptional. A Boolean value.

VARIANT_BOOL : If TRUE then the image is created as a monochrome, 8-bit, DIB. If FALSE (the default) then the image is create as a standard BGR 24-bit DIB. When CreateMonochrome is TRUE, the AboutToPaint event is sent with a mcpcCreateMaskFlag mcPaintCode flag; the effect of this is to cause notify sinks such as McGraphOverlay instances to draw with only a white (RGB 255,255,255) pen and brush.

Notes

The CreateMonochrome flag is designed to allow you to create “mask” images from overlays. As such, you would normally use this with the DisplayWhat property set to mcdwOverlaysOnly. When drawing into the monochrome DIB, a simple gray ramp color table is used, so you should not use this flag if you want to preserve any color information in the image or its overlays.