ColorConverter Class

Definition

Namespace:

System.Drawing

Assembly:

System.ComponentModel.TypeConverter.dll

Source:

ColorConverter.cs

Converts colors from one data type to another. Access this class through the TypeDescriptor.

public ref class ColorConverter : System::ComponentModel::TypeConverter

public class ColorConverter : System.ComponentModel.TypeConverter

type ColorConverter = class
    inherit TypeConverter

Public Class ColorConverter
Inherits TypeConverter

Inheritance

Object

TypeConverter

ColorConverter

Derived

System.Web.UI.WebControls.WebColorConverter

Examples

The following code example demonstrates how to use the ConvertToString method. This example is designed to be used with Windows Forms. Paste this code into a form and call the ShowColorConverter method when handling the form's Paint event, passing e as PaintEventArgs.

void ShowColorConverter( PaintEventArgs^ e )
{
   Color myColor = Color::PaleVioletRed;
   
   // Create the ColorConverter.
   System::ComponentModel::TypeConverter^ converter = System::ComponentModel::TypeDescriptor::GetConverter( myColor );
   String^ colorAsString = converter->ConvertToString( Color::PaleVioletRed );
   e->Graphics->DrawString( colorAsString, this->Font, Brushes::PaleVioletRed, 50.0F, 50.0F );
}

private void ShowColorConverter(PaintEventArgs e)
{

    Color myColor = Color.PaleVioletRed;

    // Create the ColorConverter.
    System.ComponentModel.TypeConverter converter = 
        System.ComponentModel.TypeDescriptor.GetConverter(myColor);

    string colorAsString = converter.ConvertToString(Color.PaleVioletRed);
    e.Graphics.DrawString(colorAsString, this.Font,
        Brushes.PaleVioletRed, 50.0F, 50.0F);
}

Private Sub ShowColorConverter(ByVal e As PaintEventArgs)

    Dim myColor As Color = Color.PaleVioletRed

    ' Create the ColorConverter.
    Dim converter As System.ComponentModel.TypeConverter = _
       System.ComponentModel.TypeDescriptor.GetConverter(myColor)

    Dim colorAsString As String = _
        converter.ConvertToString(Color.PaleVioletRed)
    e.Graphics.DrawString(colorAsString, Me.Font, _
        Brushes.PaleVioletRed, 50.0F, 50.0F)
End Sub

Remarks

When converting from a string to a Color the ColorConverter expects the unqualified color name; otherwise, an exception will occur in the conversion process. For example, you should pass "Blue", not "System.Drawing.Color.Blue" or "Color.Blue", to the ConvertFrom method.

Constructors

ColorConverter()

Initializes a new instance of the ColorConverter class.

Methods

CanConvertFrom(ITypeDescriptorContext, Type)	Determines if this converter can convert an object in the given source type to the native type of the converter.
CanConvertFrom(Type)	Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter)
CanConvertTo(ITypeDescriptorContext, Type)	Returns a value indicating whether this converter can convert an object to the given destination type using the context.
CanConvertTo(Type)	Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter)
ConvertFrom(ITypeDescriptorContext, CultureInfo, Object)	Converts the given object to the converter's native type.
ConvertFrom(Object)	Converts the given value to the type of this converter. (Inherited from TypeConverter)
ConvertFromInvariantString(ITypeDescriptorContext, String)	Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter)
ConvertFromInvariantString(String)	Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter)
ConvertFromString(ITypeDescriptorContext, CultureInfo, String)	Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter)
ConvertFromString(ITypeDescriptorContext, String)	Converts the given text to an object, using the specified context. (Inherited from TypeConverter)
ConvertFromString(String)	Converts the specified text to an object. (Inherited from TypeConverter)
ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)	Converts the specified object to another type.
ConvertTo(Object, Type)	Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter)
ConvertToInvariantString(ITypeDescriptorContext, Object)	Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter)
ConvertToInvariantString(Object)	Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter)
ConvertToString(ITypeDescriptorContext, CultureInfo, Object)	Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter)
ConvertToString(ITypeDescriptorContext, Object)	Converts the given value to a string representation, using the given context. (Inherited from TypeConverter)
ConvertToString(Object)	Converts the specified value to a string representation. (Inherited from TypeConverter)
CreateInstance(IDictionary)	Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter)
CreateInstance(ITypeDescriptorContext, IDictionary)	Creates an instance of the type that this TypeConverter is associated with, using the specified context, given a set of property values for the object. (Inherited from TypeConverter)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetConvertFromException(Object)	Returns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter)
GetConvertToException(Object, Type)	Returns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter)
GetCreateInstanceSupported()	Returns whether changing a value on this object requires a call to the CreateInstance(IDictionary) method to create a new value. (Inherited from TypeConverter)
GetCreateInstanceSupported(ITypeDescriptorContext)	Returns whether changing a value on this object requires a call to CreateInstance(IDictionary) to create a new value, using the specified context. (Inherited from TypeConverter)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperties(ITypeDescriptorContext, Object)	Returns a collection of properties for the type of array specified by the value parameter, using the specified context. (Inherited from TypeConverter)
GetProperties(ITypeDescriptorContext, Object, Attribute[])	Returns a collection of properties for the type of array specified by the value parameter, using the specified context and attributes. (Inherited from TypeConverter)
GetProperties(Object)	Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter)
GetPropertiesSupported()	Returns whether this object supports properties. (Inherited from TypeConverter)
GetPropertiesSupported(ITypeDescriptorContext)	Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter)
GetStandardValues()	Returns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter)
GetStandardValues(ITypeDescriptorContext)	Retrieves a collection containing a set of standard values for the data type for which this validator is designed. This will return null if the data type does not support a standard set of values.
GetStandardValuesExclusive()	Returns whether the collection of standard values returned from GetStandardValues() is an exclusive list. (Inherited from TypeConverter)
GetStandardValuesExclusive(ITypeDescriptorContext)	Returns whether the collection of standard values returned from GetStandardValues() is an exclusive list of possible values, using the specified context. (Inherited from TypeConverter)
GetStandardValuesSupported()	Returns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter)
GetStandardValuesSupported(ITypeDescriptorContext)	Determines if this object supports a standard set of values that can be chosen from a list.
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsValid(ITypeDescriptorContext, Object)	Returns whether the given value object is valid for this type and for the specified context. (Inherited from TypeConverter)
IsValid(Object)	Returns whether the given value object is valid for this type. (Inherited from TypeConverter)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SortProperties(PropertyDescriptorCollection, String[])	Sorts a collection of properties. (Inherited from TypeConverter)
ToString()	Returns a string that represents the current object. (Inherited from Object)