IMultiValueConverter::Convert Method (array<Object^>^, Type^, Object^, CultureInfo^)

 

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.

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

Object^ Convert(
	array<Object^>^ values,
	Type^ targetType,
	Object^ parameter,
	CultureInfo^ culture
)

Parameters

values
Type: array<System::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: 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.

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.

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.

.NET Framework
Available since 3.0
Return to top
Show: