HolePunchRemoveCommand Constructor(HolePunchRemoveCommandFlags,HolePunchRemoveCommandLocation,int,int,int,int,int,int)

Summary

Initializes a new HolePunchRemoveCommand with explicit parameters.

Syntax

C++

public HolePunchRemoveCommand( 
   HolePunchRemoveCommandFlags flags, 
   HolePunchRemoveCommandLocation location, 
   int minimumHoleCount, 
   int maximumHoleCount, 
   int minimumHoleWidth, 
   int minimumHoleHeight, 
   int maximumHoleWidth, 
   int maximumHoleHeight 
)

Public Function New( _ 
   ByVal flags As HolePunchRemoveCommandFlags, _ 
   ByVal location As HolePunchRemoveCommandLocation, _ 
   ByVal minimumHoleCount As Integer, _ 
   ByVal maximumHoleCount As Integer, _ 
   ByVal minimumHoleWidth As Integer, _ 
   ByVal minimumHoleHeight As Integer, _ 
   ByVal maximumHoleWidth As Integer, _ 
   ByVal maximumHoleHeight As Integer _ 
)

public: 
HolePunchRemoveCommand(  
   HolePunchRemoveCommandFlags flags, 
   HolePunchRemoveCommandLocation location, 
   int minimumHoleCount, 
   int maximumHoleCount, 
   int minimumHoleWidth, 
   int minimumHoleHeight, 
   int maximumHoleWidth, 
   int maximumHoleHeight 
)

Parameters

flags
Flags that determine the behavior of the hole punch removal process.

location
Flag that indicates the location within the document of the hole punches to remove.

minimumHoleCount
Minimum number of holes to detect. This member is valid only if HolePunchRemoveCommandFlags.UseCount flag is set.

maximumHoleCount
Maximum number of holes to detect. This member is valid only if HolePunchRemoveCommandFlags.UseCount flag is set.

minimumHoleWidth
The minimum width of one of the holes of the hole punch configuration to be removed. If HolePunchRemoveCommandFlags.UseDpi flag is set, units are in thousandths of an inch, otherwise units are in pixels. This parameter is valid only if HolePunchRemoveCommandFlags.UseSize is set.

minimumHoleHeight
The minimum height of one of the holes of the hole punch configuration to be removed. If HolePunchRemoveCommandFlags.UseDpi flag is set, units are in thousandths of an inch, otherwise units are in pixels. This parameter is valid only if HolePunchRemoveCommandFlags.UseSize is set.

maximumHoleWidth
The maximum width of one of the holes of the hole punch configuration to be removed. If HolePunchRemoveCommandFlags.UseDpi flag is set, units are in thousandths of an inch, otherwise units are in pixels. This parameter is valid only if HolePunchRemoveCommandFlags.UseSize is set.

maximumHoleHeight
The maximum height of one of the holes of the hole punch configuration to be removed. If HolePunchRemoveCommandFlags.UseDpi flag is set, units are in thousandths of an inch, otherwise units are in pixels. This parameter is valid only if HolePunchRemoveCommandFlags.UseSize is set.

Example

Run the HolePunchRemoveCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
public void HolePunchRemoveConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Clean.tif")); 
 
   // Prepare the command 
   HolePunchRemoveCommand command = new HolePunchRemoveCommand(HolePunchRemoveCommandFlags.UseDpi | HolePunchRemoveCommandFlags.UseCount | HolePunchRemoveCommandFlags.UseLocation | HolePunchRemoveCommandFlags.SingleRegion, 
         HolePunchRemoveCommandLocation.Left, 2, 4, 0, 0, image.Width, image.Height); 
   command.HolePunchRemove += new EventHandler<HolePunchRemoveCommandEventArgs>(HolePunchRemoveEvent_S2); 
   command.Run(image); 
   image.SetRegion(null, command.Region, RasterRegionCombineMode.Set); 
 
} 
 
private void HolePunchRemoveEvent_S2(object sender, HolePunchRemoveCommandEventArgs e) 
{ 
   MessageBox.Show("Size " + "( " + e.BoundingRectangle.Left + ", " + e.BoundingRectangle.Top + ") - " + "( " + e.BoundingRectangle.Right + ", " + e.BoundingRectangle.Bottom + ")" + 
      "\n Hole Index " + e.HoleIndex.ToString() + 
      "\n Holes Total Count " + e.HoleTotalCount.ToString() + 
      "\n Black Count " + e.BlackCount.ToString() + 
      "\n White Count " + e.WhiteCount.ToString()); 
   e.Status = RemoveStatus.Remove; 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
 
Public WithEvents holePunchCommand_S2 As HolePunchRemoveCommand 
Public Sub HolePunchRemoveConstructorExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Clean.tif")) 
 
   ' Prepare the command 
   holePunchCommand_S2 = New HolePunchRemoveCommand(HolePunchRemoveCommandFlags.UseDpi Or 
                                                    HolePunchRemoveCommandFlags.UseSize Or 
                                                    HolePunchRemoveCommandFlags.UseLocation Or 
                                                    HolePunchRemoveCommandFlags.SingleRegion, 
                                                    HolePunchRemoveCommandLocation.Left, 
                                                    0, 0, 0, 0, leadImage.Width, leadImage.Height) 
   holePunchCommand_S2.Run(leadImage) 
   leadImage.SetRegion(Nothing, holePunchCommand_S2.Region, RasterRegionCombineMode.Set) 
 
End Sub 
 
Private Sub HolePunchCommand_HolePunchRemove_S2(ByVal sender As Object, ByVal e As HolePunchRemoveCommandEventArgs) Handles holePunchCommand_S2.HolePunchRemove 
   MessageBox.Show("Size " + "( " + e.BoundingRectangle.Left.ToString() + ", " + 
                   e.BoundingRectangle.Top.ToString() + ") - " + "( " + 
                   e.BoundingRectangle.Right.ToString() + ", " + 
                   e.BoundingRectangle.Bottom.ToString() + ")" + 
      Chr(13) + " Hole Index " + e.HoleIndex.ToString() + 
      Chr(13) + " Holes Total Count " + e.HoleTotalCount.ToString() + 
      Chr(13) + " Black Count " + e.BlackCount.ToString() + 
      Chr(13) + " White Count " + e.WhiteCount.ToString()) 
   e.Status = RemoveStatus.Remove 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

HolePunchRemoveCommand Class

HolePunchRemoveCommand Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.4.3