ColorTranslator.FromHtml(String) Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Primitives.dll

Source:

ColorTranslator.cs

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

public:
 static System::Drawing::Color FromHtml(System::String ^ htmlColor);

public static System.Drawing.Color FromHtml (string htmlColor);

static member FromHtml : string -> System.Drawing.Color

Public Shared Function FromHtml (htmlColor As String) As Color

Parameters

htmlColor

String

The string representation of the Html color to translate.

Returns

Color

The Color structure that represents the translated HTML color or Empty if htmlColor is null.

Exceptions

Exception

htmlColor is not a valid HTML color name.

Examples

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 );
   }

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( new SolidBrush(myColor), 0, 0, 
        100, 100);
}

Public Sub FromHtml_Example(ByVal e As PaintEventArgs)

    ' Create a string representation of an HTML color.
    Dim htmlColor As String = "Blue"

    ' Translate htmlColor to a GDI+ Color structure.
    Dim myColor As Color = ColorTranslator.FromHtml(htmlColor)

    ' Fill a rectangle with myColor.
    e.Graphics.FillRectangle(New SolidBrush(myColor), 0, 0, 100, 100)
End Sub

Remarks

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