ColorTranslator.FromHtml Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

Public Shared Function FromHtml (
	htmlColor As String
) As Color

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

.NET Framework
Available since 1.1
Return to top
Show: