Binding.ConverterParameter Binding.ConverterParameter Binding.ConverterParameter Binding.ConverterParameter Property

Definition

Gets or sets a parameter that can be used in the Converter logic.

public : Platform::Object ConverterParameter { get; set; }
winrt::Windows::Foundation::IInspectable ConverterParameter();

void ConverterParameter(winrt::Windows::Foundation::IInspectable converterparameter);
public object ConverterParameter { get; set; }
Public ReadWrite Property ConverterParameter As object
<Binding ConverterParameter="parameter"/>
-or-
<Binding ConverterParameter="parameterReference"/>

Property Value

object object

A parameter to be passed to the Converter. This can be used in the conversion logic. The default is null.

Remarks

Passing parameters to a converter is a relatively advanced and uncommon scenarios. Most converters used for data binding simply type-convert a source object to a desired target type based solely on the characteristics of the source object, and knowing what the intended destination type is for a particular binding scenario.

If a value for ConverterParameter is specified, this value is used for the parameter value when invoking the converter logic. Specifically, this provides the value of the parameter parameter of the Convert or ConvertBack methods of the specific converter that is requested with the Converter property.

You can't set the property values of a Binding object after that binding has been attached to a target element and target property. If you attempt this you'll get a run-time exception.

See also