Edit

IMultiValueConverter.ConvertBack(Object, Type[], Object, CultureInfo) Method

  • Reference

Definition

Namespace:
System.Windows.Data
Assembly:
PresentationFramework.dll

Converts a binding target value to the source binding values.

public:
 cli::array <System::Object ^> ^ ConvertBack(System::Object ^ value, cli::array <Type ^> ^ targetTypes, System::Object ^ parameter, System::Globalization::CultureInfo ^ culture);
public object[] ConvertBack (object value, Type[] targetTypes, object parameter, System.Globalization.CultureInfo culture);
abstract member ConvertBack : obj * Type[] * obj * System.Globalization.CultureInfo -> obj[]
Public Function ConvertBack (value As Object, targetTypes As Type(), parameter As Object, culture As CultureInfo) As Object()

Parameters

value
Object

The value that the binding target produces.

targetTypes
Type[]

The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return.

parameter
Object

The converter parameter to use.

culture
CultureInfo

The culture to use in the converter.

Returns

Object[]

An array of values that have been converted from the target value back to the source values.

Remarks

If there are more return values than there are bindings in the MultiBinding, the excess return values are ignored. If there are more source bindings than there are return values, the remaining source bindings do not have any values set on them. Types of return values are not verified against targetTypes; the values are set on the source bindings directly.

Return DoNothing at position i to indicate that no value is to be set on the source binding at index i.

Return DependencyProperty.UnsetValue at position i to indicate that the converter is unable to provide a value for the source binding at index i, and that no value is to be set on it.

Return null to indicate that the converter cannot perform the conversion or that it does not support conversion in this direction.

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

Applies to

See also