IValueConverter.Convert Method

Modifies the source data before passing it to the target for display in the UI.

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

Object Convert(
	Object value,
	Type targetType,
	Object parameter,
	CultureInfo culture


Type: System.Object
The source data being passed to the target.
Type: System.Type
The Type of data expected by the target dependency property.
Type: System.Object
An optional parameter to be used in the converter logic.
Type: System.Globalization.CultureInfo
The culture of the conversion.

Return Value

Type: System.Object
The value to be passed to the target dependency property.

The culture is determined in the following order:

  1. The converter looks for the ConverterCulture property on the Binding object.

  2. If the ConverterCulture value is null, the value of the Language property is used.

If the Convert method throws an exception, the binding engine ignores it and lets the exception bubble through.

If UnsetValue is returned, the target property is set to its default value.

The following example shows how to implement the Convert method using the parameter and culture parameters.

using System;
using System.Collections.ObjectModel;
using System.Windows.Controls;
using System.Windows.Data;

namespace ConverterParameterEx
    public partial class Page : UserControl

        public ObservableCollection<Recording> MyMusic =
            new ObservableCollection<Recording>();
        public Page()

            // Add items to the collection.
            MyMusic.Add(new Recording("Chris Sells", "Chris Sells Live",
                new DateTime(2008, 2, 5)));
            MyMusic.Add(new Recording("Luka Abrus",
                "The Road to Redmond", new DateTime(2007, 4, 3)));
            MyMusic.Add(new Recording("Jim Hance",
                "The Best of Jim Hance", new DateTime(2007, 2, 6)));

            // Set the data context for the combo box.
            MusicCombo.DataContext = MyMusic;

    // Simple business object.
    public class Recording
        public Recording() { }
        public Recording(string artistName, string cdName, DateTime release)
            Artist = artistName;
            Name = cdName;
            ReleaseDate = release;
        public string Artist { get; set; }
        public string Name { get; set; }
        public DateTime ReleaseDate { get; set; }

    public class DateFormatter : IValueConverter
        // This converts the DateTime object to the string to display.
        public object Convert(object value, Type targetType, object parameter,
            System.Globalization.CultureInfo culture)
            // Retrieve the format string and use it to format the value.
            string formatString = parameter as string;
            if (!string.IsNullOrEmpty(formatString))
                return string.Format(culture, formatString, value);

            // If the format string is null or empty, simply call ToString()
            // on the value.
            return value.ToString();

        // No need to implement converting back on a one-way binding 
        public object ConvertBack(object value, Type targetType, 
            object parameter, System.Globalization.CultureInfo culture)
            throw new NotImplementedException();


Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions