uFlags

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

Value

Meaning

LINE_SINGLE_REGION:

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

LINE_LEAD_REGION

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

LINE_IMAGE_UNCHANGED

The original image is unchanged.

LINE_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.

LINE_CALLBACK_REGION

The LineRemoveEvent event receives a Windows region that contains the current line to be removed. Setting this flag lets the user create his or her own composite of removed lines by combining the regions received by the event, if the DocCleanSuccess property was set to SUCCESS_REMOVE. 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 LINE_SINGLE_REGION is set in uFlags.

LINE_REMOVE_ENTIRE

Remove the entire line, even if the line passes through a character or a wall. Consider the line below.

 

image\wall1.gif

 

Setting iMaxWallPercent as 80 and passing LINE_REMOVE_ENTIRE will remove the red pixels as shown below.

 

image\wall3.gif

LINE_USE_GAP

Consider "gaps" in lines when performing line removal. If this flag is passed, the iGapLength parameter is used. If this flag is not passed, the iGapLength parameter is ignored.

LINE_USE_VARIANCE

Consider line variance when performing line removal. If this flag is passed, the iVariance parameter is used. If this flag is not passed, the parameter is ignored.