Values that determine the behavior of the hole punch removal process.
Syntax
| Visual Basic (Declaration) | |
|---|---|
<FlagsAttribute()> Public Enum HolePunchRemoveCommandFlags Inherits Enum | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
| |
| C# | |
|---|---|
[FlagsAttribute()] public enum HolePunchRemoveCommandFlags : Enum | |
| C++/CLI | |
|---|---|
[FlagsAttribute()] public enum class HolePunchRemoveCommandFlags : public Enum | |
Members
| Member | Description |
|---|---|
| None | No flags. |
| UseDpi | The unit of measure for all properties of the HolePunchRemoveCommand 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 properties of the HolePunchRemoveCommand is pixels. |
| SingleRegion | For each hole punch encountered by HolePunchRemoveCommand, if the HolePunchRemoveCommandEventArgs.Status is set to RemoveStatus.Remove, the removed hole punch is added to an internal single region. If it is set to RemoveStatus.NoRemove, the hole punch is not added to the single region. When HolePunchRemoveCommand returns, either HolePunchRemoveCommand.ImageRegion or HolePunchRemoveCommand.Region will reference a region that contains all the removed hole punchs. If LeadRegion is also set, HolePunchRemoveCommand.ImageRegion will be updated with a shallow copy of image that has a LEAD region that contains all the removed hole punchs. If LeadRegion is not set, HolePunchRemoveCommand.Region is updated with a Windows region that contains all the removed hole punchs. When the region (either LEAD or Windows) is no longer needed, it must be disposed (either region allocated in HolePunchRemoveCommand.ImageRegion or HolePunchRemoveCommand.Region). |
| LeadRegion | When HolePunchRemoveCommand returns, HolePunchRemoveCommand.ImageRegion is updated with a shallow copy of the Run method image that also contains a region with all the removed hole punchs. This flag must be used in conjunction with SingleRegion. So set HolePunchRemoveCommand.Flags to SingleRegion | LeadRegion |
| CallBackRegion | The HolePunchRemoveCommandEventArgs.Region property receives a Windows region that contains the current hole punch to be removed. Setting this flag lets the user create his or her own composite of removed hole punches by combining the regions received, if HolePunchRemoveCommandEventArgs.Status is set to RemoveStatus.Remove. The regions can be combined using a logical OR operator. Combining all regions received when the HolePunchRemoveCommandEventArgs.Status is set to RemoveStatus.Remove results in a region identical to the region created when SingleRegion is set in HolePunchRemoveCommand.Flags. For an example, refer to HolePunchRemoveCommand. When the region received by the HolePunchRemoveCommandEventArgs.Region property is no longer needed, it must be disposed of. |
| ImageUnchanged | The Run method image is unchanged. |
| UseSize | /// Use the HolePunchRemoveCommand.MinimumHoleWidth, HolePunchRemoveCommand.MinimumHoleHeight, HolePunchRemoveCommand.MaximumHoleWidth, HolePunchRemoveCommand.MaximumHoleHeight properties of the HolePunchRemoveCommand 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 HolePunchRemoveCommandFlags.UseDpi is set, the defaults are calculated from the image DPI. Otherwise, the defaults are calculated from the image width and height. |
| UseCount | Use the HolePunchRemoveCommand.MinimumHoleCount and HolePunchRemoveCommand.MaximumHoleCount properties of the HolePunchRemoveCommand 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: HolePunchRemoveCommand.MinimumHoleCount = 3 and HolePunchRemoveCommand.MaximumHoleCount = 3. |
| UseLocation | Use the HolePunchRemoveCommand.Location property of the HolePunchRemoveCommand to indicate the location of the hole punches to remove. If this flag is not set, a default of HolePunchRemoveCommandLocation.Left will be used. |
Remarks
You can use a bitwise OR (|) to specify one or more flags.
Inheritance Hierarchy
System.Object
System.ValueType
System.Enum
Leadtools.ImageProcessing.Core.HolePunchRemoveCommandFlags
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family