ColorTranslator.ToHtml Method (System.Drawing)

ToHtml Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

ColorTranslator..::.ToHtml Method

Translates the specified Color structure to an HTML string color representation.

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

Syntax

Visual Basic (Declaration)

Public Shared Function ToHtml ( _
    c As Color _
) As String

Visual Basic (Usage)

Dim c As Color
Dim returnValue As String

returnValue = ColorTranslator.ToHtml(c)

public static string ToHtml(
    Color c
)

Visual C++

public:
static String^ ToHtml(
    Color c
)

JScript

public static function ToHtml(
    c : Color
) : String

Parameters

c: Type: System.Drawing..::.Color
The Color structure to translate.

Return Value

Type: System..::.String
The string that represents the HTML color.

Remarks

This method translates a Color structure to a string representation of an HTML color. This is the commonly used name of a color, such as "Red", "Blue", or "Green", and not string representation of a numeric color value, such as "FF33AA".

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 a Color structure to a string representation of an HTML color, and then shows a message box with the resulting string.

Visual Basic

Public Sub ToHtml_Example(ByVal e As PaintEventArgs)

    ' Create an instance of a Color structure.
    Dim myColor As Color = Color.Red

    ' Translate myColor to an HTML color.
    Dim htmlColor As String = ColorTranslator.ToHtml(myColor)

    ' Show a message box with the value of htmlColor.
    MessageBox.Show(htmlColor)
End Sub

public void ToHtml_Example(PaintEventArgs e)
{
    // Create an instance of a Color structure.
    Color myColor = Color.Red;

    // Translate myColor to an HTML color.
    string htmlColor = ColorTranslator.ToHtml(myColor);

    // Show a message box with the value of htmlColor.
    MessageBox.Show(htmlColor);
}

Visual C++

public:
   void ToHtml_Example( PaintEventArgs^ /*e*/ )
   {
      // Create an instance of a Color structure.
      Color myColor = Color::Red;

      // Translate myColor to an HTML color.
      String^ htmlColor = ColorTranslator::ToHtml( myColor );

      // Show a message box with the value of htmlColor.
      MessageBox::Show( htmlColor );
   }

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

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

Reference

ColorTranslator Class

ColorTranslator Members

System.Drawing Namespace