Flags

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

Value

Meaning

BORDER_SINGLE_REGION:

For each border found by the BorderRemove method, if the DocCleanSuccess propertyDocCleanSuccessproperty is set to SUCCESS_REMOVE in the BorderRemove eventBorderRemoveevent, the removed border is added to an internal single region. If the DocCleanSuccess property is set to SUCCESS_NOREMOVE, the border is not added to the single region. When the BorderRemove method returns, either

 

1. LEADRasterView.Raster will contain a region that contains all removed borders. This is the case if the BORDER_LEAD_REGION has also been set. This region can be destroyed using the DeleteRgnHandle method of LEADRasterView.Raster

 

2. the hDocCleanRgn property will reference a Windows region that contains all the removed borders. This is the case if the BORDER_LEAD_REGION has NOT been set. When hDocCleanRgn is no longer needed, it must be destroyed .When the region (either LEAD or Windows) is no longer needed, it must be destroyed.

BORDER_LEAD_REGION

This flag must be used in conjunction with BORDER_LEAD_SINGLE_REGION. If this flag is set, the LEADRasterView.Raster will contain a region that contains all removed borders when the BorderRemove method returns. This region can be destroyed using the DeleteRgnHandle method of LEADRasterView.Raster.

BORDER_IMAGE_UNCHANGED

The original image is unchanged.

BORDER_CALLBACK_REGION

The BorderRemove eventBorderRemoveevent receives a Windows region that contains the current border to be removed. Setting this flag lets the user create his or her own composite of removed borders by combining the regions received by the event, if the DocCleanSuccess propertyDocCleanSuccessproperty is 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 BORDER_SINGLE_REGION is set in uFlags. When the region received by the event is no longer needed, it must be destroyed.

BORDER_USE_VARIANCE

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