IValueConverter.Convert(Object, Type, Object, CultureInfo) Method

Definition

Converts a value.

public:
 System::Object ^ Convert(System::Object ^ value, Type ^ targetType, System::Object ^ parameter, System::Globalization::CultureInfo ^ culture);
public object Convert (object value, Type targetType, object parameter, System.Globalization.CultureInfo culture);
abstract member Convert : obj * Type * obj * System.Globalization.CultureInfo -> obj
Public Function Convert (value As Object, targetType As Type, parameter As Object, culture As CultureInfo) As Object

Parameters

value
Object

The value produced by the binding source.

targetType
Type

The type of the binding target property.

parameter
Object

The converter parameter to use.

culture
CultureInfo

The culture to use in the converter.

Returns

A converted value. If the method returns null, the valid null value is used.

Remarks

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.

Applies to