Flags Property (ILEADRasterHolePunchRemoveDoc)

Visual Basic example

Visual C++ example

 

Syntax

long Flags;

Overview

Refer to Using Imaging Common Dialogs

Remarks

Gets or sets the processing flags for the HolePunch dialog box.

The Flags property represents the behavior of the line removal process. Flags may be combined using a bitwise OR. Possible values are:

Value

Meaning

HOLEPUNCH_SINGLE_REGION

For each Hole punch found by the Hole Punch Remove dialog, the removed Hole punch is added to an internal single region. When the Hole Punch Remove dialog ends, either the DocCleanBitmap property or the DocCleanRgn member will reference a region that contains all the removed Hole punches. If HOLEPUNCH_LEAD_REGION is also set, the DocCleanBitmap property will be set to a bitmap that has a LEAD region that contains all the removed Hole punches. If HOLEPUNCH_LEAD_REGION is not set, DocCleanRgn is set to a Windows region that contains all the removed Hole punches. When the region (either LEAD or Windows) is no longer needed, it must be destroyed.

HOLEPUNCH_LEAD_REGION

When the Hole Punch Remove dialog ends, the DocCleanBitmap property is updated with a copy of the bitmap that also contains a region with all the removed Hole punches. This flag must be used in conjunction with HOLEPUNCH_SINGLE_REGION. To use this flag set Flags to HOLEPUNCH_SINGLE_REGION Or HOLEPUNCH_LEAD_REGION. The DocCleanBitmap member will be updated when the Hole Punch Remove dialog ends.

HOLEPUNCH_IMAGE_UNCHANGED

The original image is unchanged.

HOLEPUNCH_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 for all fields of the HOLEPUNCH Record (structure) is pixels.

HOLEPUNCH_USE_SIZE

Use the MinHoleWidth, MinHoleHeight, MaxHoleWidth, MaxHoleHeight properties to indicate the size of the Hole punches to remove. If this flag is not set, default values for the four sizes will be used. If HOLEPUNCH_USE_DPI is set, the defaults are calculated from the image DPI. Otherwise, the defaults are calculated from the image width and height.

HOLEPUNCH_USE_COUNT

Use the MinHoleCount and MaxHoleCount properties to indicate the number of Hole punches to remove. If this flag is not set, default values for the two count values will be used. These default values are as follows: MinHoleCount = 3 and MaxHoleCount = 3.

HOLEPUNCH_USE_LOCATION

Use the Location property to indicate the location of the hole punches to remove. If this flag is not set, a default of HOLEPUNCH_LEFT will be used.

See Also

Elements

ShowHolePunchRemoveDlg method