Color.ToKnownColor Method (System.Drawing)

ToKnownColor Method

Switch on low bandwidth view

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

Color..::.ToKnownColor Method

Gets the KnownColor value of this Color structure.

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

Syntax

Visual Basic (Declaration)

Public Function ToKnownColor As KnownColor

Visual Basic (Usage)

Dim instance As Color
Dim returnValue As KnownColor

returnValue = instance.ToKnownColor()

public KnownColor ToKnownColor()

Visual C++

public:
KnownColor ToKnownColor()

JScript

public function ToKnownColor() : KnownColor

Return Value

Type: System.Drawing..::.KnownColor
An element of the KnownColor enumeration, if the Color is created from a predefined color by using either the FromName method or the FromKnownColor method; otherwise, 0.

Remarks

A predefined color is also called a known color and is represented by an element of the KnownColor enumeration. When the ToKnownColor method is applied to a Color structure that is created by using the FromArgb method, ToKnownColor returns 0, even if the ARGB value matches the ARGB value of a predefined color. ToKnownColor also returns 0 when it is applied to a Color structure that is created by using the FromName method with a string name that is not valid.

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

Color Structure

Color Members

System.Drawing Namespace