LEADTOOLS (Leadtools assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
HasRegion Property
See Also 
Leadtools Namespace > RasterImage Class : HasRegion Property



Determines whether this RasterImage has a region. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property HasRegion As Boolean
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim value As Boolean
 
value = instance.HasRegion
C# 
public bool HasRegion {get;}
C++/CLI 
public:
property bool HasRegion {
   bool get();
}

Property Value

true if this RasterImage has a region, otherwise; false.

Example

Visual BasicCopy Code
Public Sub RegionExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim destFileName1 As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_InvertRegion.bmp")
      Dim destFileName2 As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_InvertNoRegion.bmp")

      ' Load the image
      Dim image As RasterImage = codecs.Load(srcFileName)

      ' The image should have no region
      Console.WriteLine("After loading, HasRegion = {0}", image.HasRegion)
      Debug.Assert((Not image.HasRegion))

      ' Add a region to the image
      Dim rc As LeadRect = New LeadRect(0, 0, image.Width \ 4, image.Height \ 4)
      image.AddEllipseToRegion(Nothing, rc, RasterRegionCombineMode.Set)

      ' The image should have a region now
      Console.WriteLine("After AddEllipseToRegion, HasRegion = {0}", image.HasRegion)
      Debug.Assert(image.HasRegion)

      ' Invert this image and save it to a file
      Dim command As InvertCommand = New InvertCommand()
      command.Run(image)
      codecs.Save(image, destFileName1, RasterImageFormat.Bmp, 24)

      ' Get rid of the region
      image.MakeRegionEmpty()

      ' The image should not have a region now
      Console.WriteLine("After MakeRegionEmpty, HasRegion = {0}", image.HasRegion)
      Debug.Assert((Not image.HasRegion))

      ' Invert again and save it
      command.Run(image)
      codecs.Save(image, destFileName2, RasterImageFormat.Bmp, 24)

      image.Dispose()
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void RegionExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
      string destFileName1 = Path.Combine(LEAD_VARS.ImagesDir, "Image1_InvertRegion.bmp");
      string destFileName2 = Path.Combine(LEAD_VARS.ImagesDir, "Image1_InvertNoRegion.bmp");

      // Load the image
      RasterImage image = codecs.Load(srcFileName);

      // The image should have no region
      Console.WriteLine("After loading, HasRegion = {0}", image.HasRegion);
      Debug.Assert(!image.HasRegion);

      // Add a region to the image
      LeadRect rc = new LeadRect(0, 0, image.Width / 4, image.Height / 4);
      image.AddEllipseToRegion(null, rc, RasterRegionCombineMode.Set);

      // The image should have a region now
      Console.WriteLine("After AddEllipseToRegion, HasRegion = {0}", image.HasRegion);
      Debug.Assert(image.HasRegion);

      // Invert this image and save it to a file
      InvertCommand command = new InvertCommand();
      command.Run(image);
      codecs.Save(image, destFileName1, RasterImageFormat.Bmp, 24);

      // Get rid of the region
      image.MakeRegionEmpty();

      // The image should not have a region now
      Console.WriteLine("After MakeRegionEmpty, HasRegion = {0}", image.HasRegion);
      Debug.Assert(!image.HasRegion);

      // Invert again and save it
      command.Run(image);
      codecs.Save(image, destFileName2, RasterImageFormat.Bmp, 24);

      image.Dispose();
      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void RegionExample(RasterImage image, Stream destStream1, Stream destStream2)
{
   RasterCodecs codecs = new RasterCodecs();
   // The image should have no region
   Debug.WriteLine("After loading, HasRegion = {0}", image.HasRegion);
   Debug.Assert(!image.HasRegion);

   // Add a region to the image
   LeadRect rc = new LeadRect(0, 0, image.Width / 4, image.Height / 4);
   image.AddRectangleToRegion(null, rc, RasterRegionCombineMode.Set);

   // The image should have a region now
   Debug.WriteLine("After AddRectangleToRegion, HasRegion = {0}", image.HasRegion);
   Debug.Assert(image.HasRegion);

   // Invert this image and save it to a file
   InvertCommand command = new InvertCommand();
   command.Run(image);
   codecs.Save(image, destStream1, RasterImageFormat.Bmp, 0);

   // Get rid of the region
   image.MakeRegionEmpty();

   // The image should not have a region now
   Debug.WriteLine("After MakeRegionEmpty, HasRegion = {0}", image.HasRegion);
   Debug.Assert(!image.HasRegion);

   // Invert again and save it
   command.Run(image);
   codecs.Save(image, destStream2, RasterImageFormat.Bmp, 0);

   image.Dispose();
}
SilverlightVBCopy Code
Public Sub RegionExample(ByVal image As RasterImage, ByVal destStream1 As Stream, ByVal destStream2 As Stream)
   Dim codecs As RasterCodecs = New RasterCodecs()
   ' The image should have no region
   Debug.WriteLine("After loading, HasRegion = {0}", image.HasRegion)
   Debug.Assert((Not image.HasRegion))

   ' Add a region to the image
   Dim rc As LeadRect = New LeadRect(0, 0, image.Width / 4, image.Height / 4)
   image.AddRectangleToRegion(Nothing, rc, RasterRegionCombineMode.Set)

   ' The image should have a region now
   Debug.WriteLine("After AddRectangleToRegion, HasRegion = {0}", image.HasRegion)
   Debug.Assert(image.HasRegion)

   ' Invert this image and save it to a file
   Dim command As InvertCommand = New InvertCommand()
   command.Run(image)
   codecs.Save(image, destStream1, RasterImageFormat.Bmp, 0)

   ' Get rid of the region
   image.MakeRegionEmpty()

   ' The image should not have a region now
   Debug.WriteLine("After MakeRegionEmpty, HasRegion = {0}", image.HasRegion)
   Debug.Assert((Not image.HasRegion))

   ' Invert again and save it
   command.Run(image)
   codecs.Save(image, destStream2, RasterImageFormat.Bmp, 0)

   image.Dispose()
End Sub

Remarks

When an image has a region, the LEADTOOLS methods that modify the pixel values (for example Leadtools.ImageProcessing.Color.PosterizeCommand) act on the region, rather than the whole image. In addition, the LEADTOOLS methods that flip, reverse, rotate, shear, or resize an image also transform the region to match the image. For example, if you were to shear the image that had a rectangular region, the region would become a parallelogram.

To remove an image region, use MakeRegionEmpty.

For more information, refer to Working with the Existing Region.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only), Windows Phone 7

See Also