Leadtools.ImageProcessing.Core Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.10
HolePunchRemoveCommandEventArgs Constructor
See Also  Example
Leadtools.ImageProcessing.Core Namespace > HolePunchRemoveCommandEventArgs Class : HolePunchRemoveCommandEventArgs Constructor




image
RasterImage object that contains the affected image
region
Windows region representing one of the holes of the hole punch pattern. It is the programmer's responsibility to dispose of this region when it is no longer needed.
boundingRectangle
The bounding rectangle of one of the holes in a hole punch pattern.
holeIndex
Index of the hole within a hole punch pattern. The holes are numbered from 1 to n, where n is the total number of holes in the hole punch pattern.
holeTotalCount
The total number of holes that make up the hole punch pattern. This value will not change for a particular call to HolePunchRemoveCommand.
whiteCount
Total number of white pixels in one of the holes of a hole punch pattern.
blackCount
Total number of black pixels in one of the holes of a hole punch pattern.
Initializes a new HolePunchRemoveCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal image As RasterImage, _
   ByVal region As Region, _
   ByVal boundingRectangle As Rectangle, _
   ByVal holeIndex As Integer, _
   ByVal holeTotalCount As Integer, _
   ByVal whiteCount As Integer, _
   ByVal blackCount As Integer _
)
Visual Basic (Usage)Copy Code
Dim image As RasterImage
Dim region As Region
Dim boundingRectangle As Rectangle
Dim holeIndex As Integer
Dim holeTotalCount As Integer
Dim whiteCount As Integer
Dim blackCount As Integer
 
Dim instance As HolePunchRemoveCommandEventArgs(image, region, boundingRectangle, holeIndex, holeTotalCount, whiteCount, blackCount)
C# 
public HolePunchRemoveCommandEventArgs( 
   RasterImage image,
   Region region,
   Rectangle boundingRectangle,
   int holeIndex,
   int holeTotalCount,
   int whiteCount,
   int blackCount
)
Managed Extensions for C++ 
public: HolePunchRemoveCommandEventArgs( 
   RasterImage image,
   Region region,
   Rectangle boundingRectangle,
   int holeIndex,
   int holeTotalCount,
   int whiteCount,
   int blackCount
)
C++/CLI 
public:
HolePunchRemoveCommandEventArgs( 
   RasterImage image,
   Region region,
   Rectangle boundingRectangle,
   int holeIndex,
   int holeTotalCount,
   int whiteCount,
   int blackCount
)

Parameters

image
RasterImage object that contains the affected image
region
Windows region representing one of the holes of the hole punch pattern. It is the programmer's responsibility to dispose of this region when it is no longer needed.
boundingRectangle
The bounding rectangle of one of the holes in a hole punch pattern.
holeIndex
Index of the hole within a hole punch pattern. The holes are numbered from 1 to n, where n is the total number of holes in the hole punch pattern.
holeTotalCount
The total number of holes that make up the hole punch pattern. This value will not change for a particular call to HolePunchRemoveCommand.
whiteCount
Total number of white pixels in one of the holes of a hole punch pattern.
blackCount
Total number of black pixels in one of the holes of a hole punch pattern.

Example

Visual BasicCopy Code
ImageProcessing.Core.HolePunchRemoveCommandEventArgs.HolePunchRemoveCommandEventArgs
   Public WithEvents holePunchCommand_S4 As HolePunchRemoveCommand
   Public Sub HolePunchRemoveCommandEventArgsExample()
      RasterCodecs.Startup()
      Dim codecs As New RasterCodecs()
      codecs.ThrowExceptionsOnInvalidImages = True

      Dim leadImage As RasterImage = codecs.Load("C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Clean.tif")

      ' Prepare the command
      holePunchCommand_S4 = New HolePunchRemoveCommand(HolePunchRemoveCommandFlags.CallBackRegion Or HolePunchRemoveCommandFlags.UseDpi Or HolePunchRemoveCommandFlags.UseSize Or HolePunchRemoveCommandFlags.UseLocation Or HolePunchRemoveCommandFlags.SingleRegion, HolePunchRemoveCommandLocation.Left, 0, 0, 0, 0, leadImage.Width, leadImage.Height)
      holePunchCommand_S4.Run(leadImage)

      RasterCodecs.Shutdown()
   End Sub

   Private Sub HolePunchCommand_HolePunchRemove_S4(ByVal sender As Object, ByVal e As HolePunchRemoveCommandEventArgs) Handles holePunchCommand_S4.HolePunchRemove
      Dim ee As HolePunchRemoveCommandEventArgs = New HolePunchRemoveCommandEventArgs(e.Image, e.Region, e.BoundingRectangle, e.HoleIndex, e.HoleTotalCount, e.WhiteCount, e.BlackCount)
      e.Status = RemoveStatus.Remove

      If Not (e.Region Is Nothing) Then
         e.Image.AddGdiPlusRegionToRegion(Nothing, e.Region, RasterRegionCombineMode.AndNotRegion)
      End If
   End Sub
C#Copy Code
ImageProcessing.Core.HolePunchRemoveCommandEventArgs.HolePunchRemoveCommandEventArgs 
      public void HolePunchRemoveCommandEventArgsExample() 
      { 
         // Load an image 
         RasterCodecs.Startup(); 
         RasterCodecs codecs = new RasterCodecs(); 
         codecs.ThrowExceptionsOnInvalidImages = true; 
 
         RasterImage image = codecs.Load(@"C:\Program Files\LEAD Technologies\LEADTOOLS 15\Images\Clean.tif"); 
 
         // Prepare the command 
         HolePunchRemoveCommand command = new HolePunchRemoveCommand(HolePunchRemoveCommandFlags.CallBackRegion | HolePunchRemoveCommandFlags.UseDpi | HolePunchRemoveCommandFlags.UseCount |HolePunchRemoveCommandFlags.UseLocation | HolePunchRemoveCommandFlags.SingleRegion, HolePunchRemoveCommandLocation.Left, 2, 4, 0, 0, image.Width, image.Height); 
         command.HolePunchRemove += new EventHandler<HolePunchRemoveCommandEventArgs>(HolePunchRemoveEvent_S4); 
         command.Run(image); 
 
         RasterCodecs.Shutdown(); 
      } 
 
      private void HolePunchRemoveEvent_S4(object sender, HolePunchRemoveCommandEventArgs e) 
      { 
         HolePunchRemoveCommandEventArgs ee = new HolePunchRemoveCommandEventArgs(e.Image, e.Region, e.BoundingRectangle, e.HoleIndex, e.HoleTotalCount, e.WhiteCount, e.BlackCount); 
         e.Status= RemoveStatus.Remove; 
         if(e.Region != null) 
         { 
            e.Image.AddGdiPlusRegionToRegion(null, e.Region, RasterRegionCombineMode.AndNotRegion); 
         } 
      }

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

See Also