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




This property is updated with a shallow copy of the image that also has a region that contains the hole punches.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property ImageRegion As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As HolePunchRemoveCommand
Dim value As RasterImage
 
value = instance.ImageRegion
C# 
public RasterImage ImageRegion {get;}
Managed Extensions for C++ 
public: __property RasterImage get_ImageRegion();
C++/CLI 
public:
property RasterImage ImageRegion {
   RasterImage get();
}

Return Value

A shallow copy of the image that also has a region that contains the hole punches.

Example

Visual BasicCopy Code
ImageProcessing.Core.HolePunchRemoveCommand.ImageRegion
   Public WithEvents holePunchCommand_S3 As HolePunchRemoveCommand
   Public Sub ImageRegionPropertyExample()
      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_S3 = New HolePunchRemoveCommand
      holePunchCommand_S3.Flags = HolePunchRemoveCommandFlags.UseDpi Or HolePunchRemoveCommandFlags.UseSize Or HolePunchRemoveCommandFlags.UseLocation Or HolePunchRemoveCommandFlags.SingleRegion Or HolePunchRemoveCommandFlags.LeadRegion
      holePunchCommand_S3.Location = HolePunchRemoveCommandLocation.Left
      holePunchCommand_S3.MaximumHoleHeight = leadImage.Height
      holePunchCommand_S3.MaximumHoleWidth = leadImage.Width
      holePunchCommand_S3.MinimumHoleHeight = 0
      holePunchCommand_S3.MinimumHoleWidth = 0
      holePunchCommand_S3.Run(leadImage)

      RasterCodecs.Shutdown()
   End Sub

   Private Sub HolePunchCommand_HolePunchRemove_S3(ByVal sender As Object, ByVal e As HolePunchRemoveCommandEventArgs) Handles holePunchCommand_S3.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
C#Copy Code
ImageProcessing.Core.HolePunchRemoveCommand.ImageRegion 
      public void ImageRegionPropertyExample() 
      { 
         // 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(); 
         command.HolePunchRemove  += new EventHandler<HolePunchRemoveCommandEventArgs>(HolePunchRemoveEvent_S3); 
         command.Flags = HolePunchRemoveCommandFlags.UseDpi | HolePunchRemoveCommandFlags.UseSize | HolePunchRemoveCommandFlags.UseLocation | HolePunchRemoveCommandFlags.SingleRegion | HolePunchRemoveCommandFlags.LeadRegion; 
         command.Location = HolePunchRemoveCommandLocation.Left; 
         command.MaximumHoleHeight = image.Height; 
         command.MaximumHoleWidth = image.Width; 
         command.MinimumHoleHeight = 0; 
         command.MinimumHoleWidth = 0; 
         command.Run(image); 
 
         RasterCodecs.Shutdown(); 
      } 
 
      private void HolePunchRemoveEvent_S3(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; 
      }

Remarks

If HolePunchRemoveCommandFlags.SingleRegion| HolePunchRemoveCommandFlags.LeadRegion has been set in the Flags property, then when HolePunchRemoveCommand returns, this property is updated with a shallow copy of the image that also has a region that contains the hole punches. So set Flags to HolePunchRemoveCommandFlags.SingleRegion| HolePunchRemoveCommandFlags.LeadRegion. It is the programmer's responsibility to dispose of the region when it is no longer needed.

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