←Select platform

Is this page helpful?

In this page

IsPaletteIndex Property

Summary
Gets a value that determines whether this RasterColor is a palette index value.
Syntax
C#
C++/CLI
Python
public bool IsPaletteIndex { get; } 
public: 
property bool IsPaletteIndex { 
   bool get(); 
} 
IsPaletteIndex # get  (RasterColor) 

Property Value

true if this RasterColor is a palette index; false, otherwise.

Remarks

A RasterColor object can be a true RGB color or an index value into the palette of an image.

If the value of IsPaletteIndex is true, then this color does not contain a true RGB value, instead, the value stored is an index into the palette of an image. To get the index value, use ToRgb. To get the true RGB value, use RasterImage.GetTrueColorValue.

If the value of IsPaletteIndex is false, then this color contains a true RGB value.

To create a color that is a palette index, use the FromPaletteIndex method.

Example
C#
Copied to clipboard
using Leadtools; 
 
 
public void RasterColorArgbExample() 
{ 
   const int A = 128, R = 24, G = 87, B = 134; 
 
   // Create a RasterColor 
   RasterColor clr = new RasterColor(A, R, G, B); 
 
   // Make sure the color is correct 
   Assert.IsTrue(clr.A == A); 
   Assert.IsTrue(clr.R == R); 
   Assert.IsTrue(clr.G == G); 
   Assert.IsTrue(clr.B == B); 
 
   // The ARGB values represent real color components. This is NOT a palette index. 
   Assert.IsFalse(clr.IsPaletteIndex); 
 
   // Show its value 
   Console.WriteLine(clr); 
 
   // Show the A, R, G and B values 
   Console.WriteLine("Alpha value: " + clr.A); 
   Console.WriteLine("Red value: " + clr.R); 
   Console.WriteLine("Green value: " + clr.G); 
   Console.WriteLine("Blue value: " + clr.B); 
 
   // When the color is a palette index, the ARGB values are not color components 
   int index = 128; 
   RasterColor peletteIndex = RasterColor.FromPaletteIndex(index); 
   Assert.IsTrue(peletteIndex.IsPaletteIndex); 
   // The use the ToRGB method to obtain the index 
   Assert.IsTrue(peletteIndex.ToRgb() == index); 
} 
Requirements

Target Platforms

Help Version 23.0.2024.8.28
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.