SetPaletteVariant (ImageKit Control/ Custom Method)

This method sets the palette information for a raster image

[Visual Basic] [ Boolean = ]imagekitcontrolname.SetPaletteVariant(Red As Variant, Green As Variant, Blue As Variant, ImageHandle As Variant)

[VB.NET] [ Boolean = ]imagekitcontrolname.SetPaletteVariant(ByRef Red As Object, ByRef Green As Object, ByRef Blue As Object, ImageHandle As Object)

[C#.NET] [ bool = ]imagekitcontrolname.SetPaletteVariant(ref object Red, ref object Green, ref object Blue, object ImageHandle)

* (x86) refers to the 32bit version, (x64) refers to the 64bit version.

Parameters

Name	Explanation
Red	Array of the retrieved red palette information
Green	Array of the retrieved green palette information
Blue	Array of the retrieved blue palette information
ImageHandle	The image handle of the raster image.

* (1) In Visual Basic pass the arguments as Red
(2) In VB.NET pass the arguments as Red
(3) In C#.NET pass the arguments as ref Red

Return Value

Returns True (nonzero) if successful, otherwise returns False (0).

Explanation

When the ImageHandle parameter contains a valid image handle
The image data that the ImageHandle parameter refers to will be processed.

When the ImageHandle parameter is omitted
The image data determined by the LayerNo property will be processed. If the LayerNo property is -1 (the base image) then the image data referred to by the ImageHandle property will be processed. If the value of the LayerNo property is between 0 and 99 then the image data referred to by the Layer(LayerNo).ImageHandle property will be processed.

The number of colors that can be set must be the same as the number of colors of the image.

To find out how many items are in the various RGB arrays, please refer to the PalCount property. The PalCount property value is refreshed when ever an image handle is set into the ImageHandle property of the Layer(LayerNo).ImageHandle property. Use the GetImageType method to retrieve the PalCount property value.

Also see the SetPalette method.