uFlags

Flags that determine the behavior of the dot removal process. Flags may be combined using a bitwise OR. Possible values are:

Value

Meaning

DOT_SINGLE_REGION:

For each dot found by the DotRemove method, if the DocCleanSuccess property is set to SUCCESS_REMOVE in the DotRemoveEvent event, the removed dot is added to an internal single region. If the DocCleanSuccess property is set to SUCCESS_NOREMOVE, the dot is not added to the single region. When the DotRemove method returns, either the DocCleanBitmap property or the hDocCleanRgn property will reference a region that contains all the removed dots. If DOT_LEAD_REGION is also set, the DocCleanBitmap property will be set to a bitmap that has a LEAD region that contains all the removed dots. If DOT_LEAD_REGION is not set, hDocCleanRgn is set to a Windows region that contains all the removed borders. When the region (either LEAD or Windows) is no longer needed, it must be destroyed.

DOT_LEAD_REGION

When the DotRemove method returns, the DocCleanBitmap property is updated with a bitmap that also contains a region with all the removed dots. This flag must be used in conjunction with DOT_SINGLE_REGION. To use this flag set uFlags to DOT_SINGLE_REGION | DOT_LEAD_REGION. The DocCleanBitmap property will be updated when the DotRemove method returns.

DOT_IMAGE_UNCHANGED

The original image is unchanged.

DOT_USE_DPI

The unit of measure for all parameters of this method is thousandths of an inch. Use the image's DPI to convert to pixels. This allows the processing of many images with different DPI. If this flag is not set, the unit of measure is pixels.

DOT_CALLBACK_REGION

The DotRemoveEvent event receives a Windows region that contains the current dot to be removed. Setting this flag lets the user create his or her own composite of removed dots by combining the regions received by the event, if the DocCleanSuccess property was set to SUCCESS_REMOVE in the event. The regions can be combined using a logical OR operator. Combining all regions received by the event, that are removed, results in a region identical to the region created when DOT_SINGLE_REGION is set in uFlags.

DOT_USE_SIZE

Use the iMinDotWidth, iMinDotHeight, iMaxDotWidth, iMaxDotHeight parameters to indicate the size of the dots to remove. If this flag is not set, default values for the four sizes will be used. These defaults are as follows: iMinDotWidth = 1, iMinDotHeight = 1, iMaxDotWidth = 2 and iMaxDotHeight = 2.

DOT_USE_DIAGONALS

Considers pixels that are diagonal as part of the dot. Consider the "speck" below consisting of nine pixels.

 

image\dotdiag.gif

 

If DOT_USE_DIAGONALS is used, this speck is considered a single dot that is 5x5 pixels. If DOT_USE_DIAGONALS is not used, the speck is considered three dots (2x2, 1x1, 2x2).