WPFCustomControls::Converters::BooleanMappingConverter Class Reference

---

Detailed Description

Maps Object Equality to Boolean values.

Detects the targetType for each conversion to map from Boolean to Object instances, or from Object Equality to Boolean. When converting to Boolean, returns true if the current value Equals the expected True object, and returns false otherwise. When converting from Boolean, returns the mapped BooleanMappingConverter.True value for true, and BooleanMappingConverter.False for false.

BooleanMappingConverter may be used in XAML as a MarkupExtension, but note that every MarkupExtension use site constructs a new instance. In a scenario such as a DataTemplate where True and False use common values across all template instances, it would be more efficient to use a shared instance as a StaticResource. Assuming xmlns:converters="clr-namespace:WPFCustomControls.Converters;assembly=WPFCustomControls", the MarkupExtension usage would resemble:

    {converters:BooleanMappingConverter True=Colors.Red, False=Colors.Blue}

List of all members.

Public Member Functions
override object	ProvideValue (IServiceProvider serviceProvider)
	Implements MarkupExtension to return this instance.
object	Convert (object value, Type targetType, object parameter, CultureInfo culture)
	Convert to or from a Boolean value.
object	ConvertBack (object value, Type targetType, object parameter, CultureInfo culture)
	Convert to or from a Boolean value.
Properties
Object	True [get, set]
	Expected comparison value when converting to Boolean, value returned when converting from a Boolean true value.
Object	False [get, set]
	Value returned when converting from a Boolean false value.

---

Member Function Documentation

override object WPFCustomControls::Converters::BooleanMappingConverter::ProvideValue

(

IServiceProvider

serviceProvider

)

[inline]

Implements MarkupExtension to return this instance.

Parameters:

serviceProvider

Igoned.

Returns:

This instance.

object WPFCustomControls::Converters::BooleanMappingConverter::Convert	(	object	value,
		Type	targetType,
		object	parameter,
		CultureInfo	culture
	)		[inline]

Convert to or from a Boolean value.

Behavior depends on the targetType.

If targetType is bool, converts to Boolean by comparing value against the BooleanMappingConverter.True property. Returns the BooleanMappingConverter.True.Equals(value).

For any other targetType, value is expected to be a bool value. If value is true, returns the BooleanMappingConverter.True property value. If value is false, returns the BooleanMappingConverter.False property value. If the cast to bool fails, returns DependencyProperty.UnsetValue.

Parameters:

value	Value from which to convert, see Remarks.
targetType	Expected result type, see Remarks.
parameter	Ignored.
culture	Ignored.

Returns:

See Remarks.

object WPFCustomControls::Converters::BooleanMappingConverter::ConvertBack	(	object	value,
		Type	targetType,
		object	parameter,
		CultureInfo	culture
	)		[inline]

Convert to or from a Boolean value.

Behavior depends on the targetType.

If targetType is bool, converts to Boolean by comparing value against the BooleanMappingConverter.True property. Returns the BooleanMappingConverter.True.Equals(value).

For any other targetType, value is expected to be a bool value. If value is true, returns the BooleanMappingConverter.True property value. If value is false, returns the BooleanMappingConverter.False property value. If the cast to bool fails, returns DependencyProperty.UnsetValue.

Parameters:

value	Value from which to convert, see Remarks.
targetType	Expected result type, see Remarks.
parameter	Ignored.
culture	Ignored.

Returns:

See Remarks.

---

Property Documentation

Object WPFCustomControls::Converters::BooleanMappingConverter::True [get, set]

Expected comparison value when converting to Boolean, value returned when converting from a Boolean true value.

Object WPFCustomControls::Converters::BooleanMappingConverter::False [get, set]

Value returned when converting from a Boolean false value.