Export (0) Print
Expand All

TypeConverter.ConvertTo Method (ITypeDescriptorContext, CultureInfo, Object, Type)

Converts the given value object to the specified type, using the specified context and culture information.

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

public virtual Object ConvertTo(
	ITypeDescriptorContext context,
	CultureInfo culture,
	Object value,
	Type destinationType
)

Parameters

context
Type: System.ComponentModel.ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

culture
Type: System.Globalization.CultureInfo

A CultureInfo. If null is passed, the current culture is assumed.

value
Type: System.Object

The Object to convert.

destinationType
Type: System.Type

The Type to convert the value parameter to.

Return Value

Type: System.Object
An Object that represents the converted value.

ExceptionCondition
ArgumentNullException

The destinationType parameter is null.

NotSupportedException

The conversion cannot be performed.

The most common types to convert are to and from a string object. This implementation calls ToString on the object if the object is valid and if the destination type is a string.

Use the context parameter to extract additional information about the environment from which this converter is invoked. This parameter can be null, so always check it. Also, properties on the context object can return null.

Custom type authors that intend to support a type conversion behavior for XAML typically implement a TypeConverter class that supports ConvertFrom behavior from a string. These type converters might also implement ConvertTo to support serialization back to XAML.

Some XAML serialization scenarios cannot be adequately addressed with TypeConverter alone. In these cases, it may be necessary to also define a ValueSerializer that handles the serialization cases that would otherwise be handled by ConvertTo. For more information, see ValueSerializer.

Notes to Inheritors

Override this method to provide your own conversion requirements.

For implementation patterns for type converters that are used to support XAML and custom types, see Type Converters for XAML Overview.

.NET Framework

Supported in: 4.5.2, 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

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

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.

Show:
© 2014 Microsoft