Export (0) Print
Expand All

ColorTranslator::FromHtml Method

Translates an HTML color representation to a GDI+ Color structure.

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public:
static Color FromHtml(
	String^ htmlColor
)

Parameters

htmlColor
Type: System::String

The string representation of the Html color to translate.

Return Value

Type: System.Drawing::Color
The Color structure that represents the translated HTML color or Empty if htmlColor is nullptr.

ExceptionCondition
Exception

htmlColor is not a valid HTML color name.

This method translates a string representation of an HTML color name, such as Blue or Red, to a GDI+ Color structure.

The following example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler. The code translates an HTML color name to a Color structure, and then uses that color to fill a rectangle.

public:
   void FromHtml_Example( PaintEventArgs^ e )
   {
      // Create a string representation of an HTML color.
      String^ htmlColor = "Blue";

      // Translate htmlColor to a GDI+ Color structure.
      Color myColor = ColorTranslator::FromHtml( htmlColor );

      // Fill a rectangle with myColor.
      e->Graphics->FillRectangle( gcnew SolidBrush( myColor ), 0, 0, 100, 100 );
   }

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft