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

Definition

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

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

Parameters

values
Object[]

The array of values that the source bindings in the MultiBinding produces. The value UnsetValue indicates that the source binding has no value to provide for conversion.

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.

A return value of DependencyProperty.UnsetValue indicates that the converter did not produce a value, and that the binding will use the FallbackValue if it is available, or else will use the default value.

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

Remarks

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.

Applies to

See also