Skip to main content
.NET Framework Class Library
LengthConverter Class

Converts instances of other types to and from instances of a Double that represent an object's length.

Namespace:   System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
Syntax
Public Class LengthConverter _
	Inherits [%$TOPIC/ms602855_en-us_VS_110_3_0_0_0_0%]
public class LengthConverter : [%$TOPIC/ms602855_en-us_VS_110_3_0_1_0_0%]
public ref class LengthConverter : public [%$TOPIC/ms602855_en-us_VS_110_3_0_2_0_0%]
type LengthConverter =  
    class 
        inherit [%$TOPIC/ms602855_en-us_VS_110_3_0_3_0_0%] 
    end
<LengthConverter .../>

The LengthConverter type exposes the following members.

Constructors
  NameDescription
Public method LengthConverterInitializes a new instance of the LengthConverter class.
Top
Methods
  NameDescription
Public method CanConvertFrom(Type)Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter.)
Public method CanConvertFrom(ITypeDescriptorContext, Type)Determines whether conversion is possible from a specified type to a Double that represents an object's length. (Overrides TypeConverterCanConvertFrom(ITypeDescriptorContext, Type).)
Public method CanConvertTo(Type)Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter.)
Public method CanConvertTo(ITypeDescriptorContext, Type)Determines whether conversion is possible to a specified type from a Double that represents an object's length. (Overrides TypeConverterCanConvertTo(ITypeDescriptorContext, Type).)
Public method ConvertFrom(Object)Converts the given value to the type of this converter. (Inherited from TypeConverter.)
Public method ConvertFrom(ITypeDescriptorContext, CultureInfo, Object)Converts instances of other data types into instances of Double that represent an object's length. (Overrides TypeConverterConvertFrom(ITypeDescriptorContext, CultureInfo, Object).)
Public method ConvertFromInvariantString(String)Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter.)
Public method ConvertFromInvariantString(ITypeDescriptorContext, String)Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter.)
Public method ConvertFromString(String)Converts the specified text to an object. (Inherited from TypeConverter.)
Public method ConvertFromString(ITypeDescriptorContext, String)Converts the given text to an object, using the specified context. (Inherited from TypeConverter.)
Public method ConvertFromString(ITypeDescriptorContext, CultureInfo, String)Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter.)
Public method ConvertTo(Object, Type)Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter.)
Public method ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)Converts other types into instances of Double that represent an object's length. (Overrides TypeConverterConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type).)
Public method ConvertToInvariantString(Object)Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter.)
Public method ConvertToInvariantString(ITypeDescriptorContext, Object)Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter.)
Public method ConvertToString(Object)Converts the specified value to a string representation. (Inherited from TypeConverter.)
Public method ConvertToString(ITypeDescriptorContext, Object)Converts the given value to a string representation, using the given context. (Inherited from TypeConverter.)
Public method ConvertToString(ITypeDescriptorContext, CultureInfo, Object)Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter.)
Public method CreateInstance(IDictionary)Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter.)
Public method 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.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetConvertFromExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Protected method GetConvertToExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Public method GetCreateInstanceSupportedReturns whether changing a value on this object requires a call to the CreateInstance method to create a new value. (Inherited from TypeConverter.)
Public method GetCreateInstanceSupported(ITypeDescriptorContext)Returns whether changing a value on this object requires a call to CreateInstance to create a new value, using the specified context. (Inherited from TypeConverter.)
Public method GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetProperties(Object)Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter.)
Public method 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.)
Public method 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.)
Public method GetPropertiesSupportedReturns whether this object supports properties. (Inherited from TypeConverter.)
Public method GetPropertiesSupported(ITypeDescriptorContext)Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter.)
Public method GetStandardValuesReturns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter.)
Public method GetStandardValues(ITypeDescriptorContext)Returns a collection of standard values for the data type this type converter is designed for when provided with a format context. (Inherited from TypeConverter.)
Public method GetStandardValuesExclusiveReturns whether the collection of standard values returned from GetStandardValues is an exclusive list. (Inherited from TypeConverter.)
Public method 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.)
Public method GetStandardValuesSupportedReturns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter.)
Public method GetStandardValuesSupported(ITypeDescriptorContext)Returns whether this object supports a standard set of values that can be picked from a list, using the specified context. (Inherited from TypeConverter.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsValid(Object)Returns whether the given value object is valid for this type. (Inherited from TypeConverter.)
Public method IsValid(ITypeDescriptorContext, Object)Returns whether the given value object is valid for this type and for the specified context. (Inherited from TypeConverter.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected method SortPropertiesSorts a collection of properties. (Inherited from TypeConverter.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Remarks

LengthConverter supports conversion to and from the following types: String, Decimal, Single, Double, Int16, Int32, Int64, UInt16, UInt32, and UInt64.

Examples

The following example shows how to create and use an instance of the LengthConverter object. A custom method called ChangeLeft is defined, which converts the content of a ListBoxItem (defined in a separate Extensible Application Markup Language (XAML) file) to an instance of Double, and later into a String. This method passes the ListBoxItem to a LengthConverter object, which converts the ListBoxItem  Content to an instance of Double. Notice that this value has already been converted to a String by using the ToString method. This value is then passed back to the SetLeft method and the GetLeft method of the Canvas in order to change the position of the text1 object.

Private Sub ChangeLeft(ByVal sender As Object, ByVal e As SelectionChangedEventArgs)
    Dim li As ListBoxItem = CType(CType(sender, ListBox).SelectedItem, ListBoxItem)
    Dim myLengthConverter As New LengthConverter
    Dim db1 As Double = CType(myLengthConverter.ConvertFromString(li.Content.ToString()), Double)
    Canvas.SetLeft(text1, db1)
    Dim st1 As String = CType(myLengthConverter.ConvertToString(Canvas.GetLeft(text1)), String)
    canvasLeft.Text = "Canvas.Left = " + st1
End Sub
private void ChangeLeft(object sender, SelectionChangedEventArgs args)
		{
			ListBoxItem li = ((sender as ListBox).SelectedItem as ListBoxItem);
			LengthConverter myLengthConverter = new LengthConverter();
			Double db1 = (Double)myLengthConverter.ConvertFromString(li.Content.ToString());
			Canvas.SetLeft(text1, db1);
			String st1 = (String)myLengthConverter.ConvertToString(Canvas.GetLeft(text1));
			canvasLeft.Text = "Canvas.Left = " + st1;
		}
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.