Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IValueConverter.Convert Method

Converts a value.

Namespace:  System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)

Object Convert(
	Object value,
	Type targetType,
	Object parameter,
	CultureInfo culture
)

Parameters

value
Type: System.Object

The value produced by the binding source.

targetType
Type: System.Type

The type of the binding target property.

parameter
Type: System.Object

The converter parameter to use.

culture
Type: System.Globalization.CultureInfo

The culture to use in the converter.

Return Value

Type: System.Object
A converted value. If the method returns null, the valid null value is used.

The data binding engine calls this method when it propagates a value from the binding source to the binding target.

The data binding engine does not catch exceptions that are thrown by a user-supplied converter. Any exception that is thrown by the Convert method, or any uncaught exceptions that are thrown by methods that the Convert method calls, are treated as run-time errors. Handle anticipated problems by returning DependencyProperty.UnsetValue.

A return value of DependencyProperty.UnsetValue indicates that the converter produced no value and that the binding uses the FallbackValue, if available, or the default value instead.

A return value of Binding.DoNothing indicates that the binding does not transfer the value or use the FallbackValue or default value.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft