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



color
Specifies the color to use for the region.
combineMode
The action to take regarding the existing image region, if one is defined.
color
Specifies the color to use for the region.
combineMode
The action to take regarding the existing image region, if one is defined.
Creates or updates the image region by adding a region that consists of all the pixels of a specified color. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public Sub AddColorToRegion( _
   ByVal color As RasterColor, _
   ByVal combineMode As RasterRegionCombineMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim color As RasterColor
Dim combineMode As RasterRegionCombineMode
 
instance.AddColorToRegion(color, combineMode)
C# 
public void AddColorToRegion( 
   RasterColor color,
   RasterRegionCombineMode combineMode
)
C++/CLI 
public:
void AddColorToRegion( 
   RasterColor color,
   RasterRegionCombineMode combineMode
) 

Parameters

color
Specifies the color to use for the region.
combineMode
The action to take regarding the existing image region, if one is defined.

Example

This example will load an image, adds a region all pixels of a specified color. It then fills the region with blue before saving it back to disk.

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

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddColorToRegion.bmp")

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

      ' Posterize the image to decrease the number of colors
      Dim posterize As PosterizeCommand = New PosterizeCommand(16)
      posterize.Run(image)

      ' Specify a pixel in the upper left of the displayed image
      Dim pt As LeadPoint = New LeadPoint(image.ImageWidth \ 8, image.ImageHeight \ 8)

      ' Adjust the point in case the view perspective is not TopLeft
      pt = image.PointToImage(RasterViewPerspective.TopLeft, pt)

      ' Get the color of the specified pixel
      Dim regionColor As RasterColor = image.GetPixelColor(pt.Y, pt.X)

      ' Create a region that includes all pixels of that color
      image.AddColorToRegion(regionColor, RasterRegionCombineMode.Set)

      ' Fill the region with blue
      Dim fill As FillCommand = New FillCommand(RasterColor.FromKnownColor(RasterKnownColor.Blue))
      fill.Run(image)

      ' Save the image
      codecs.Save(image, destFileName, 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 AddColorToRegionExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
      string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddColorToRegion.bmp");

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

      // Posterize the image to decrease the number of colors
      PosterizeCommand posterize = new PosterizeCommand(16);
      posterize.Run(image);

      // Specify a pixel in the upper left of the displayed image
      LeadPoint pt = new LeadPoint(image.ImageWidth / 8, image.ImageHeight / 8);

      // Adjust the point in case the view perspective is not TopLeft
      pt = image.PointToImage(RasterViewPerspective.TopLeft, pt);

      // Get the color of the specified pixel
      RasterColor regionColor = image.GetPixelColor(pt.Y, pt.X);

      // Create a region that includes all pixels of that color
      image.AddColorToRegion(regionColor, RasterRegionCombineMode.Set);

      // Fill the region with blue
      FillCommand fill = new FillCommand(RasterColor.FromKnownColor(RasterKnownColor.Blue));
      fill.Run(image);

      // Save the image
      codecs.Save(image, destFileName, 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 AddColorToRegionExample(RasterImage image, Stream destStream)
{
   // Posterize the image to decrease the number of colors
   PosterizeCommand posterize = new PosterizeCommand(16);
   posterize.Run(image);
   // Specify a pixel in the upper left of the displayed image
   LeadPoint pt = new LeadPoint(image.ImageWidth / 8, image.ImageHeight / 8);

   // Adjust the point in case the view perspective is not TopLeft
   pt = image.PointToImage(RasterViewPerspective.TopLeft, pt);

   // Get the color of the specified pixel
   RasterColor regionColor = image.GetPixelColor(pt.Y, pt.X);

   // Create a region that includes all pixels of that color
   image.AddColorToRegion(regionColor, RasterRegionCombineMode.Set);

   // Fill the region with blue
   FillCommand fill = new FillCommand(RasterColorConverter.FromColor(Colors.Blue));
   fill.Run(image);

   // Save the image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, destStream, RasterImageFormat.Png, 24);

   image.Dispose();
}
SilverlightVBCopy Code
Public Sub AddColorToRegionExample(ByVal image As RasterImage, ByVal destStream As Stream)
   ' Posterize the image to decrease the number of colors
   Dim posterize As PosterizeCommand = New PosterizeCommand(16)
   posterize.Run(image)
   ' Specify a pixel in the upper left of the displayed image
   Dim pt As LeadPoint = New LeadPoint(image.ImageWidth / 8, image.ImageHeight / 8)

   ' Adjust the point in case the view perspective is not TopLeft
   pt = image.PointToImage(RasterViewPerspective.TopLeft, pt)

   ' Get the color of the specified pixel
   Dim regionColor As RasterColor = image.GetPixelColor(pt.Y, pt.X)

   ' Create a region that includes all pixels of that color
   image.AddColorToRegion(regionColor, RasterRegionCombineMode.Set)

   ' Fill the region with blue
   Dim fill As FillCommand = New FillCommand(RasterColorConverter.FromColor(Colors.Blue))
   fill.Run(image)

   ' Save the image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, destStream, RasterImageFormat.Png, 24)

   image.Dispose()
End Sub

Remarks

You can use this method to simulate the use of a transparent color as follows:

  1. Call AddColorToRegion, with the transparent color in the color parameter and RasterRegionCombineMode.SetNot in the combineMode parameter.
  2. Call Leadtools.Drawing.RasterImagePainter.PaintRegion(Leadtools.RasterImage,System.IntPtr,Leadtools.LeadRect,Leadtools.LeadRect,Leadtools.LeadRect,Leadtools.LeadRect,Leadtools.Drawing.RasterPaintProperties) to paint the resulting region, which includes everything in the image, except the transparent color.

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

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

This function does not support signed images.

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