FromKnownColor Method (RasterColorHelper)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public static RasterColor FromKnownColor( 
   RasterKnownColor knownColor
)

'Declaration
 
Public Shared Function FromKnownColor( _
   ByVal knownColor As RasterKnownColor _
) As RasterColor

'Usage
 
Dim knownColor As RasterKnownColor
Dim value As RasterColor
 
value = RasterColorHelper.FromKnownColor(knownColor)

public static RasterColor FromKnownColor( 
   RasterKnownColor knownColor
)

 function Leadtools.RasterColorHelper.FromKnownColor( 
   knownColor 
)

public:
static RasterColor FromKnownColor( 
   RasterKnownColor knownColor
)

Parameters

knownColor: One of the RasterKnownColor enumeration members.

Return Value

The new RasterColor object.

You can use the RasterKnownColor enumeration to construct RasterColor objects from colors known by name.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub FromKnownColorExample()
   ' Create a yellow color (R = 255, G = 255, B = 0)
   Dim clr1 As New RasterColor(255, 255, 0)

   ' Now create the same color using the "Yellow" known color
   Dim clr2 As RasterColor = RasterColor.FromKnownColor(RasterKnownColor.Yellow)

   ' Make sure both colors have the same value
   Debug.Assert(clr1.A = clr2.A)
   Debug.Assert(clr1.R = clr2.R)
   Debug.Assert(clr1.G = clr2.G)
   Debug.Assert(clr1.B = clr2.B)
End Sub

public void FromKnownColorExample()
{
   // Create a yellow color (R = 255, G = 255, B = 0)
   RasterColor clr1 = new RasterColor(255, 255, 0);

   // Now create the same color using the "Yellow" known color
   RasterColor clr2 = RasterColor.FromKnownColor(RasterKnownColor.Yellow);

   // Make sure both colors have the same value
   Debug.Assert(clr1.A == clr2.A);
   Debug.Assert(clr1.R == clr2.R);
   Debug.Assert(clr1.G == clr2.G);
   Debug.Assert(clr1.B == clr2.B);
}

RasterColorExamples.prototype.FromKnownColorExample = function ()
{
   with ( Leadtools){
      // Create a yellow color (R = 255, G = 255, B = 0)
      var clr1 = RasterColorHelper.create(255, 255, 0);

      // Now create the same color using the "Yellow" known color
      var clr2 = RasterColorHelper.fromKnownColor(RasterKnownColor.yellow);

      // Make sure both colors have the same value
      console.assert(clr1.a === clr2.a, "clr1.a === clr2.a");
      console.assert(clr1.r === clr2.r, "clr1.r === clr2.r");
      console.assert(clr1.g === clr2.g, "clr1.g === clr2.g");
      console.assert(clr1.b === clr2.b, "clr1.b === clr2.b");
   }
}

[TestMethod]
public void FromKnownColorExample()
{
   // Create a yellow color (R = 255, G = 255, B = 0)
   RasterColor clr1 = RasterColorHelper.Create(255, 255, 0);
   // Now create the same color using the "Yellow" known color
   RasterColor clr2 = RasterColorHelper.FromKnownColor(RasterKnownColor.Yellow);

   // Make sure both colors have the same value
   Assert.IsTrue(clr1.A == clr2.A);
   Assert.IsTrue(clr1.R == clr2.R);
   Assert.IsTrue(clr1.G == clr2.G);
   Assert.IsTrue(clr1.B == clr2.B);
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterColorHelper Class
RasterColorHelper Members