Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Color.ToString Method

Converts this Color structure to a human-readable string.

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)
public override string ToString()

Return Value

Type: System.String
A string that is the name of this Color, if the Color is created from a predefined color by using either the FromName method or the FromKnownColor method; otherwise, a string that consists of the ARGB component names and their values.

A predefined color is also called a known color and is represented by an element of the KnownColor enumeration. When the ToString method is applied to a Color structure that is created by using the FromArgb method, ToString returns a string that consists of the ARGB component names and their values, even if the ARGB value matches the ARGB value of a predefined color.

The following code example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler. The code performs the following actions:

  • Iterates through the KnownColor enumeration elements to find all known colors that have a non-zero green component and a zero-value red component and that are not system colors.

  • During each iteration, saves the KnownColor element—if it matches the criteria—in an array.

  • Uses a brush to paint rectangles. Each of the rectangles is painted a KnownColor that matches the criteria stated in the first step. The name of the KnownColor and its component values are also displayed.

This example displays certain known colors and uses ToString to display the names of the colors and their four component values.

public void ToArgbToStringExample2(PaintEventArgs e)
{
    Graphics     g = e.Graphics;

    // Color structure used for temporary storage.
    Color   someColor = Color.FromArgb(0);

    // Array to store KnownColor values that match the criteria.
    KnownColor[]  colorMatches = new KnownColor[167];

    // Number of matches found. 
    int  count = 0;   

    // Iterate through the KnownColor enums to find all corresponding colors 
    // that have a nonzero green component and zero-value red component and 
    // that are not system colors. 
    for (KnownColor enumValue = 0;
        enumValue <= KnownColor.YellowGreen; enumValue++)
    {
        someColor = Color.FromKnownColor(enumValue);
        if (someColor.G != 0 && someColor.R == 0 && !someColor.IsSystemColor)
            colorMatches[count++] = enumValue;
    }
    SolidBrush  myBrush1 = new SolidBrush(someColor);
    Font        myFont = new Font("Arial", 9);
    int         x = 40;
    int         y = 40;

    // Iterate through the matches that were found and display each color that 
    // corresponds with the enum value in the array. also display the name of 
    // the KnownColor and the ARGB components. 
    for (int i = 0; i < count; i++)
    {
        // Display the color.
        someColor = Color.FromKnownColor(colorMatches[i]);
        myBrush1.Color = someColor;
        g.FillRectangle(myBrush1, x, y, 50, 30);

        // Display KnownColor name and the four component values. To display the 
        // component values:  Use the ToArgb method to get the 32-bit ARGB value 
        // of someColor, which was created from a KnownColor. Then create a 
        // Color structure from the 32-bit ARGB value and set someColor equal to 
        // this new Color structure. Then use the ToString method to convert it to 
        // a string.
        g.DrawString(someColor.ToString(), myFont, Brushes.Black, x + 55, y);
        someColor = Color.FromArgb(someColor.ToArgb());
        g.DrawString(someColor.ToString(), myFont, Brushes.Black, x + 55, y + 15);
        y += 40;
    }
}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.