Color.ToKnownColor Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the KnownColor value of this Color structure.
public:
System::Drawing::KnownColor ToKnownColor();
public System.Drawing.KnownColor ToKnownColor ();
member this.ToKnownColor : unit -> System.Drawing.KnownColor
Public Function ToKnownColor () As KnownColor
Returns
An element of the KnownColor enumeration, if the Color is created from a predefined color by using either the FromName(String) method or the FromKnownColor(KnownColor) 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.