BinaryOperationConverter Class

Applies the Operation on the value and the converter parameter.

May also be used as IMultiValueConverter where both operands are specified using bindings.

Inheritance Hierarchy

SystemObject
  System.Windows.MarkupMarkupExtension
    TomsToolbox.Wpf.ConvertersValueConverter
      TomsToolbox.Wpf.ConvertersBinaryOperationConverter

Namespace: TomsToolbox.Wpf.Converters
Assembly: TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 2.21.0+44d18b541fc9419ec3c549350a832394661b2a4d
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Copy

[ValueConversionAttribute(typeof(Object), typeof(Object))]
public class BinaryOperationConverter : ValueConverter, 
	IMultiValueConverter

<ValueConversionAttribute(GetType(Object), GetType(Object))>
Public Class BinaryOperationConverter
	Inherits ValueConverter
	Implements IMultiValueConverter

Return Value

If the conversions succeed, the result of the operation is returned. If any error occurs, the result is UnsetValue.

The BinaryOperationConverter type exposes the following members.

Constructors

	Name	Description
	BinaryOperationConverter	Initializes a new instance of the BinaryOperationConverter class

Top

Properties

	Name	Description
	ConvertBackErrorValue	Gets or sets the error value, which is returned whenever the value to convert back produces an error; the default is UnsetValue. (Inherited from ValueConverter)
	ConvertBackNullValue	Gets or sets the null value, which is returned whenever the value to convert back is null; the default is null. (Inherited from ValueConverter)
	ConvertBackUnsetValue	Gets or sets the unset value, which is returned whenever the value to convert back is UnsetValue; the default is UnsetValue. (Inherited from ValueConverter)
	ConvertErrorValue	Gets or sets the error value, which is returned whenever the value to convert produces an error; the default is UnsetValue. (Inherited from ValueConverter)
	ConvertNullValue	Gets or sets the null value, which is returned whenever the value to convert is null; the default is null. (Inherited from ValueConverter)
	ConvertUnsetValue	Gets or sets the unset value, which is returned whenever the value to convert is UnsetValue; the default is UnsetValue. (Inherited from ValueConverter)
	Operation	Gets or sets the operation the converter is performing.

Top

Methods

	Name	Description
	Convert(Object, Type, Object, CultureInfo)	Converts a value. (Overrides ValueConverterConvert(Object, Type, Object, CultureInfo))
	Convert(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.
	ConvertBack(Object, Type, Object, CultureInfo)	Converts a binding target value to the source binding values.
	ConvertBack(Object, Type, Object, CultureInfo)	Converts a value. (Inherited from ValueConverter)
	ProvideValue	When implemented in a derived class, returns an object that is provided as the value of the target property for this markup extension. (Inherited from ValueConverter)

Top

Fields

	Name	Description
	Addition	The default addition converter.
	Division	The default division converter.
	Equality	The default equality converter.
	GreaterThan	The default greater than converter.
	GreaterThanOrEqual	The default greater than or equals converter.
	Inequality	The default inequality converter.
	LessThan	The default less than converter.
	LessThanOrEqual	The default less than or equals converter.
	Multiply	The default multiplication converter.
	Subtraction	The default subtraction converter.

Top

Extension Methods

	Name	Description
	SafeCastT	Performs a cast from object to T, avoiding possible null violations if T is a value type. (Defined by ObjectExtensions)
	TraceError	Traces an error for the specified converter. (Defined by ValueConverterExtensions)

Top

Remarks

Either

- both value and parameter must be convertible to a double

- value must have an explicit operator for the specified operation and parameter has a type converter matching the expected operator parameter.

If the value supports implicit or explicit casts, the operation is retried on all types that the original type can be casted to. This enables the converter to handle most operations on Vector, Size, Point, etc...

For Rect the Addition is mapped to Offset(Vector) and the Multiply is mapped to Transform(Matrix)

Reference

TomsToolbox.Wpf.Converters Namespace