Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

ComparisonConverter Class

Namespace:
ActiproSoftware.UI.Avalonia.Controls.Converters
Assembly:
ActiproSoftware.Avalonia.Shared.dll

A value converter that applies comparison logic on the value being converted.

public class ComparisonConverter : IValueConverter
Inheritance:
object object
Implements:
IValueConverter

Remarks

TrueResult is returned when the comparison evaluates as true; otherwise, FalseResult is returned. Binary Operator comparisons will use the value being converted as the left operand, and the converter parameter as the right operand. If the converter parameter is null, the CompareTo property value will be used as the right operand instead.

Constructors

ComparisonConverter()

Initializes an instance of the class.

public ComparisonConverter()

Properties

CompareTo

A fallback for the right operand value of binary Operator comparisons when the converter parameter is null.

public object? CompareTo { get; set; }

Property Value

object

FalseResult

The result to return when the comparison evaluates as false.

public object? FalseResult { get; set; }

Property Value

object:

The default value is false.

Operator

A ComparisonConverterOperator specifying the operator logic to use when making the comparison.

public ComparisonConverterOperator Operator { get; set; }

Property Value

ComparisonConverterOperator:

The default value is NotDefaultOrEmpty.

TrueResult

The result to return when the comparison evaluates as true.

public object? TrueResult { get; set; }

Property Value

object:

The default value is true.

Methods

Convert(object?, Type, object?, CultureInfo)

Converts a value.

public object? Convert(object? value, Type targetType, object? parameter, CultureInfo culture)
Parameter Type Description
value object

The value to convert.
targetType Type

The type of the target.
parameter object

A user-defined parameter.
culture CultureInfo

The culture to use.

Returns

object:

The converted value.

Remarks

This method should not throw exceptions. If the value is not convertible, return a Avalonia.Data.BindingNotification in an error state. Any exceptions thrown will be treated as an application exception.

ConvertBack(object?, Type, object?, CultureInfo)

Converts a value.

public object? ConvertBack(object? value, Type targetType, object? parameter, CultureInfo culture)
Parameter Type Description
value object

The value to convert.
targetType Type

The type of the target.
parameter object

A user-defined parameter.
culture CultureInfo

The culture to use.

Returns

object:

The converted value.

Remarks

This method should not throw exceptions. If the value is not convertible, return a Avalonia.Data.BindingNotification in an error state. Any exceptions thrown will be treated as an application exception.

Inherited Members

Extension Methods