Welcome Sign in
Skip Navigation Links
Microsoft Developer Network
.NET Framework Class Library
TypeConverter..::.ConvertToString Method (ITypeDescriptorContext, Object)

Updated: November 2007

Converts the given value to a string representation, using the given context.

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

Visual Basic (Declaration)
Public Function ConvertToString ( _
    context As ITypeDescriptorContext, _
    value As Object _
) As String
Visual Basic (Usage)
Dim instance As TypeConverter
Dim context As ITypeDescriptorContext
Dim value As Object
Dim returnValue As String

returnValue = instance.ConvertToString(context, _
    value)
C#
public string ConvertToString(
    ITypeDescriptorContext context,
    Object value
)
Visual C++
public:
String^ ConvertToString(
    ITypeDescriptorContext^ context, 
    Object^ value
)
J#
public String ConvertToString(
    ITypeDescriptorContext context,
    Object value
)
JScript
public function ConvertToString(
    context : ITypeDescriptorContext, 
    value : Object
) : String

Parameters

context
Type: System.ComponentModel..::.ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

value
Type: System..::.Object

The Object to convert.

Return Value

Type: System..::.String

An Object that represents the converted value.

ExceptionCondition
NotSupportedException

The conversion cannot be performed.

Use the context parameter to extract additional information about the environment from which this converter is invoked. This parameter can be nullNothingnullptra null reference (Nothing in Visual Basic), so always check it. Also, properties on the context object can return nullNothingnullptra null reference (Nothing in Visual Basic).

Depending on the implementation of the value formatter, it might be possible to pass the returned string back into the value formatter to re-create an instance of the object.

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Page view tracker