Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Description

Excerpt

Returns the closest color to the specified RGB value that the file can support.

Signature
C#
C#
 public Color GetClosestColor(int red, int green, int blue)
Signature
vb.net
vb.net
Public Function GetClosestColor(ByVal red As Integer, ByVal green As Integer, ByVal blue As Integer) As Color
Parameters
Param
red
red

The red component of the desired color. Must be between 0 and 255.

Param
green
green

The green component of the desired color. Must be between 0 and 255.

Param
blue
blue

The blue component of the desired color. Must be between 0 and 255.

Returns

The closest color in the palette to the specified RGB value

Exceptions
Exception
System.ArgumentOutOfRangeException
System.ArgumentOutOfRangeException

If the given red, green, or blue value is not between 0 and 255.

Remarks

For .xls files, this will be the color in the palette that has the minimum difference between the specified RGB value and its RGB value. .xlsx files are not limited to colors in the palette, and will return a Color representing the specified RGB values exactly.

Example
Code Block
csharp
csharp
titleC#
Color clr = pal.GetClosestColor(162, 221, 139);
Code Block
vb.net
vb.net
titlevb.net
Dim clr As Color = pal.GetCloestColor(162, 221, 139)