ImageRegion Property (HolePunchRemoveCommand)

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public RasterImage ImageRegion {get;}

'Declaration
 
Public ReadOnly Property ImageRegion As RasterImage

'Usage
 
Dim instance As HolePunchRemoveCommand
Dim value As RasterImage
 
value = instance.ImageRegion

public RasterImage ImageRegion {get;}

 get_ImageRegion();

public:
property RasterImage^ ImageRegion {
   RasterImage^ get();
}

Property Value

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

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.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.Core

Public WithEvents holePunchCommand_S3 As HolePunchRemoveCommand
Public Sub ImageRegionPropertyExample()
   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_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)

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

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Core;

public void ImageRegionPropertyExample()
{
   // 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();
   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);

}

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;
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

function ImageRegionPropertyExample()
{
   var codecs = new Leadtools.Codecs.RasterCodecs();
   codecs.throwExceptionsOnInvalidImages = true;

   // Load the image
   var srcFileName = "Assets\\clean.tif";
   return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
      return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile));
   }).then(function (image) {
      // Prepare the command
      with (Leadtools.ImageProcessing.Core) {
         var command = new HolePunchRemoveCommand();
         command.addEventListener("holepunchremove", 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);
      }
   });
}

function HolePunchRemoveEvent_S3(e)
{
   console.error("Size " + "( " + e.boundingRectangle.x + ", " + e.boundingRectangle.y + ") - " + "( " + e.boundingRectangle.width + ", " + e.boundingRectangle.height + ")" +
      "\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 = Leadtools.ImageProcessing.Core.RemoveStatus.remove;
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Core;

      
public async Task ImageRegionPropertyExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Clean.tif";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // 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);

}

private void HolePunchRemoveEvent_S3(object sender, HolePunchRemoveCommandEventArgs e)
{
   Debug.WriteLine("Size " + "( " + e.BoundingRectangle.X + ", " + e.BoundingRectangle.Y + ") - " + "( " + e.BoundingRectangle.Width + ", " + e.BoundingRectangle.Height + ")" +
      "\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;
}

Target Platforms

Reference

HolePunchRemoveCommand Class
HolePunchRemoveCommand Members