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

StringFormatConverter Class

Namespace:
ActiproSoftware.Windows.Data
Assembly:
ActiproSoftware.Shared.Wpf.dll

Represents a multi-value converter that provides String.Format functionality for both simple Binding and MultiBinding objects.

[ValueConversion(typeof(object), typeof(string))]
public class StringFormatConverter
Inheritance:
object object

Remarks

Pass the format string in the converter's parameter. Since { characters are normally interpreted as markup extension starts, you can escape them by placing {} before the format string like this:

<MultiBinding Converter="{StaticResource StringFormatConverter}" ConverterParameter="{}{0} of {1}">...

Constructors

StringFormatConverter()

Initializes an instance of the class.

public StringFormatConverter()

Properties

IsNullAllowed

Gets or sets a value indicating whether this instance will return null if the value(s) passed is null.

public bool IsNullAllowed { get; set; }

Property Value

bool:

true if this instance will return null if the value(s) passed is null; otherwise, false.

Methods

Convert(object, Type, object, CultureInfo)

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

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

The value produced by the binding source.
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

object:

A converted value.

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 a value from the binding source to the binding target.

public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
Parameter Type Description
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. When null, the first value of the multi-binding must specify the format.
culture CultureInfo

The culture to use in the converter.

Returns

object:

A converted value.

ConvertBack(object, Type, object, CultureInfo)

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

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

The value produced by the binding source.
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

object:

A converted value.

ConvertBack(object, Type[], object, CultureInfo)

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

public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
Parameter Type Description
value object

The value produced by the binding source.
targetTypes Type[]

The array of types to convert to. The array length indicates the number and types of values that are suggested for the method to return.
parameter object

The converter parameter to use.
culture CultureInfo

The culture to use in the converter.

Returns

object[]:

An array of values that have been converted from the target value back to the source values.

Inherited Members