ColorTranslator::FromHtml Method (String^)

 

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 null.

Exception Condition
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 PaintEventArgse, 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
Available since 1.1
Return to top
Show: