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



palette
An array of RasterColor containing the new palette to use.
startIndex
Index of the first palette entry to replace.
count
Number of palette entries to replace.
palette
An array of RasterColor containing the new palette to use.
startIndex
Index of the first palette entry to replace.
count
Number of palette entries to replace.
Sets the palette of this RasterImage object. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public Sub SetPalette( _
   ByVal palette() As RasterColor, _
   ByVal startIndex As Integer, _
   ByVal count As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim palette() As RasterColor
Dim startIndex As Integer
Dim count As Integer
 
instance.SetPalette(palette, startIndex, count)
C# 
public void SetPalette( 
   RasterColor[] palette,
   int startIndex,
   int count
)
C++/CLI 
public:
void SetPalette( 
   array<RasterColor>^ palette,
   int startIndex,
   int count
) 

Parameters

palette
An array of RasterColor containing the new palette to use.
startIndex
Index of the first palette entry to replace.
count
Number of palette entries to replace.

Example

Visual BasicCopy Code
Public Sub PaletteExample()
      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_RedPalette.bmp")

      ' Load the image as 8 bits/pixel
      Dim image As RasterImage = codecs.Load(srcFileName, 8, CodecsLoadByteOrder.Rgb, 1, 1)

      ' Get the palette of this image and change it to shades of red
      Dim palette As RasterColor() = image.GetPalette()
      Dim i As Integer = 0
      Do While i < palette.Length
         palette(i) = New RasterColor(i, 0, 0)
         i += 1
      Loop

      ' Set the palette back in the image then save the file
      image.SetPalette(palette, 0, palette.Length)
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, image.BitsPerPixel)

      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 PaletteExample()
   {
      RasterCodecs codecs = new RasterCodecs();

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

      // Load the image as 8 bits/pixel
      RasterImage image = codecs.Load(srcFileName, 8, CodecsLoadByteOrder.Rgb, 1, 1);

      // Get the palette of this image and change it to shades of red
      RasterColor[] palette = image.GetPalette();
      for(int i = 0; i < palette.Length; i++)
         palette[i] = new RasterColor(i, 0, 0);

      // Set the palette back in the image then save the file
      image.SetPalette(palette, 0, palette.Length);
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, image.BitsPerPixel);

      image.Dispose();

      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void PaletteExample(RasterImage image, Stream destStream)
{
   // image should be loaded as 8 bits/pixel
   // Get the palette of this image and change it to shades of red
   RasterColor[] palette = image.GetPalette();
   for (int i = 0; i < palette.Length; i++)
      palette[i] = new RasterColor(i, 0, 0);

   // Set the palette back in the image then save the file
   image.SetPalette(palette, 0, palette.Length);
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0);
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub PaletteExample(ByVal image As RasterImage, ByVal destStream As Stream)
   ' image should be loaded as 8 bits/pixel
   ' Get the palette of this image and change it to shades of red
   Dim palette As RasterColor() = image.GetPalette()
   Dim i As Integer = 0
   Do While i < palette.Length
      palette(i) = New RasterColor(i, 0, 0)
      i += 1
   Loop

   ' Set the palette back in the image then save the file
   image.SetPalette(palette, 0, palette.Length)
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0)
   image.Dispose()
End Sub

Remarks

The image data of a RasterImage object with BitsPerPixel values of 1, 2, 3, 4, 5, 6, 7 or 8 consists of an index into the image palette. You can get a copy of the palette used by using the GetPalette method.

You can change the palette used by the RasterImage object with the SetPalette method.

This method does not support signed images.

For more information, refer to RasterPalette and Introduction: Palette Handling.

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