【编辑】WPF 转换器中如何使用依赖属性?
概述
目前 WPF 的转换器中无法放置依赖属性,ConverterParameter 又不支持绑定,所以如果在转换器场景中需要绑定的话,就有点头疼了。
遇事不决,问 AI,所以我把这个问题在 GitHub Copilot 中问了下 GPT-5。
它的初始回答简单明了,提供了两种方案:Freezable 方案 和 MultiBinding 方案。
由于目前转换器一般都继承了 MarkupExtension 以方便使用,所以又加入了这个因素,AI 也是丝毫不虚,不过情况就变得复杂了起来……
本文基本就是摘抄原始问答,并未验证,不过看着像那么回事,也很有启发,所以分享给大家。
后续可能会选择其中合适的方案,改造一两个目前的转换器,到时候应该会再发文分享。
GPT-5 的初始回答
下面用中文说明并给出可直接使用的示例代码 —— 我实现了两种常见做法并展示如何在 XAML 中使用:
1) 让转换器继承自 Freezable,从而可以声明依赖属性并对它们使用 Binding;
2) 用 MultiBinding 传入额外绑定值(当你不想把转换器当作 Freezable 时的替代方案)。
我也会说明为什么普通的 IValueConverter 不能直接有可绑定的依赖属性,以及常见陷阱。
Freezable 方案
我先给出 Freezable 方案的完整代码和 XAML 用法。
MyFreezableConverter.cs
- using System;
- using System.Globalization;
- using System.Windows;
- using System.Windows.Data;
- namespace YourNamespace
- {
- // 继承 Freezable 以支持在 XAML 中对转换器的依赖属性进行 Binding
- public class MyFreezableConverter : Freezable, IValueConverter
- {
- // 示例依赖属性:Prefix
- public string Prefix
- {
- get => (string)GetValue(PrefixProperty);
- set => SetValue(PrefixProperty, value);
- }
- public static readonly DependencyProperty PrefixProperty =
- DependencyProperty.Register(
- nameof(Prefix),
- typeof(string),
- typeof(MyFreezableConverter),
- new PropertyMetadata(string.Empty)
- );
- // IValueConverter 实现
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var s = value?.ToString() ?? string.Empty;
- var prefix = Prefix ?? string.Empty;
- return prefix + s;
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- // Freezable 必须实现
- protected override Freezable CreateInstanceCore()
- {
- return new MyFreezableConverter();
- }
- }
- }
在 XAML 中这样使用(把转换器放在资源并对其依赖属性做绑定):
ExampleWindow.xaml
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root”>
- <Window.Resources>
- <!– 将 Prefix 绑定到窗口的某个属性或 VM 的属性 –>
- <local:MyFreezableConverter x:Key=“MyConverter”
- Prefix=“{Binding SomePrefixProperty, ElementName=Root}” />
- </Window.Resources>
- <StackPanel>
- <!– Converter 可以使用资源中的依赖属性值(并且当绑定的值变更时会更新) –>
- <TextBlock Text=“{Binding Path=Name, Converter={StaticResource MyConverter}}” />
- </StackPanel>
- </Window>
要点说明(Freezable 方案)
- 普通的 IValueConverter 是普通类,不在可视树上,不能直接使用 Binding 来更新其字段 / 属性;将转换器继承自 Freezable 后,你可以在转换器上注册 DependencyProperty,就能在 XAML 中对这些属性做 Binding。
- 必须实现 CreateInstanceCore ()。
- 把转换器声明在资源中(StaticResource)并给依赖属性绑定即可。
- 注意:如果转换器被 freeze(一般情况不会自动 freeze),绑定将不工作;通常通过 XAML 给资源的绑定会保持可变。
MultiBinding 方案
下面给出另一个常用替代方案:当你只是需要一个可绑定参数,可以使用 MultiBinding,把主值和额外的绑定一起传入 IMultiValueConverter。
NameAndPrefixMultiConverter.cs
- using System;
- using System.Globalization;
- using System.Windows.Data;
- namespace YourNamespace
- {
- public class NameAndPrefixMultiConverter : IMultiValueConverter
- {
- public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
- {
- // values[0] = 主绑定(例如 Name), values[1] = Prefix(来自另一个绑定)
- var name = values.Length > 0 ? values[0]?.ToString() ?? string.Empty : string.Empty;
- var prefix = values.Length > 1 ? values[1]?.ToString() ?? string.Empty : string.Empty;
- return prefix + name;
- }
- public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- }
- }
XAML 使用示例:
ExampleWindow_MultiBinding.xaml
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root”>
- <Window.Resources>
- <local:NameAndPrefixMultiConverter x:Key=“NameAndPrefixMultiConverter”/>
- </Window.Resources>
- <StackPanel>
- <TextBlock>
- <TextBlock.Text>
- <MultiBinding Converter=“{StaticResource NameAndPrefixMultiConverter}”>
- <!– 主值 –>
- <Binding Path=“Name” />
- <!– 作为可变“参数”的绑定 –>
- <Binding Path=“SomePrefixProperty” ElementName=“Root”/>
- </MultiBinding>
- </TextBlock.Text>
- </TextBlock>
- </StackPanel>
- </Window>
为什么不直接给 ConverterParameter 绑定?
- ConverterParameter 不是依赖属性,不能绑定(在 XAML 中写 {Binding …} 给 ConverterParameter 一般只会把 Binding 对象本身传进去,不会被解析为绑定值)。
- 解决办法就是上面两种:Freezable(让转换器本身具有可绑定的依赖属性)或 MultiBinding(把参数作为第二个绑定传入)。
常见陷阱与建议
- 如果转换器写成 Freezable 且放在 Application 或 Window 资源中并共享(x:Shared 默认 true),要确认绑定路径和 ElementName/RelativeSource 指向正确的元素;有时候把资源放在更接近目标的资源字典可以更容易地使用 ElementName。
- 如果转换器是纯 stateless(无需绑定运行时参数),继续使用普通静态实例(StaticResource)更节省开销。
- MultiBinding 在传入多个值时非常直接且常用;但如果转换器需要很多可绑定属性,Freezable 比较方便,代码更清晰。
我已经实现并展示了两种可行方案的完整代码和 XAML 示例。接下来我可以:
- 根据你当前项目的具体场景(你希望绑定哪个属性 / 来自哪个 DataContext / 使用 ElementName 还是绑定到 ViewModel),把示例改写成适配你代码的版本;
- 或者把转换器封装为 MarkupExtension 的方式(另一种进阶方法),如果你要我可以给出该方案的实现与说明。你希望我为你的具体用例提供示例吗?
把转换器封装为 MarkupExtension 的方式
下面补上把转换器封装为 MarkupExtension 的方式 —— 这样可以在 XAML 内联使用转换器并且支持把 Binding(作为属性)传给转换器。
实现思路是:让转换器继承 Freezable(从而可以声明 DependencyProperty 并接受 Binding),再写一个 MarkupExtension 在 ProvideValue 时创建转换器实例并把传入的 Binding(BindingBase 类型的属性)通过 BindingOperations 设置到转换器的依赖属性上。这样就可以在 XAML 中像下面这样写: Converter={local:PrefixConverter PrefixBinding={Binding SomePrefix}} 。(dlgcy:应为 local:PrefixConverterExtension ?)
我给出可直接拷贝的完整示例文件(C# + XAML)。
PrefixConverter.cs(同上节的 MyFreezableConverter.cs)
- using System;
- using System.Globalization;
- using System.Windows;
- using System.Windows.Data;
- namespace YourNamespace
- {
- // 继承 Freezable 以支持在转换器上使用 Binding(通过 DependencyProperty)
- public class PrefixConverter : Freezable, IValueConverter
- {
- public string Prefix
- {
- get => (string)GetValue(PrefixProperty);
- set => SetValue(PrefixProperty, value);
- }
- public static readonly DependencyProperty PrefixProperty =
- DependencyProperty.Register(
- nameof(Prefix),
- typeof(string),
- typeof(PrefixConverter),
- new PropertyMetadata(string.Empty)
- );
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var s = value?.ToString() ?? string.Empty;
- var prefix = Prefix ?? string.Empty;
- return prefix + s;
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- // Freezable 必须实现
- protected override Freezable CreateInstanceCore()
- {
- return new PrefixConverter();
- }
- }
- }
PrefixConverterExtension.cs
- using System;
- using System.Windows.Data;
- using System.Windows.Markup;
- using System.Windows;
- namespace YourNamespace
- {
- // MarkupExtension:在 XAML 中可以传入静态值或 Binding(作为 PrefixBinding)
- public class PrefixConverterExtension : MarkupExtension
- {
- // 允许静态字符串
- public string Prefix { get; set; }
- // 允许传入 Binding 或其他 BindingBase(例如 Binding/RelativeSource 等)
- public BindingBase PrefixBinding { get; set; }
- public PrefixConverterExtension() { }
- // 支持用构造函数传入静态前缀: {local:PrefixConverterExtension ‘Hello: ‘}
- public PrefixConverterExtension(string prefix)
- {
- Prefix = prefix;
- }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- // 每次 ProvideValue 创建一个新的转换器实例(因此内联使用时不会被共享)
- var conv = new PrefixConverter();
- if (PrefixBinding != null)
- {
- // 把传入的 Binding 应用到转换器的依赖属性上
- BindingOperations.SetBinding(conv, PrefixConverter.PrefixProperty, PrefixBinding);
- }
- else if (Prefix != null)
- {
- conv.Prefix = Prefix;
- }
- return conv;
- }
- }
- }
示例 XAML(展示内联绑定与静态参数两种用法):
ExampleWindow.xaml(v2)
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root” Title=“示例” Height=“200” Width=“400”>
- <StackPanel Margin=“12”>
- <!– 示例 DataContext 假设有 Name 和 SomePrefixProperty –>
- <!– 1) 使用静态前缀 –>
- <TextBlock Margin=“0,0,0,8”
- Text=“{Binding Name, Converter={local:PrefixConverterExtension ‘Static: ‘}}”/>
- <!– 2) 内联把 Binding 传给转换器的 Prefix 依赖属性(PrefixBinding 可以是任意 Binding) –>
- <TextBlock>
- <TextBlock.Text>
- <Binding Path=“Name”>
- <Binding.Converter>
- <!– 这里把窗口上的 SomePrefixProperty 作为 Prefix 传入转换器 –>
- <local:PrefixConverterExtension PrefixBinding=“{Binding SomePrefixProperty, ElementName=Root}” />
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <!– 3) 更常见的简写形式(直接在属性里写): –>
- <!– Text=”{Binding Name, Converter={local:PrefixConverterExtension PrefixBinding={Binding SomePrefixProperty, ElementName=Root}}}” –>
- </StackPanel>
- </Window>
要点总结与注意事项
- 这种做法的优点:可以在单一表达式里把 Binding 传给转换器的属性(例如前缀、格式字符串、其它运行时参数),不需要把转换器放在资源并单独为其设置绑定。
- 转换器继承 Freezable 是关键(Freezable 可以作为 Binding 的目标并使用依赖属性)。
- ProvideValue 中返回的转换器实例通常是每次创建新实例(内联用法),因此不会被共享;如果希望在资源中重用,需要注意 x:Shared 和绑定目标(可能需要 x:Shared=”False” 或其他技巧)。
- ConverterParameter 仍然不能绑定;如果你需要把多个可绑定值传进转换器,也可以使用 MultiBinding + IMultiValueConverter(我之前已有示例)。
- 当在资源字典中共享实例时要注意 ElementName/RelativeSource 的可见性 / 作用域;内联 MarkupExtension 更易于在当前上下文里解析绑定。
我已把上述 MarkupExtension + Freezable converter 的实现和 XAML 示例都列出,你可以直接把两个 C# 文件加入到项目并在 XAML 中按示例使用。接下来如果你希望,我可以:
- 把该转换器扩展为通用的带多个可绑定参数的模板(例如多个 Binding 属性),或者
- 根据你项目的具体 DataContext / 属性名,把示例改写为可直接运行的代码。
扩展为通用的带多个可绑定参数的模板
下面给出一个可直接复用的「通用多参数可绑定转换器模板」。思路与要点:
- 使用 Freezable 的子类作为转换器(可声明依赖属性并作为绑定目标)。
- 定义一个可在 XAML 中作为子元素添加的 ConverterParameter(也是 Freezable),包含 Name 与 Value(Value 可绑定)。
- 提供一个抽象基类 MultiParameterConverterBase,子类只需实现带参数集合的 Convert 逻辑即可。
- 演示一个具体实现 FormatConverter(读取名为 Format、Prefix、Suffix 的参数),并给出 XAML 使用示例(在 Binding 内联转换器并把多个绑定的参数作为子元素传入)。
下面是可拷贝到项目里的文件。
ConverterParameter.cs
- using System;
- using System.Windows;
- namespace YourNamespace.Converters
- {
- // 单个可绑定参数,Freezable 允许 Value 使用 Binding
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(
- nameof(Name),
- typeof(string),
- typeof(ConverterParameter),
- new PropertyMetadata(string.Empty)
- );
- // Value 可以是任意对象,也可以通过 Binding 设置
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(
- nameof(Value),
- typeof(object),
- typeof(ConverterParameter),
- new PropertyMetadata(null)
- );
- protected override Freezable CreateInstanceCore()
- {
- return new ConverterParameter();
- }
- }
- }
MultiParameterConverterBase.cs
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Linq;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- // 允许在 XAML 中把 <ConverterParameter …/> 作为子元素添加到 Parameters
- [ContentProperty(nameof(Parameters))]
- public abstract class MultiParameterConverterBase : Freezable, IValueConverter
- {
- // 一个 FreezableCollection 用来存放 ConverterParameter(可绑定)
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(
- nameof(Parameters),
- typeof(FreezableCollection<ConverterParameter>),
- typeof(MultiParameterConverterBase),
- new PropertyMetadata(null)
- );
- protected MultiParameterConverterBase()
- {
- // 确保默认集合存在(方便 XAML child element 添加)
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- // 子类必须实现创建实例
- protected abstract override Freezable CreateInstanceCore();
- // 子类实现具体的转换逻辑(带参数集合)
- protected abstract object ConvertWithParameters(object value, Type targetType, object parameter, CultureInfo culture, IList<ConverterParameter> parameters);
- // IValueConverter 接口实现,内部把 Parameters 传给子类
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var list = Parameters ?? new FreezableCollection<ConverterParameter>();
- return ConvertWithParameters(value, targetType, parameter, culture, list);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- // 默认不支持,子类可以重写(也可以保持默认)
- throw new NotSupportedException();
- }
- // 辅助:按 Name 找到参数值并转换为指定类型
- protected T GetParameterValue<T>(IList<ConverterParameter> parameters, string name, T defaultValue = default)
- {
- if (parameters == null || string.IsNullOrEmpty(name)) return defaultValue;
- var p = parameters.FirstOrDefault(x => string.Equals(x?.Name, name, StringComparison.Ordinal));
- if (p == null) return defaultValue;
- if (p.Value is T t) return t;
- try
- {
- if (p.Value == null) return defaultValue;
- return (T)System.Convert.ChangeType(p.Value, typeof(T), CultureInfo.InvariantCulture);
- }
- catch
- {
- return defaultValue;
- }
- }
- }
- // 一个示例具体实现:格式化并可使用 Prefix/Suffix
- public class FormatConverter : MultiParameterConverterBase
- {
- protected override Freezable CreateInstanceCore()
- {
- return new FormatConverter();
- }
- protected override object ConvertWithParameters(object value, Type targetType, object parameter, CultureInfo culture, IList<ConverterParameter> parameters)
- {
- // 示例约定:支持 Format、Prefix、Suffix 三个参数(都可绑定)
- var format = GetParameterValue<string>(parameters, “Format”, “{0}”);
- var prefix = GetParameterValue<string>(parameters, “Prefix”, string.Empty);
- var suffix = GetParameterValue<string>(parameters, “Suffix”, string.Empty);
- string result;
- try
- {
- result = string.Format(culture ?? CultureInfo.CurrentCulture, format, value);
- }
- catch
- {
- // 如果 format 不合法,退回到简单的 ToString()
- result = value?.ToString() ?? string.Empty;
- }
- return prefix + result + suffix;
- }
- }
- }
ExampleViewModel.cs
- using System.ComponentModel;
- using System.Runtime.CompilerServices;
- namespace YourNamespace
- {
- public class ExampleViewModel : INotifyPropertyChanged
- {
- private string _name = “Alice”;
- private string _format = “Name: {0}”;
- private string _prefix = “[“;
- private string _suffix = “]”;
- public string Name
- {
- get => _name;
- set { _name = value; OnPropertyChanged(); }
- }
- public string FormatString
- {
- get => _format;
- set { _format = value; OnPropertyChanged(); }
- }
- public string Prefix
- {
- get => _prefix;
- set { _prefix = value; OnPropertyChanged(); }
- }
- public string Suffix
- {
- get => _suffix;
- set { _suffix = value; OnPropertyChanged(); }
- }
- public event PropertyChangedEventHandler PropertyChanged;
- void OnPropertyChanged([CallerMemberName] string name = null) => PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(name));
- }
- }
ExampleWindow.xaml
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:conv=“clr-namespace:YourNamespace.Converters”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root”
- Title=“Multi-Parameter Converter 示例” Height=“200” Width=“400”>
- <Window.DataContext>
- <local:ExampleViewModel/>
- </Window.DataContext>
- <StackPanel Margin=“12” VerticalAlignment=“Top”>
- <!– 1) 把多个可绑定参数作为 Converter 的子元素传入(Parameters 是 ContentProperty) –>
- <TextBlock Margin=“0,0,0,8”>
- <TextBlock.Text>
- <Binding Path=“Name”>
- <Binding.Converter>
- <conv:FormatConverter>
- <conv:FormatConverter.Parameters>
- <!– 这些 ConverterParameter 可以使用 Binding –>
- <conv:ConverterParameter Name=“Format” Value=“{Binding FormatString, ElementName=Root}”/>
- <conv:ConverterParameter Name=“Prefix” Value=“{Binding Prefix, ElementName=Root}”/>
- <conv:ConverterParameter Name=“Suffix” Value=“{Binding Suffix, ElementName=Root}”/>
- </conv:FormatConverter.Parameters>
- </conv:FormatConverter>
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <!– 2) 修改 ViewModel 中的参数,绑定会自动更新显示 –>
- <StackPanel Orientation=“Horizontal” Margin=“0,8,0,0”>
- <TextBlock Text=“Format:” VerticalAlignment=“Center” Margin=“0,0,6,0”/>
- <TextBox Width=“200” Text=“{Binding FormatString, UpdateSourceTrigger=PropertyChanged}”/>
- </StackPanel>
- <StackPanel Orientation=“Horizontal” Margin=“0,8,0,0”>
- <TextBlock Text=“Prefix:” VerticalAlignment=“Center” Margin=“0,0,6,0”/>
- <TextBox Width=“60” Text=“{Binding Prefix, UpdateSourceTrigger=PropertyChanged}”/>
- <TextBlock Text=“Suffix:” VerticalAlignment=“Center” Margin=“12,0,6,0”/>
- <TextBox Width=“60” Text=“{Binding Suffix, UpdateSourceTrigger=PropertyChanged}”/>
- </StackPanel>
- </StackPanel>
- </Window>
使用说明与注意事项
- 把这些文件加入你的项目(命名空间按需要调整)。ConverterParameter 和 MultiParameterConverterBase 都是 Freezable,因此 ConverterParameter.Value 可以通过 Binding 设置并在运行时更新。
- 在 XAML 中,MultiParameterConverterBase 声明了 ContentProperty 为 Parameters,可以把多个 <conv:ConverterParameter …/> 放在转换器内作为子元素,且每个 ConverterParameter 的 Value 可以是 Binding/ElementName/RelativeSource 等任意 Binding。
- 你可以基于 MultiParameterConverterBase 实现任意业务逻辑的转换器:在 ConvertWithParameters 中读取需要的参数(通过 Name)并执行逻辑。
- 如果想内联更简便的 MarkupExtension(例如像 earlier PrefixConverterExtension 那样在属性内直接写 Converter={local:… PrefixBinding=…}),也可以按同样思路实现:在 ProvideValue 中创建转换器实例并通过 BindingOperations.SetBinding 把外部传入的 Binding 应用到 ConverterParameter.Value 上。上面示例为了简单与清晰,采用了 XAML 子元素方式(更直观且不需要额外的 MarkupExtension)。
如果你愿意,我可以接着提供:
- 一个通用的 MarkupExtension 版本(允许在单个表达式内传入多个 Binding 参数);
- 或把示例改成 IMultiValueConverter + MultiBinding 风格的通用模板(若你更偏向把多个值并列传入转换器)。
你想接着要哪一个(MarkupExtension 版 或 IMultiValueConverter 版)?
可直接复用的 MarkupExtension 版本
下面给出一个可直接复用的 MarkupExtension 版本 —— 它允许在单一表达式或对象元素中内联创建一个带多个可绑定参数的转换器。实现思路:
- 使用 Freezable 的 ConverterParameter(Value 可绑定);
- 使用一个抽象基类 MultiParameterConverterBase(继承 Freezable 并包含 Parameters 集合),子类只需实现 ConvertWithParameters;
- 提供 MultiParamConverterExtension(MarkupExtension),它接受 ConverterType(要创建的转换器类型)并通过子元素接收一组 ConverterParameter,然后在 ProvideValue 时为创建的转换器克隆并注入这些参数(保持绑定的生效)。
我把主要文件都给出,你可以直接复制到项目并按示例 XAML 使用。
ConverterParameter.cs(v2,好像和 v1 一样)
- using System;
- using System.Windows;
- namespace YourNamespace.Converters
- {
- // 单个可绑定参数,Freezable 允许 Value 使用 Binding
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(
- nameof(Name),
- typeof(string),
- typeof(ConverterParameter),
- new PropertyMetadata(string.Empty)
- );
- // Value 可以是任意对象,也可以通过 Binding 设置
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(
- nameof(Value),
- typeof(object),
- typeof(ConverterParameter),
- new PropertyMetadata(null)
- );
- protected override Freezable CreateInstanceCore()
- {
- return new ConverterParameter();
- }
- }
- }
MultiParameterConverterBase.cs(v2)
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Linq;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- // 允许直接把 ConverterParameter 作为子元素添加到转换器(如果你直接把转换器写成对象元素)
- [ContentProperty(nameof(Parameters))]
- public abstract class MultiParameterConverterBase : Freezable, IValueConverter
- {
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(
- nameof(Parameters),
- typeof(FreezableCollection<ConverterParameter>),
- typeof(MultiParameterConverterBase),
- new PropertyMetadata(null)
- );
- protected MultiParameterConverterBase()
- {
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- // 子类必须实现创建实例
- protected abstract override Freezable CreateInstanceCore();
- // 子类实现具体的转换逻辑(带参数集合)
- protected abstract object ConvertWithParameters(object value, Type targetType, object parameter, CultureInfo culture, IList<ConverterParameter> parameters);
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var list = Parameters ?? new FreezableCollection<ConverterParameter>();
- return ConvertWithParameters(value, targetType, parameter, culture, list);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- protected T GetParameterValue<T>(IList<ConverterParameter> parameters, string name, T defaultValue = default)
- {
- if (parameters == null || string.IsNullOrEmpty(name)) return defaultValue;
- var p = parameters.FirstOrDefault(x => string.Equals(x?.Name, name, StringComparison.Ordinal));
- if (p == null) return defaultValue;
- if (p.Value is T t) return t;
- try
- {
- if (p.Value == null) return defaultValue;
- return (T)System.Convert.ChangeType(p.Value, typeof(T), CultureInfo.InvariantCulture);
- }
- catch
- {
- return defaultValue;
- }
- }
- }
- // 示例具体实现:格式化并可使用 Format/Prefix/Suffix 三个参数
- public class FormatConverter : MultiParameterConverterBase
- {
- protected override Freezable CreateInstanceCore()
- {
- return new FormatConverter();
- }
- protected override object ConvertWithParameters(object value, Type targetType, object parameter, CultureInfo culture, IList<ConverterParameter> parameters)
- {
- var format = GetParameterValue<string>(parameters, “Format”, “{0}”);
- var prefix = GetParameterValue<string>(parameters, “Prefix”, string.Empty);
- var suffix = GetParameterValue<string>(parameters, “Suffix”, string.Empty);
- string result;
- try
- {
- result = string.Format(culture ?? CultureInfo.CurrentCulture, format, value);
- }
- catch
- {
- result = value?.ToString() ?? string.Empty;
- }
- return prefix + result + suffix;
- }
- }
- }
MultiParamConverterExtension.cs
- using System;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- // 作为 MarkupExtension 使用:可以把多个 <ConverterParameter/> 作为子元素传入
- // 用法(示例):
- // <Binding.Converter>
- // <conv:MultiParamConverterExtension ConverterType=”{x:Type conv:FormatConverter}”>
- // <conv:ConverterParameter Name=”Format” Value=”{Binding FormatString, ElementName=Root}”/>
- // <conv:ConverterParameter Name=”Prefix” Value=”{Binding Prefix, ElementName=Root}”/>
- // </conv:MultiParamConverterExtension>
- // </Binding.Converter>
- [ContentProperty(nameof(Parameters))]
- public class MultiParamConverterExtension : MarkupExtension
- {
- // 必填:要创建的转换器类型,必须继承自 MultiParameterConverterBase
- public Type ConverterType { get; set; }
- // 子元素接收的参数集合(ConverterParameter 是 Freezable,Value 可绑定)
- public FreezableCollection<ConverterParameter> Parameters { get; } = new FreezableCollection<ConverterParameter>();
- public MultiParamConverterExtension() { }
- public MultiParamConverterExtension(Type converterType)
- {
- ConverterType = converterType;
- }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- if (ConverterType == null)
- throw new InvalidOperationException(“ConverterType must be set.”);
- if (!typeof(MultiParameterConverterBase).IsAssignableFrom(ConverterType))
- throw new InvalidOperationException(“ConverterType must derive from MultiParameterConverterBase.”);
- // 创建转换器实例(每次 ProvideValue 都创建新的转换器,避免共享导致绑定混乱)
- var converter = (MultiParameterConverterBase)Activator.CreateInstance(ConverterType);
- // 克隆每个传入的 ConverterParameter 并添加到 converter 的 Parameters 集合
- foreach (var p in Parameters)
- {
- if (p == null) continue;
- // 使用 Freezable.Clone() 克隆以避免对象共享
- var cloned = (ConverterParameter)p.Clone();
- converter.Parameters.Add(cloned);
- }
- return converter;
- }
- }
- }
ExampleWindow.xaml
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:conv=“clr-namespace:YourNamespace.Converters”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root”
- Title=“MultiParam MarkupExtension 示例” Height=“240” Width=“480”>
- <Window.DataContext>
- <local:ExampleViewModel/>
- </Window.DataContext>
- <StackPanel Margin=“12”>
- <TextBlock Margin=“0,0,0,12”>
- <TextBlock.Text>
- <Binding Path=“Name”>
- <Binding.Converter>
- <conv:MultiParamConverterExtension ConverterType=“{x:Type conv:FormatConverter}”>
- <conv:ConverterParameter Name=“Format” Value=“{Binding FormatString, ElementName=Root}”/>
- <conv:ConverterParameter Name=“Prefix” Value=“{Binding Prefix, ElementName=Root}”/>
- <conv:ConverterParameter Name=“Suffix” Value=“{Binding Suffix, ElementName=Root}”/>
- </conv:MultiParamConverterExtension>
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <StackPanel Orientation=“Horizontal” Margin=“0,6”>
- <TextBlock Text=“Format:” VerticalAlignment=“Center” Margin=“0,0,6,0”/>
- <TextBox Width=“260” Text=“{Binding FormatString, UpdateSourceTrigger=PropertyChanged}”/>
- </StackPanel>
- <StackPanel Orientation=“Horizontal” Margin=“0,6”>
- <TextBlock Text=“Prefix:” VerticalAlignment=“Center” Margin=“0,0,6,0”/>
- <TextBox Width=“80” Text=“{Binding Prefix, UpdateSourceTrigger=PropertyChanged}”/>
- <TextBlock Text=“Suffix:” VerticalAlignment=“Center” Margin=“12,0,6,0”/>
- <TextBox Width=“80” Text=“{Binding Suffix, UpdateSourceTrigger=PropertyChanged}”/>
- </StackPanel>
- </StackPanel>
- </Window>
说明、注意事项与扩展建议
- 用法很直观:在 Binding.Converter 中内联一个 MultiParamConverterExtension,并以子元素形式写几个 <conv:ConverterParameter Name=”…” Value=”{Binding …}”/>。这些参数的 Value 支持任意 Binding(ElementName/RelativeSource/DataContext 都有效)。
- 在 ProvideValue 中为转换器创建新实例并克隆参数,避免多个目标共享同一参数对象导致绑定冲突。
- 要点:ConverterType 必须派生自 MultiParameterConverterBase;你可以随意实现更多具体转换器(例如基于参数做格式化、条件选择、单位转换等)。
- 若你希望直接在 Converter={…} 的简写内使用(非对象元素语法),XAML 解析器仍允许小量内联属性写法,但传递多个参数时对象元素语法(如示例)更清晰可靠。(dlgcy:这也导致和上一小节的效果差别不大)
接下来我可以:
- 把这套代码改为支持在 MarkupExtension 中直接以属性传入简单静态参数(例如 Params=”Prefix='[‘;Suffix=’]’ Format=’…'”)并同时支持 Binding;
- 或者把扩展做得更通用(例如允许传入一个已存在的 converter 实例、或者支持从资源重用并注入参数)。
你希望我先做哪一种扩展?
在 MarkupExtension 基础上增加一个 Params 字符串属性
我按你的 “第一种” 要求实现了:在之前的 MarkupExtension 基础上增加一个 Params 字符串属性,用于在单个属性中传入多个静态参数(例如 Params=”Format=’Name: {0}’; Prefix='[‘; Suffix=’]'”),同时保留通过子元素传入的 ConverterParameter(支持 Binding)。子元素的参数会覆盖 Params 中同名的静态参数,从而同时支持静态与可绑定参数的混合使用。
下面是我修改 / 新增的文件(可直接拷贝到项目)。说明在每个文件之后给出简短示例与注意事项。
ConverterParameter.cs(v3)
- using System;
- using System.Windows;
- namespace YourNamespace.Converters
- {
- // 单个可绑定参数,Freezable 允许 Value 使用 Binding
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(
- nameof(Name),
- typeof(string),
- typeof(ConverterParameter),
- new PropertyMetadata(string.Empty)
- );
- // Value 可以是任意对象,也可以通过 Binding 设置
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(
- nameof(Value),
- typeof(object),
- typeof(ConverterParameter),
- new PropertyMetadata(null)
- );
- protected override Freezable CreateInstanceCore()
- {
- return new ConverterParameter();
- }
- }
- }
MultiParameterConverterBase.cs(v3)
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Linq;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- // 允许直接把 ConverterParameter 作为子元素添加到转换器(如果你直接把转换器写成对象元素)
- [ContentProperty(nameof(Parameters))]
- public abstract class MultiParameterConverterBase : Freezable, IValueConverter
- {
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(
- nameof(Parameters),
- typeof(FreezableCollection<ConverterParameter>),
- typeof(MultiParameterConverterBase),
- new PropertyMetadata(null)
- );
- protected MultiParameterConverterBase()
- {
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- // 子类必须实现创建实例
- protected abstract override Freezable CreateInstanceCore();
- // 子类实现具体的转换逻辑(带参数集合)
- protected abstract object ConvertWithParameters(object value, Type targetType, object parameter, CultureInfo culture, IList<ConverterParameter> parameters);
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var list = Parameters ?? new FreezableCollection<ConverterParameter>();
- return ConvertWithParameters(value, targetType, parameter, culture, list);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- protected T GetParameterValue<T>(IList<ConverterParameter> parameters, string name, T defaultValue = default)
- {
- if (parameters == null || string.IsNullOrEmpty(name)) return defaultValue;
- var p = parameters.FirstOrDefault(x => string.Equals(x?.Name, name, StringComparison.Ordinal));
- if (p == null) return defaultValue;
- if (p.Value is T t) return t;
- try
- {
- if (p.Value == null) return defaultValue;
- return (T)System.Convert.ChangeType(p.Value, typeof(T), CultureInfo.InvariantCulture);
- }
- catch
- {
- return defaultValue;
- }
- }
- }
- // 示例具体实现:格式化并可使用 Format/Prefix/Suffix 三个参数
- public class FormatConverter : MultiParameterConverterBase
- {
- protected override Freezable CreateInstanceCore()
- {
- return new FormatConverter();
- }
- protected override object ConvertWithParameters(object value, Type targetType, object parameter, CultureInfo culture, IList<ConverterParameter> parameters)
- {
- var format = GetParameterValue<string>(parameters, “Format”, “{0}”);
- var prefix = GetParameterValue<string>(parameters, “Prefix”, string.Empty);
- var suffix = GetParameterValue<string>(parameters, “Suffix”, string.Empty);
- string result;
- try
- {
- result = string.Format(culture ?? CultureInfo.CurrentCulture, format, value);
- }
- catch
- {
- result = value?.ToString() ?? string.Empty;
- }
- return prefix + result + suffix;
- }
- }
- }
MultiParamConverterExtension.cs(v2)
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Text;
- using System.Text.RegularExpressions;
- using System.Windows;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- // MarkupExtension:支持两种方式传参
- // 1) 使用 Params 字符串传入一组静态参数,例如:
- // Params=”Format=’Name: {0}’; Prefix='[‘; Suffix=’]'”
- // 2) 使用子元素传入 ConverterParameter(Value 可绑定),例如:
- // <conv:ConverterParameter Name=”Prefix” Value=”{Binding Prefix, ElementName=Root}” />
- // 子元素参数会覆盖 Params 中同名的值。
- [ContentProperty(nameof(Parameters))]
- public class MultiParamConverterExtension : MarkupExtension
- {
- public Type ConverterType { get; set; }
- // 静态参数字符串(解析为 key/value 对)
- public string Params { get; set; }
- // 子元素方式传入的参数(支持 Binding,因为 ConverterParameter 是 Freezable)
- public FreezableCollection<ConverterParameter> Parameters { get; } = new FreezableCollection<ConverterParameter>();
- public MultiParamConverterExtension() { }
- public MultiParamConverterExtension(Type converterType)
- {
- ConverterType = converterType;
- }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- if (ConverterType == null)
- throw new InvalidOperationException(“ConverterType must be set.”);
- if (!typeof(MultiParameterConverterBase).IsAssignableFrom(ConverterType))
- throw new InvalidOperationException(“ConverterType must derive from MultiParameterConverterBase.”);
- // 创建新的转换器实例(每次 ProvideValue 都创建新实例,避免共享绑定冲突)
- var converter = (MultiParameterConverterBase)Activator.CreateInstance(ConverterType);
- // 1) 先解析 Params 字符串(静态参数)
- var parsed = ParseParamsString(Params);
- // 把解析结果加入 converter.Parameters(作为 ConverterParameter)
- foreach (var kv in parsed)
- {
- var cp = new ConverterParameter { Name = kv.Key, Value = kv.Value };
- converter.Parameters.Add(cp);
- }
- // 2) 再把子元素的 ConverterParameter 克隆并放入 converter.Parameters
- // 子元素同名参数会覆盖 Params 的静态参数
- foreach (var p in Parameters)
- {
- if (p == null) continue;
- var cloned = (ConverterParameter)p.Clone();
- // 如果存在同名的静态参数,先移除静态那个(实现子元素覆盖)
- var existing = FindParameterByName(converter.Parameters, cloned.Name);
- if (existing != null)
- {
- converter.Parameters.Remove(existing);
- }
- converter.Parameters.Add(cloned);
- }
- return converter;
- }
- // 找到同名参数
- private ConverterParameter FindParameterByName(FreezableCollection<ConverterParameter> list, string name)
- {
- if (list == null || string.IsNullOrEmpty(name)) return null;
- foreach (var p in list)
- if (string.Equals(p?.Name, name, StringComparison.Ordinal))
- return p;
- return null;
- }
- // 简单解析 Params 字符串为字典
- // 支持分号或逗号分隔,值可以用单引号或双引号包裹或不包裹(不包裹则以空格或分号分割)
- // 例如:
- // Format=’Name: {0}’; Prefix='[‘; Suffix=’]’
- // 返回的 value 为未去转义的字符串
- private static Dictionary<string, object> ParseParamsString(string s)
- {
- var result = new Dictionary<string, object>(StringComparer.Ordinal);
- if (string.IsNullOrWhiteSpace(s)) return result;
- // 简单状态机解析 key=value 对,支持 quotes
- int i = 0;
- int n = s.Length;
- while (i < n)
- {
- // 跳过空白和分隔符
- while (i < n && (char.IsWhiteSpace(s[i]) || s[i] == ‘;’ || s[i] == ‘,’))
- i++;
- if (i >= n) break;
- // 读取 key
- int keyStart = i;
- while (i < n && s[i] != ‘=’ && s[i] != ‘;’ && s[i] != ‘,’)
- i++;
- if (i >= n || s[i] != ‘=’)
- {
- // 不合法片段:跳过到下个分隔符
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- continue;
- }
- string key = s.Substring(keyStart, i – keyStart).Trim();
- i++; // 跳过 ‘=’
- // 读取 value
- while (i < n && char.IsWhiteSpace(s[i])) i++;
- if (i >= n)
- {
- result[key] = string.Empty;
- break;
- }
- string value;
- if (s[i] == ‘\” || s[i] == ‘\”‘)
- {
- char quote = s[i++];
- int valStart = i;
- var sb = new StringBuilder();
- while (i < n)
- {
- if (s[i] == ‘\\’ && i + 1 < n)
- {
- // 支持简单转义 \’ \” \\ 等
- i++;
- sb.Append(s[i]);
- i++;
- continue;
- }
- if (s[i] == quote)
- {
- i++;
- break;
- }
- sb.Append(s[i]);
- i++;
- }
- value = sb.ToString();
- }
- else
- {
- // 非引号形式,读到下一个分号或逗号
- int valStart = i;
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’)
- i++;
- value = s.Substring(valStart, i – valStart).Trim();
- }
- // 存储(保持字符串类型;如需特殊类型解析可在 converter 中处理)
- if (!string.IsNullOrEmpty(key))
- result[key] = value;
- }
- return result;
- }
- }
- }
示例 XAML(展示 Params 静态参数 与 子元素 Binding 同时使用):
ExampleWindow.xaml
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:conv=“clr-namespace:YourNamespace.Converters”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root”
- Title=“MultiParam MarkupExtension Params 示例” Height=“260” Width=“520”>
- <Window.DataContext>
- <local:ExampleViewModel/>
- </Window.DataContext>
- <StackPanel Margin=“12”>
- <!– 用 Params 传入静态参数(快捷) –>
- <TextBlock Margin=“0,0,0,12”>
- <TextBlock.Text>
- <Binding Path=“Name”>
- <Binding.Converter>
- <conv:MultiParamConverterExtension ConverterType=“{x:Type conv:FormatConverter}”
- Params=“Format=’Name: {0}’; Prefix='[‘; Suffix=’]'”/>
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <!– 混合用法:Params 提供默认静态参数,但使用子元素的 ConverterParameter 来绑定 Prefix(子元素会覆盖 Params 中的 Prefix) –>
- <TextBlock Margin=“0,0,0,12”>
- <TextBlock.Text>
- <Binding Path=“Name”>
- <Binding.Converter>
- <conv:MultiParamConverterExtension ConverterType=“{x:Type conv:FormatConverter}”
- Params=“Format='{{0}}’; Prefix='(static)’; Suffix='(static)'”>
- <!– 通过子元素绑定 Prefix,这个绑定会覆盖 Params 中的 Prefix –>
- <conv:ConverterParameter Name=“Prefix” Value=“{Binding Prefix, ElementName=Root}”/>
- </conv:MultiParamConverterExtension>
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <!– 控件修改绑定值 –>
- <StackPanel Orientation=“Horizontal” Margin=“0,6”>
- <TextBlock Text=“Prefix:” VerticalAlignment=“Center” Margin=“0,0,6,0”/>
- <TextBox Width=“120” Text=“{Binding Prefix, UpdateSourceTrigger=PropertyChanged}”/>
- <TextBlock Text=“Suffix:” VerticalAlignment=“Center” Margin=“12,0,6,0”/>
- <TextBox Width=“120” Text=“{Binding Suffix, UpdateSourceTrigger=PropertyChanged}”/>
- </StackPanel>
- </StackPanel>
- </Window>
简要说明(我做了什么)
- 在 MultiParamConverterExtension 中新增 Params 字符串解析逻辑,允许在单个属性内写多组静态参数(格式简单、支持单 / 双引号和转义)。
- 保留并使用子元素 ConverterParameter(Freezable)以支持 Binding;在 ProvideValue 中先把 Params 解析成静态 ConverterParameter,再把子元素参数克隆并覆盖同名静态参数,从而实现静态与绑定参数混合使用且子元素优先。
- 仍然要求 ConverterType 继承 MultiParameterConverterBase(与之前一致),以方便多参数逻辑在 ConvertWithParameters 中统一处理。
注意事项与扩展建议
- Params 的值被作为字符串传入并保存在 ConverterParameter.Value(类型是 string)。如果你需要 Params 支持直接解析成其他类型(例如数值、布尔等),可以在 ParseParamsString 中添加类型推断或在 ConvertWithParameters 中处理转换。
- 如果你希望在 Params 中也能写 Binding 表达式(例如 Prefix={Binding …}),那需要在 ProvideValue 中对解析出的值识别这种 Binding 表达式并通过 BindingOperations 将其解析绑定到 ConverterParameter.Value(这是可做的,但 XAML attribute 内嵌复杂 Binding 语法解析不如子元素稳定)。当前实现建议:静态值放 Params,动态 Binding 放子元素 ConverterParameter。
- 我返回的转换器实例每次 ProvideValue 创建新的实例(避免多个目标共享同一转换器导致绑定冲突),这是通常更安全的做法。
接下来我可以:
- 为 Params 添加类型推断(自动把 “true”/”123” 转为 bool/int/double 等),或者
- 增加在 Params 中直接支持简化的 Binding 表达式解析(例如识别 “{Binding Path=…}” 并把它通过 BindingOperations 应用到参数上),或者
- 把整个实现封装成 NuGet 风格的可重用库并加上单元测试示例。
你希望我先把 Params 做类型推断,还是实现 Params 内直接识别并支持 “{Binding …}” 语法?
能把 转换器、可绑定属性 和 MarkupExtension 写在一个类中吗?
可以。下面我把 “转换器(IValueConverter)”、“可绑定属性(DependencyProperty,用于支持 Binding)” 和 “MarkupExtension(方便内联使用)” 合并成一个单个 C# 文件里的类:外层类是一个 MarkupExtension(用于 XAML 内联),它在 ProvideValue 时创建并返回一个内部的 Freezable 转换器实例;同一文件里包含内嵌的 Freezable 转换器类,转换器上声明了可绑定的 DependencyProperty,外层 MarkupExtension 支持把 Binding 直接作为属性(BindingBase 类型)传入并在 ProvideValue 用 BindingOperations 将其绑定到内部转换器的 DependencyProperty 上。这样在 XAML 中你可以在单一表达式里既传静态值也传 Binding。
我已经实现了一个示例:InlineFormatConverterExtension。它支持三个参数:Format、Prefix、Suffix,既可以用静态属性也可以用对应的 Binding(FormatBinding/PrefixBinding/SuffixBinding)。下面是文件(可直接拷贝到项目)和随后给出的 XAML 使用示例与注意事项。
InlineFormatConverterExtension.cs
- using System;
- using System.Globalization;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- /// <summary>
- /// MarkupExtension + convenience wrapper.
- /// 用法示例(在 XAML 中内联):
- /// Text=”{Binding Name, Converter={conv:InlineFormatConverterExtension Format=’Name: {0}’}}”
- /// Text=”{Binding Name, Converter={conv:InlineFormatConverterExtension PrefixBinding={Binding Prefix, ElementName=Root}}}”
- /// 说明:ProvideValue 会创建一个内部 Freezable 转换器实例并把 Binding 应用到该实例的 DependencyProperty 上。
- /// </summary>
- public class InlineFormatConverterExtension : MarkupExtension, IValueConverter
- {
- // 静态(编译时/标记)值
- public string Format { get; set; }
- public string Prefix { get; set; }
- public string Suffix { get; set; }
- // 可接收 Binding 的属性(允许在 XAML 中写 PrefixBinding=”{Binding …}”)
- public BindingBase FormatBinding { get; set; }
- public BindingBase PrefixBinding { get; set; }
- public BindingBase SuffixBinding { get; set; }
- // 默认构造
- public InlineFormatConverterExtension() { }
- // 支持用构造参数快速设置 Format
- public InlineFormatConverterExtension(string format)
- {
- Format = format;
- }
- // MarkupExtension: 在 ProvideValue 中创建内部 Freezable converter 并把 Binding(s) 应用上去
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- // 创建内部转换器实例(Freezable,可作为 Binding 目标)
- var conv = new InnerConverter();
- // 先设置静态值(如果有)
- if (Format != null) conv.Format = Format;
- if (Prefix != null) conv.Prefix = Prefix;
- if (Suffix != null) conv.Suffix = Suffix;
- // 如果外层接收了 Binding,则把 Binding 绑定到内部转换器的依赖属性上(会覆盖静态值)
- if (FormatBinding != null)
- BindingOperations.SetBinding(conv, InnerConverter.FormatProperty, FormatBinding);
- if (PrefixBinding != null)
- BindingOperations.SetBinding(conv, InnerConverter.PrefixProperty, PrefixBinding);
- if (SuffixBinding != null)
- BindingOperations.SetBinding(conv, InnerConverter.SuffixProperty, SuffixBinding);
- // 返回可直接作为 Converter 使用的实例(每次 ProvideValue 创建一个新实例,避免共享问题)
- return conv;
- }
- // 让外层类型也实现 IValueConverter(某些 XAML 解析器在需要时可能直接把 MarkupExtension 作为 Converter 使用)
- // 这里简单地在内部新建实例并委托调用,保证在极端情况下工作。
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.Convert(value, targetType, parameter, culture);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.ConvertBack(value, targetType, parameter, culture);
- }
- // 内部 Freezable 转换器,声明依赖属性以支持绑定
- private class InnerConverter : Freezable, IValueConverter
- {
- // Format DP
- public string Format
- {
- get => (string)GetValue(FormatProperty);
- set => SetValue(FormatProperty, value);
- }
- public static readonly DependencyProperty FormatProperty =
- DependencyProperty.Register(
- nameof(Format),
- typeof(string),
- typeof(InnerConverter),
- new PropertyMetadata(“{0}”)
- );
- // Prefix DP
- public string Prefix
- {
- get => (string)GetValue(PrefixProperty);
- set => SetValue(PrefixProperty, value);
- }
- public static readonly DependencyProperty PrefixProperty =
- DependencyProperty.Register(
- nameof(Prefix),
- typeof(string),
- typeof(InnerConverter),
- new PropertyMetadata(string.Empty)
- );
- // Suffix DP
- public string Suffix
- {
- get => (string)GetValue(SuffixProperty);
- set => SetValue(SuffixProperty, value);
- }
- public static readonly DependencyProperty SuffixProperty =
- DependencyProperty.Register(
- nameof(Suffix),
- typeof(string),
- typeof(InnerConverter),
- new PropertyMetadata(string.Empty)
- );
- protected override Freezable CreateInstanceCore()
- {
- return new InnerConverter();
- }
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var fmt = Format ?? “{0}”;
- var pre = Prefix ?? string.Empty;
- var suf = Suffix ?? string.Empty;
- string formatted;
- try
- {
- formatted = string.Format(culture ?? CultureInfo.CurrentCulture, fmt, value);
- }
- catch
- {
- formatted = value?.ToString() ?? string.Empty;
- }
- // 如果目标类型不是字符串并期望其它类型,可尝试类型转换,但这里返回字符串为主
- if (targetType == typeof(string) || targetType == null)
- return pre + formatted + suf;
- // 尝试把结果转换为目标类型(常见目标仍为 string)
- try
- {
- var res = pre + formatted + suf;
- return System.Convert.ChangeType(res, targetType, culture ?? CultureInfo.CurrentCulture);
- }
- catch
- {
- return pre + formatted + suf;
- }
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- }
- }
- }
XAML 使用示例(三种方式):
-
只用静态 Format: Text=”{Binding Name, Converter={converters:InlineFormatConverterExtension ‘Name: {0}’}}”
-
用 Binding 给 Prefix(内联绑定): Text=”{Binding Name, Converter={converters:InlineFormatConverterExtension PrefixBinding={Binding Prefix, ElementName=Root}}}”
-
同时用静态 Format 与 Binding 的 Prefix: Text=”{Binding Name, Converter={converters:InlineFormatConverterExtension Format=’Name: {0}’ PrefixBinding={Binding Prefix, ElementName=Root}}}”
说明我做了什么
- 我实现了一个 MarkupExtension(InlineFormatConverterExtension),它在 ProvideValue 时创建并返回一个内部 Freezable 转换器实例(InnerConverter)。
- 内部转换器声明了 DependencyProperty(Format/Prefix/Suffix),因此可以作为 Binding 的目标并在运行时响应变更。
- 外层扩展类既接受静态值(Format/Prefix/Suffix),也接受对应的 BindingBase(FormatBinding/PrefixBinding/SuffixBinding);在 ProvideValue 中会把这些 Binding 应用到内部转换器上,从而实现 “在单一类 / 文件中完成内联转换器 + 可绑定属性 + MarkupExtension” 的目标。
- 我同时让外层类实现了 IValueConverter 并委托给内部实例,以防某些 XAML 主机把 MarkupExtension 本身当作 Converter 直接使用。
限制和注意事项
- 虽然外层和内部都写在同一个文件 / 类里,但真正能接受 Binding 的对象是内部的 Freezable(因为 DependencyProperty 必须在 DependencyObject/Freezable 上注册)。
- 每次 ProvideValue 都创建新的内部转换器实例(避免多个控件共享同一实例导致 Binding 冲突),这会稍微增加开销,但通常是安全且常用的做法。
- 如果你希望在 Params 字符串中支持复杂类型或在属性里直接写 Binding 表达式(例如 Format=”{Binding …}”),建议把动态 Binding 写为 <… FormatBinding=”{Binding …}” /> 或使用子元素方式来更稳定地解析 Binding。
- 这个范式可以扩展:如果需要多个命名参数或更复杂的参数解析,可以把内层 Freezable 的 DP 增多,或把 Params 字符串解析逻辑加入到外层扩展。
接下来我可以:
- 把这个类扩展为支持任意数量的命名参数(类似之前的 ConverterParameter 集合 + Params 解析),或
- 把例子改为 IMultiValueConverter 风格(使用 MultiBinding)或
- 根据你的项目命名空间 / 样式把类改写并给出完整可运行的 Demo(包括 ViewModel 和 Window XAML)。
我已经把单文件实现给出,你要我现在把它扩展成支持任意命名参数(Params 字符串 + 子元素绑定混合),还是把它直接放入你项目的命名空间并提供完整 Demo?
扩展成支持任意命名参数
我把之前的思路整合为一个单文件实现:一个 MarkupExtension(支持在单一表达式中内联创建转换器并传静态 Params 或子元素绑定参数),内部包含一个 Freezable 转换器实例(支持任意命名参数的集合),并在 Convert 时把这些命名参数与主绑定值一起提供给模板(Template)或直接替换占位符。子元素的 ConverterParameter 支持 Binding,从而实现任意命名参数的可绑定功能;同时支持 Params 字符串快速写入静态参数。
下面是可直接拷贝到项目并使用的文件:
MultiParamInlineConverterExtension.cs
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Text;
- using System.Text.RegularExpressions;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- /// <summary>
- /// 单文件实现:MarkupExtension + 内部 Freezable 转换器 + 支持任意命名参数(静态 Params 字符串或子元素 ConverterParameter 可绑定)
- ///
- /// 用法示例:
- /// 1) 静态参数 + 模板:
- /// Text=”{Binding Name, Converter={conv:MultiParamInlineConverterExtension Template=’Hello {Title} {value}!’ Params=\”Title=’Ms.’; Lang=’en’\”}}”
- ///
- /// 2) 子元素绑定参数(支持 Binding):
- /// <TextBlock>
- /// <TextBlock.Text>
- /// <Binding Path=”Name”>
- /// <Binding.Converter>
- /// <conv:MultiParamInlineConverterExtension Template=”[{Lang}] {value} ({Suffix})”>
- /// <conv:ConverterParameter Name=”Lang” Value=”{Binding Lang, ElementName=Root}” />
- /// <conv:ConverterParameter Name=”Suffix” Value=”{Binding Suffix, ElementName=Root}” />
- /// </conv:MultiParamInlineConverterExtension>
- /// </Binding.Converter>
- /// </Binding>
- /// </TextBlock.Text>
- /// </TextBlock>
- ///
- /// 说明:
- /// – Template 中的占位符形如 {ParamName},内置名称 value 表示主绑定的值(即 Convert 的 value)。
- /// – 优先级:子元素 ConverterParameter 覆盖 Params 字符串里的同名静态参数。
- /// – 子元素 ConverterParameter.Value 支持任何 Binding(因为 ConverterParameter 是 Freezable)。
- /// </summary>
- [ContentProperty(nameof(Parameters))]
- public class MultiParamInlineConverterExtension : MarkupExtension, IValueConverter
- {
- // 可选:模板字符串,默认 “{value}”
- public string Template { get; set; } = “{value}”;
- // 简单快速静态参数字符串(例如: “Title=’Mr.’; Suffix=’]'”)
- public string Params { get; set; }
- // 子元素参数集合(支持 Binding)
- public FreezableCollection<ConverterParameter> Parameters { get; } = new FreezableCollection<ConverterParameter>();
- public MultiParamInlineConverterExtension() { }
- public MultiParamInlineConverterExtension(string template)
- {
- Template = template;
- }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- // 为每个目标创建新的 converter 实例,避免共享绑定冲突
- var converter = new InnerConverter();
- // 1) 解析静态 Params 字符串并加入参数集合
- var parsed = ParseParamsString(Params);
- foreach (var kv in parsed)
- {
- converter.Parameters.Add(new ConverterParameter { Name = kv.Key, Value = kv.Value });
- }
- // 2) 克隆并添加子元素中的 ConverterParameter(绑定形式),子元素覆盖静态 Params
- foreach (var p in Parameters)
- {
- if (p == null) continue;
- var cloned = (ConverterParameter)p.Clone();
- // 移除同名静态(如果有)
- var existing = FindParameterByName(converter.Parameters, cloned.Name);
- if (existing != null) converter.Parameters.Remove(existing);
- converter.Parameters.Add(cloned);
- }
- // 3) 设置模板
- if (!string.IsNullOrEmpty(Template))
- converter.Template = Template;
- return converter;
- }
- // 尽量兼容:当宿主直接把 MarkupExtension 当作 Converter 使用时,委托调用内部实例
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.Convert(value, targetType, parameter, culture);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.ConvertBack(value, targetType, parameter, culture);
- }
- // 查找同名参数辅助
- private ConverterParameter FindParameterByName(FreezableCollection<ConverterParameter> list, string name)
- {
- if (list == null || string.IsNullOrEmpty(name)) return null;
- foreach (var p in list)
- if (string.Equals(p?.Name, name, StringComparison.Ordinal))
- return p;
- return null;
- }
- // 解析 Params 字符串为字典(字符串值)
- private static Dictionary<string, object> ParseParamsString(string s)
- {
- var result = new Dictionary<string, object>(StringComparer.Ordinal);
- if (string.IsNullOrWhiteSpace(s)) return result;
- int i = 0, n = s.Length;
- while (i < n)
- {
- // skip whitespace and separators
- while (i < n && (char.IsWhiteSpace(s[i]) || s[i] == ‘;’ || s[i] == ‘,’)) i++;
- if (i >= n) break;
- int keyStart = i;
- while (i < n && s[i] != ‘=’ && s[i] != ‘;’ && s[i] != ‘,’) i++;
- if (i >= n || s[i] != ‘=’)
- {
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- continue;
- }
- string key = s.Substring(keyStart, i – keyStart).Trim();
- i++; // skip ‘=’
- while (i < n && char.IsWhiteSpace(s[i])) i++;
- if (i >= n)
- {
- result[key] = string.Empty;
- break;
- }
- string value;
- if (s[i] == ‘\” || s[i] == ‘”‘)
- {
- char quote = s[i++];
- var sb = new StringBuilder();
- while (i < n)
- {
- if (s[i] == ‘\\’ && i + 1 < n)
- {
- i++;
- sb.Append(s[i]);
- i++;
- continue;
- }
- if (s[i] == quote)
- {
- i++;
- break;
- }
- sb.Append(s[i]);
- i++;
- }
- value = sb.ToString();
- }
- else
- {
- int valStart = i;
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- value = s.Substring(valStart, i – valStart).Trim();
- }
- if (!string.IsNullOrEmpty(key))
- result[key] = value;
- }
- return result;
- }
- #region Nested types: ConverterParameter and InnerConverter
- // 单个参数(Freezable,支持 Binding)
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(nameof(Name), typeof(string), typeof(ConverterParameter), new PropertyMetadata(string.Empty));
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(nameof(Value), typeof(object), typeof(ConverterParameter), new PropertyMetadata(null));
- protected override Freezable CreateInstanceCore() => new ConverterParameter();
- }
- // 内部 Freezable 转换器:维护参数集合并实现 Convert
- private class InnerConverter : Freezable, IValueConverter
- {
- public string Template { get; set; } = “{value}”;
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(nameof(Parameters), typeof(FreezableCollection<ConverterParameter>), typeof(InnerConverter), new PropertyMetadata(null));
- public InnerConverter()
- {
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- protected override Freezable CreateInstanceCore()
- {
- return new InnerConverter();
- }
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- // Build parameter dictionary (name -> value)
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (Parameters != null)
- {
- foreach (var p in Parameters)
- {
- if (p == null || string.IsNullOrEmpty(p.Name)) continue;
- dict[p.Name] = p.Value;
- }
- }
- // expose main value under key “value”
- dict[“value”] = value;
- // Replace placeholders {Name} in Template
- string tpl = Template ?? “{value}”;
- string result = ReplacePlaceholders(tpl, dict, culture);
- // If targetType is string or null, return string
- if (targetType == null || targetType == typeof(string) || targetType == typeof(object))
- return result;
- // Try convert to requested targetType
- try
- {
- return System.Convert.ChangeType(result, targetType, culture ?? CultureInfo.CurrentCulture);
- }
- catch
- {
- return result;
- }
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- // 支持简单的 {Name} 占位符替换;如果占位符中含有 ‘:’,可支持简单格式如 {value:format}
- private static readonly Regex PlaceholderRegex = new Regex(@“\{(?<name>[^}:]+)(:(?<fmt>[^}]+))?\}”, RegexOptions.Compiled);
- private static string ReplacePlaceholders(string template, IDictionary<string, object> dict, CultureInfo culture)
- {
- if (string.IsNullOrEmpty(template)) return string.Empty;
- return PlaceholderRegex.Replace(template, m =>
- {
- var name = m.Groups[“name”].Value;
- var fmt = m.Groups[“fmt”].Success ? m.Groups[“fmt”].Value : null;
- if (!dict.TryGetValue(name, out var raw) || raw == null)
- return string.Empty;
- if (fmt == null)
- {
- return ConvertToString(raw, culture);
- }
- else
- {
- // 支持格式化:使用 string.Format 的单个参数风格
- try
- {
- return string.Format(culture ?? CultureInfo.CurrentCulture, “{0:” + fmt + “}”, raw);
- }
- catch
- {
- return ConvertToString(raw, culture);
- }
- }
- });
- }
- private static string ConvertToString(object o, CultureInfo culture)
- {
- if (o == null) return string.Empty;
- if (o is IFormattable f) return f.ToString(null, culture ?? CultureInfo.CurrentCulture);
- return o.ToString();
- }
- }
- #endregion
- }
- }
我做了什么
- 把 MarkupExtension、ConverterParameter(Freezable,可绑定)和内部 Freezable 转换器整合到同一文件中,保持单一类使用体验。
- 支持任意命名参数:通过 FreezableCollection<ConverterParameter> 存放任意名称的参数,子元素参数支持 Binding。
- 支持快速静态 Params 字符串和 Template 占位符替换(Template 使用 {ParamName},内置 value 表示主绑定值)。
- ProvideValue 每次创建新的内部转换器实例并把参数注入,避免共享绑定导致的问题。
下一步可以为你做的事情(我将直接做出示例或扩展)
- 如果你希望,我可以把 Params 字符串解析增强为类型推断(自动把 “true”/”123″/”3.14” 转为 bool/int/double 等),或者
- 添加对在 Params 中直接写 Binding 表达式(例如 Params=”Lang={Binding Lang, ElementName=Root}”)的支持(需在 ProvideValue 中解析并用 BindingOperations 应用),或者
- 把该类改为支持把外部提供的自定义处理回调(例如在 XAML 中仅声明参数,将处理逻辑以委托形式注入 —— 此项较复杂,需代码端配合)。
你希望我先实现哪一项增强?
这种整合成一个文件的能做成通用的吗?
GenericMultiParamInlineConverterExtension.cs
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Text;
- using System.Text.RegularExpressions;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- /// <summary>
- /// 通用单文件实现:MarkupExtension + 内部 Freezable 转换器 + 任意命名参数支持(静态 Params 或子元素 ConverterParameter 可绑定)+
- /// 可插入自定义处理器(ProcessorType),处理器实现 IMultiParamProcessor。
- ///
- /// 设计目标:
- /// – 单文件里包含 XAML 可内联使用的 MarkupExtension、可绑定的参数类型(Freezable)、内部转换器实例;
- /// – 支持通过 Params 字符串快速指定静态参数,也支持以子元素 <ConverterParameter Name=”…” Value=”{Binding …}” /> 传入可绑定参数;
- /// – 支持可插拔的处理逻辑:通过 ProcessorType 指定一个实现 IMultiParamProcessor 的类型来处理参数字典与主值,默认提供 TemplateProcessor(基于占位符替换)。
- ///
- /// 用法示例:
- /// 1) 使用默认模板处理器(TemplateProcessor):
- /// Text=”{Binding Name, Converter={conv:GenericMultiParamInlineConverterExtension Template='[{Lang}] {value} – {Suffix}’ Params=\”Lang=’en’; Suffix=’)’\”}}”
- ///
- /// 2) 使用子元素绑定参数(绑定覆盖 Params):
- /// <Binding Path=”Name”>
- /// <Binding.Converter>
- /// <conv:GenericMultiParamInlineConverterExtension Template=”Hello {Title} {value}”>
- /// <conv:GenericMultiParamInlineConverterExtension.ConverterParameter Name=”Title” Value=”{Binding Title, ElementName=Root}” />
- /// </conv:GenericMultiParamInlineConverterExtension>
- /// </Binding.Converter>
- /// </Binding>
- ///
- /// 3) 使用自定义处理器(ProcessorType):
- /// <conv:GenericMultiParamInlineConverterExtension ProcessorType=”{x:Type local:MyProcessor}” />
- /// // MyProcessor 必须有无参构造函数并实现 IMultiParamProcessor
- /// </summary>
- [ContentProperty(nameof(Parameters))]
- public class GenericMultiParamInlineConverterExtension : MarkupExtension, IValueConverter
- {
- /// <summary>
- /// 可选模板(仅当使用默认 TemplateProcessor 时有意义)
- /// 占位符格式:{ParamName},保留名称 “value” 表示主绑定的值。
- /// </summary>
- public string Template { get; set; } = “{value}”;
- /// <summary>
- /// 静态参数简写字符串,例如: “Title=’Mr.’; Suffix=’]'”
- /// 值被作为字符串传入;子元素绑定(ConverterParameter)会覆盖同名项。
- /// </summary>
- public string Params { get; set; }
- /// <summary>
- /// 如果需要自定义处理逻辑,请指定一个类型,该类型必须实现 IMultiParamProcessor 并有无参构造函数。
- /// 如果不指定则使用默认的 TemplateProcessor。
- /// </summary>
- public Type ProcessorType { get; set; }
- /// <summary>
- /// 子元素参数(支持 Binding,因为 ConverterParameter 是 Freezable)
- /// </summary>
- public FreezableCollection<ConverterParameter> Parameters { get; } = new FreezableCollection<ConverterParameter>();
- public GenericMultiParamInlineConverterExtension() { }
- public GenericMultiParamInlineConverterExtension(string template)
- {
- Template = template;
- }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- // 创建内部转换器实例(每次 ProvideValue 都创建新的实例以避免共享绑定冲突)
- var converter = new InnerConverter();
- // 创建或实例化处理器
- IMultiParamProcessor processor;
- if (ProcessorType == null)
- {
- processor = new TemplateProcessor(); // 默认处理器
- }
- else
- {
- if (!typeof(IMultiParamProcessor).IsAssignableFrom(ProcessorType))
- throw new InvalidOperationException(“ProcessorType must implement IMultiParamProcessor.”);
- // 需有无参构造函数
- processor = (IMultiParamProcessor)Activator.CreateInstance(ProcessorType)
- ?? throw new InvalidOperationException(“Cannot create instance of ProcessorType.”);
- }
- converter.Processor = processor;
- // 1) 解析静态 Params 字符串并加入参数集合
- var parsed = ParseParamsString(Params);
- foreach (var kv in parsed)
- {
- converter.Parameters.Add(new ConverterParameter { Name = kv.Key, Value = kv.Value });
- }
- // 2) 克隆并添加子元素中的 ConverterParameter(绑定形式),子元素覆盖静态 Params
- foreach (var p in Parameters)
- {
- if (p == null) continue;
- var cloned = (ConverterParameter)p.Clone();
- var existing = FindParameterByName(converter.Parameters, cloned.Name);
- if (existing != null) converter.Parameters.Remove(existing);
- converter.Parameters.Add(cloned);
- }
- // 3) 设置模板(默认模板仅供 TemplateProcessor 使用;其它处理器可以忽略或使用)
- converter.Template = Template ?? “{value}”;
- return converter;
- }
- // 兼容:当 MarkupExtension 本身被当成 IValueConverter 使用时,委托给 ProvideValue 创建的实例
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.Convert(value, targetType, parameter, culture);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.ConvertBack(value, targetType, parameter, culture);
- }
- private ConverterParameter FindParameterByName(FreezableCollection<ConverterParameter> list, string name)
- {
- if (list == null || string.IsNullOrEmpty(name)) return null;
- foreach (var p in list)
- if (string.Equals(p?.Name, name, StringComparison.Ordinal))
- return p;
- return null;
- }
- /// <summary>
- /// 解析简单的 Params 字符串为字典(值为 string),支持单/双引号与转义。
- /// 保持简单明了:复杂的 Binding 表达式应通过子元素 ConverterParameter 传入以保证可绑定性。
- /// </summary>
- private static Dictionary<string, object> ParseParamsString(string s)
- {
- var result = new Dictionary<string, object>(StringComparer.Ordinal);
- if (string.IsNullOrWhiteSpace(s)) return result;
- int i = 0, n = s.Length;
- while (i < n)
- {
- while (i < n && (char.IsWhiteSpace(s[i]) || s[i] == ‘;’ || s[i] == ‘,’)) i++;
- if (i >= n) break;
- int keyStart = i;
- while (i < n && s[i] != ‘=’ && s[i] != ‘;’ && s[i] != ‘,’) i++;
- if (i >= n || s[i] != ‘=’)
- {
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- continue;
- }
- string key = s.Substring(keyStart, i – keyStart).Trim();
- i++; // skip ‘=’
- while (i < n && char.IsWhiteSpace(s[i])) i++;
- if (i >= n)
- {
- result[key] = string.Empty;
- break;
- }
- string value;
- if (s[i] == ‘\” || s[i] == ‘”‘)
- {
- char quote = s[i++];
- var sb = new StringBuilder();
- while (i < n)
- {
- if (s[i] == ‘\\’ && i + 1 < n)
- {
- i++;
- sb.Append(s[i]);
- i++;
- continue;
- }
- if (s[i] == quote)
- {
- i++;
- break;
- }
- sb.Append(s[i]);
- i++;
- }
- value = sb.ToString();
- }
- else
- {
- int valStart = i;
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- value = s.Substring(valStart, i – valStart).Trim();
- }
- if (!string.IsNullOrEmpty(key))
- result[key] = value;
- }
- return result;
- }
- #region Nested types: ConverterParameter, IMultiParamProcessor, default TemplateProcessor, InnerConverter
- /// <summary>
- /// 子元素参数(Freezable,支持 Binding)
- /// </summary>
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(nameof(Name), typeof(string), typeof(ConverterParameter), new PropertyMetadata(string.Empty));
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(nameof(Value), typeof(object), typeof(ConverterParameter), new PropertyMetadata(null));
- protected override Freezable CreateInstanceCore() => new ConverterParameter();
- }
- /// <summary>
- /// 处理器接口:把主值与参数字典交给处理器,返回要输出的对象。
- /// 自定义处理器需实现该接口并有无参构造。
- /// </summary>
- public interface IMultiParamProcessor
- {
- object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture);
- }
- /// <summary>
- /// 默认处理器:基于 Template 的占位符替换({Name},支持格式 {value:format})
- /// </summary>
- public class TemplateProcessor : IMultiParamProcessor
- {
- private static readonly Regex PlaceholderRegex = new Regex(@“\{(?<name>[^}:]+)(:(?<fmt>[^}]+))?\}”, RegexOptions.Compiled);
- public object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture)
- {
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (parameters != null)
- {
- foreach (var kv in parameters)
- dict[kv.Key] = kv.Value;
- }
- dict[“value”] = value;
- if (string.IsNullOrEmpty(template)) return string.Empty;
- string replaced = PlaceholderRegex.Replace(template, m =>
- {
- var name = m.Groups[“name”].Value;
- var fmt = m.Groups[“fmt”].Success ? m.Groups[“fmt”].Value : null;
- if (!dict.TryGetValue(name, out var raw) || raw == null)
- return string.Empty;
- if (fmt == null)
- {
- return ConvertToString(raw, culture);
- }
- else
- {
- try
- {
- return string.Format(culture ?? CultureInfo.CurrentCulture, “{0:” + fmt + “}”, raw);
- }
- catch
- {
- return ConvertToString(raw, culture);
- }
- }
- });
- return replaced;
- }
- private static string ConvertToString(object o, CultureInfo culture)
- {
- if (o == null) return string.Empty;
- if (o is IFormattable f) return f.ToString(null, culture ?? CultureInfo.CurrentCulture);
- return o.ToString();
- }
- }
- /// <summary>
- /// 内部 Freezable 转换器:把参数集合聚合成字典并调用 Processor 处理
- /// </summary>
- private class InnerConverter : Freezable, IValueConverter
- {
- public string Template { get; set; } = “{value}”;
- public IMultiParamProcessor Processor { get; set; }
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(nameof(Parameters), typeof(FreezableCollection<ConverterParameter>), typeof(InnerConverter), new PropertyMetadata(null));
- public InnerConverter()
- {
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- protected override Freezable CreateInstanceCore() => new InnerConverter();
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (Parameters != null)
- {
- foreach (var p in Parameters)
- {
- if (p == null || string.IsNullOrEmpty(p.Name)) continue;
- dict[p.Name] = p.Value;
- }
- }
- // 调用处理器
- object processed = Processor?.Process(value, dict, Template, culture) ?? string.Empty;
- // 如果目标期望 string/object,直接返回
- if (targetType == null || targetType == typeof(string) || targetType == typeof(object))
- return processed;
- // 尝试转换到目标类型
- try
- {
- return System.Convert.ChangeType(processed, targetType, culture ?? CultureInfo.CurrentCulture);
- }
- catch
- {
- return processed;
- }
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- }
- #endregion
- }
- }
我把之前拆散的功能合并并进一步通用化:现在这个单文件类既包含 MarkupExtension、可绑定的 ConverterParameter(Freezable)及内部 Freezable 转换器,又引入了 IMultiParamProcessor 插件点,允许你通过指定 ProcessorType(一个实现 IMultiParamProcessor 的类型)来改变转换逻辑。默认提供 TemplateProcessor(基于占位符替换),同时保持 Params 字符串与子元素绑定参数的混合使用与覆盖规则。
接下来我可以:
- 帮你把 Params 的字符串值做简单类型推断(int/float/bool/DateTime),或
- 实现在 Params 字符串中解析并应用简单的 {Binding …} 表达式(把解析结果通过 BindingOperations 绑定到内部 ConverterParameter.Value),或
- 给出一个自定义处理器示例(例如 JSON 模板处理器或基于条件选择的处理器)并演示如何在 XAML 中引用它(ProcessorType=”{x:Type local:YourProcessor}”)。
我已准备好为你实现其中一项增强,你想先要哪一个?
把 Params 的字符串值做简单类型推断
GenericMultiParamInlineConverterExtension.cs(v2)
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Text;
- using System.Text.RegularExpressions;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- /// <summary>
- /// 通用单文件实现:MarkupExtension + 内部 Freezable 转换器 + 任意命名参数支持(静态 Params 或子元素 ConverterParameter 可绑定)+
- /// 可插入自定义处理器(ProcessorType),处理器实现 IMultiParamProcessor。
- ///
- /// 这份实现增加了对 Params 中静态值的简单类型推断:
- /// – “null” (忽略大小写) -> null
- /// – “true”/”false” -> bool
- /// – 整数 -> int 或 long
- /// – 小数 -> decimal 或 double(优先 decimal)
- /// – ISO / 常见格式的日期 -> DateTime
- /// – Guid 格式 -> Guid
- /// – 其它保留为 string
- ///
- /// 使用示例:
- /// Params=”Count=123; Enabled=true; Rate=3.14; When=’2025-10-16′; Id=’d3f9c6b7-…’; Title=’Mr.'”
- /// </summary>
- [ContentProperty(nameof(Parameters))]
- public class GenericMultiParamInlineConverterExtension : MarkupExtension, IValueConverter
- {
- public string Template { get; set; } = “{value}”;
- public string Params { get; set; }
- public Type ProcessorType { get; set; }
- public FreezableCollection<ConverterParameter> Parameters { get; } = new FreezableCollection<ConverterParameter>();
- public GenericMultiParamInlineConverterExtension() { }
- public GenericMultiParamInlineConverterExtension(string template) { Template = template; }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- var converter = new InnerConverter();
- IMultiParamProcessor processor;
- if (ProcessorType == null)
- {
- processor = new TemplateProcessor();
- }
- else
- {
- if (!typeof(IMultiParamProcessor).IsAssignableFrom(ProcessorType))
- throw new InvalidOperationException(“ProcessorType must implement IMultiParamProcessor.”);
- processor = (IMultiParamProcessor)Activator.CreateInstance(ProcessorType)
- ?? throw new InvalidOperationException(“Cannot create instance of ProcessorType.”);
- }
- converter.Processor = processor;
- // 1) 解析静态 Params 字符串并加入参数集合(做类型推断)
- var parsed = ParseParamsString(Params);
- foreach (var kv in parsed)
- {
- converter.Parameters.Add(new ConverterParameter { Name = kv.Key, Value = kv.Value });
- }
- // 2) 克隆并添加子元素中的 ConverterParameter(绑定形式),子元素覆盖静态 Params
- foreach (var p in Parameters)
- {
- if (p == null) continue;
- var cloned = (ConverterParameter)p.Clone();
- var existing = FindParameterByName(converter.Parameters, cloned.Name);
- if (existing != null) converter.Parameters.Remove(existing);
- converter.Parameters.Add(cloned);
- }
- converter.Template = Template ?? “{value}”;
- return converter;
- }
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.Convert(value, targetType, parameter, culture);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.ConvertBack(value, targetType, parameter, culture);
- }
- private ConverterParameter FindParameterByName(FreezableCollection<ConverterParameter> list, string name)
- {
- if (list == null || string.IsNullOrEmpty(name)) return null;
- foreach (var p in list)
- if (string.Equals(p?.Name, name, StringComparison.Ordinal))
- return p;
- return null;
- }
- /// <summary>
- /// 解析 Params 字符串为字典并对值做简单类型推断。
- /// 支持:引号、转义、分号/逗号分隔。
- /// 返回的 value 已经是推断后的类型(bool/int/long/decimal/double/DateTime/Guid/string/null)。
- /// </summary>
- private static Dictionary<string, object> ParseParamsString(string s)
- {
- var result = new Dictionary<string, object>(StringComparer.Ordinal);
- if (string.IsNullOrWhiteSpace(s)) return result;
- int i = 0, n = s.Length;
- while (i < n)
- {
- while (i < n && (char.IsWhiteSpace(s[i]) || s[i] == ‘;’ || s[i] == ‘,’)) i++;
- if (i >= n) break;
- int keyStart = i;
- while (i < n && s[i] != ‘=’ && s[i] != ‘;’ && s[i] != ‘,’) i++;
- if (i >= n || s[i] != ‘=’)
- {
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- continue;
- }
- string key = s.Substring(keyStart, i – keyStart).Trim();
- i++; // skip ‘=’
- while (i < n && char.IsWhiteSpace(s[i])) i++;
- if (i >= n)
- {
- result[key] = string.Empty;
- break;
- }
- string rawValue;
- if (s[i] == ‘\” || s[i] == ‘”‘)
- {
- char quote = s[i++];
- var sb = new StringBuilder();
- while (i < n)
- {
- if (s[i] == ‘\\’ && i + 1 < n)
- {
- i++;
- sb.Append(s[i]);
- i++;
- continue;
- }
- if (s[i] == quote)
- {
- i++;
- break;
- }
- sb.Append(s[i]);
- i++;
- }
- rawValue = sb.ToString();
- }
- else
- {
- int valStart = i;
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- rawValue = s.Substring(valStart, i – valStart).Trim();
- }
- if (!string.IsNullOrEmpty(key))
- {
- object inferred = InferTypeFromString(rawValue);
- result[key] = inferred;
- }
- }
- return result;
- }
- /// <summary>
- /// 简单的类型推断(从 string 推断为 bool/int/long/decimal/double/DateTime/Guid/null/string)。
- /// 优先级说明:
- /// – “null” -> null
- /// – bool
- /// – 整数(int -> long)
- /// – decimal(用于小数,以保持精度)-> double(作为兜底)
- /// – DateTime(支持常见与 ISO 格式)
- /// – Guid
- /// – 否则返回原始字符串
- /// </summary>
- private static object InferTypeFromString(string raw)
- {
- if (raw == null) return null;
- var s = raw.Trim();
- if (string.Equals(s, “null”, StringComparison.OrdinalIgnoreCase))
- return null;
- // 布尔
- if (bool.TryParse(s, out var b))
- return b;
- // 整数(优先 int,再 long)
- if (int.TryParse(s, NumberStyles.Integer, CultureInfo.InvariantCulture, out var i32))
- return i32;
- if (long.TryParse(s, NumberStyles.Integer, CultureInfo.InvariantCulture, out var i64))
- return i64;
- // Decimal(优先于 double 保留精度)和 double(允许科学计数)
- if (decimal.TryParse(s, NumberStyles.Number, CultureInfo.InvariantCulture, out var dec))
- return dec;
- if (double.TryParse(s, NumberStyles.Float | NumberStyles.AllowThousands, CultureInfo.InvariantCulture, out var dbl))
- return dbl;
- // DateTime(先尝试 invariant/ISO 风格,再尝试当前 culture)
- if (DateTime.TryParse(s, CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind, out var dtInvariant))
- return dtInvariant;
- if (DateTime.TryParse(s, CultureInfo.CurrentCulture, DateTimeStyles.None, out var dtLocal))
- return dtLocal;
- // Guid
- if (Guid.TryParse(s, out var guid))
- return guid;
- // 默认保留为字符串
- return raw;
- }
- #region Nested types: ConverterParameter, IMultiParamProcessor, default TemplateProcessor, InnerConverter
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(nameof(Name), typeof(string), typeof(ConverterParameter), new PropertyMetadata(string.Empty));
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(nameof(Value), typeof(object), typeof(ConverterParameter), new PropertyMetadata(null));
- protected override Freezable CreateInstanceCore() => new ConverterParameter();
- }
- public interface IMultiParamProcessor
- {
- object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture);
- }
- public class TemplateProcessor : IMultiParamProcessor
- {
- private static readonly Regex PlaceholderRegex = new Regex(@“\{(?<name>[^}:]+)(:(?<fmt>[^}]+))?\}”, RegexOptions.Compiled);
- public object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture)
- {
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (parameters != null)
- {
- foreach (var kv in parameters)
- dict[kv.Key] = kv.Value;
- }
- dict[“value”] = value;
- if (string.IsNullOrEmpty(template)) return string.Empty;
- string replaced = PlaceholderRegex.Replace(template, m =>
- {
- var name = m.Groups[“name”].Value;
- var fmt = m.Groups[“fmt”].Success ? m.Groups[“fmt”].Value : null;
- if (!dict.TryGetValue(name, out var raw) || raw == null)
- return string.Empty;
- if (fmt == null)
- {
- return ConvertToString(raw, culture);
- }
- else
- {
- try
- {
- return string.Format(culture ?? CultureInfo.CurrentCulture, “{0:” + fmt + “}”, raw);
- }
- catch
- {
- return ConvertToString(raw, culture);
- }
- }
- });
- return replaced;
- }
- private static string ConvertToString(object o, CultureInfo culture)
- {
- if (o == null) return string.Empty;
- if (o is IFormattable f) return f.ToString(null, culture ?? CultureInfo.CurrentCulture);
- return o.ToString();
- }
- }
- private class InnerConverter : Freezable, IValueConverter
- {
- public string Template { get; set; } = “{value}”;
- public IMultiParamProcessor Processor { get; set; }
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(nameof(Parameters), typeof(FreezableCollection<ConverterParameter>), typeof(InnerConverter), new PropertyMetadata(null));
- public InnerConverter()
- {
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- protected override Freezable CreateInstanceCore() => new InnerConverter();
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (Parameters != null)
- {
- foreach (var p in Parameters)
- {
- if (p == null || string.IsNullOrEmpty(p.Name)) continue;
- dict[p.Name] = p.Value;
- }
- }
- object processed = Processor?.Process(value, dict, Template, culture) ?? string.Empty;
- if (targetType == null || targetType == typeof(string) || targetType == typeof(object))
- return processed;
- try
- {
- return System.Convert.ChangeType(processed, targetType, culture ?? CultureInfo.CurrentCulture);
- }
- catch
- {
- return processed;
- }
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- }
- #endregion
- }
- }
我做了什么(简短说明)
- 在原来的单文件通用转换器基础上,把 Params 字符串解析的结果从纯字符串升级为带有 “简单类型推断” 的值(bool/int/long/decimal/double/DateTime/Guid/null/string)。
- 修改点集中在 ParseParamsString 和新增的 InferTypeFromString 函数上:先按原本的引号 / 转义 / 分隔解析 key/value,然后对 value 做推断并以相应类型放入参数字典。
- 子元素的 ConverterParameter 仍然可以通过 Binding 传入并会覆盖 Params 中的同名静态参数 —— 并且 Binding 的值保留其真实类型(不会被字符串化)。
下一步(建议)
如果你希望,我可以:
- 把 Params 支持解析并应用简单的 “{Binding …}” 表达式(把它转换为真实的 Binding 并通过 BindingOperations 绑定到内部参数),
- 或者把类型推断扩展得更智能(例如解析 ISO 数字、时间跨度、枚举、JSON 数组 / 对象等),
- 或者把处理器示例(IMultiParamProcessor 的自定义实现)写成一个具体示例并展示 XAML 用法。 告诉我你想要哪一个,我就接着实现。
把类型推断扩展得更智能,并写一个具体处理器示例
我已经把通用单文件转换器的类型推断做得更智能,并额外提供了一个具体的处理器示例(SwitchProcessor),并把所有相关类型整合到一个可直接使用的 C# 文件中。同时我给出了一个简单的 ViewModel 和 XAML 示例,展示如何在 XAML 中使用 ProcessorType 指定自定义处理器并同时使用 Params(静态类型推断)与可绑定子元素参数(覆盖静态参数)。
下面是三个文件,你可以直接把它们拷贝到项目中(调整命名空间为你的项目命名空间)。
GenericMultiParamInlineConverterExtension.cs(v3)
- using System;
- using System.Collections.Generic;
- using System.Globalization;
- using System.Text;
- using System.Text.Json;
- using System.Text.RegularExpressions;
- using System.Windows;
- using System.Windows.Data;
- using System.Windows.Markup;
- namespace YourNamespace.Converters
- {
- /// <summary>
- /// 通用单文件实现:MarkupExtension + 内部 Freezable 转换器 + 任意命名参数支持(静态 Params 或子元素 ConverterParameter 可绑定)+
- /// 可插入自定义处理器(ProcessorType),处理器实现 IMultiParamProcessor。
- ///
- /// 增强点:
- /// – 更智能的 Params 类型推断(支持 null/boolean/hex/percent/int/long/decimal/double/DateTime/TimeSpan/Guid/JSON array or object)
- /// – 提供默认 TemplateProcessor(占位符替换)和示例 SwitchProcessor(根据 key 选择参数值)
- /// – 子元素 ConverterParameter 是 Freezable,支持 Binding,并会覆盖 Params 中的同名静态参数
- /// </summary>
- [ContentProperty(nameof(Parameters))]
- public class GenericMultiParamInlineConverterExtension : MarkupExtension, IValueConverter
- {
- public string Template { get; set; } = “{value}”;
- public string Params { get; set; }
- public Type ProcessorType { get; set; }
- public FreezableCollection<ConverterParameter> Parameters { get; } = new FreezableCollection<ConverterParameter>();
- public GenericMultiParamInlineConverterExtension() { }
- public GenericMultiParamInlineConverterExtension(string template) { Template = template; }
- public override object ProvideValue(IServiceProvider serviceProvider)
- {
- var converter = new InnerConverter();
- IMultiParamProcessor processor;
- if (ProcessorType == null)
- {
- processor = new TemplateProcessor();
- }
- else
- {
- if (!typeof(IMultiParamProcessor).IsAssignableFrom(ProcessorType))
- throw new InvalidOperationException(“ProcessorType must implement IMultiParamProcessor.”);
- processor = (IMultiParamProcessor)Activator.CreateInstance(ProcessorType)
- ?? throw new InvalidOperationException(“Cannot create instance of ProcessorType.”);
- }
- converter.Processor = processor;
- // 1) 解析静态 Params 字符串并加入参数集合(做类型推断)
- var parsed = ParseParamsString(Params);
- foreach (var kv in parsed)
- {
- converter.Parameters.Add(new ConverterParameter { Name = kv.Key, Value = kv.Value });
- }
- // 2) 克隆并添加子元素中的 ConverterParameter(绑定形式),子元素覆盖静态 Params
- foreach (var p in Parameters)
- {
- if (p == null) continue;
- var cloned = (ConverterParameter)p.Clone();
- var existing = FindParameterByName(converter.Parameters, cloned.Name);
- if (existing != null) converter.Parameters.Remove(existing);
- converter.Parameters.Add(cloned);
- }
- converter.Template = Template ?? “{value}”;
- return converter;
- }
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.Convert(value, targetType, parameter, culture);
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var conv = (InnerConverter)ProvideValue(null);
- return conv.ConvertBack(value, targetType, parameter, culture);
- }
- private ConverterParameter FindParameterByName(FreezableCollection<ConverterParameter> list, string name)
- {
- if (list == null || string.IsNullOrEmpty(name)) return null;
- foreach (var p in list)
- if (string.Equals(p?.Name, name, StringComparison.Ordinal))
- return p;
- return null;
- }
- /// <summary>
- /// 解析 Params 字符串为字典并对值做更智能的类型推断。
- /// 返回 value 为推断后的类型(bool/int/long/decimal/double/DateTime/TimeSpan/Guid/JsonElement/null/string)。
- /// 支持:
- /// – 引号字符串(保留原始内容)
- /// – null
- /// – 布尔 true/false
- /// – 十六进制(0x…)
- /// – 百分比(例如 50% -> 0.5)
- /// – 数字(优先 decimal,然后 double)
- /// – DateTime (尝试 invariant/ISO 与当前 culture)
- /// – TimeSpan
- /// – Guid
- /// – JSON 对象或数组(返回 JsonElement)
- /// </summary>
- private static Dictionary<string, object> ParseParamsString(string s)
- {
- var result = new Dictionary<string, object>(StringComparer.Ordinal);
- if (string.IsNullOrWhiteSpace(s)) return result;
- int i = 0, n = s.Length;
- while (i < n)
- {
- while (i < n && (char.IsWhiteSpace(s[i]) || s[i] == ‘;’ || s[i] == ‘,’)) i++;
- if (i >= n) break;
- int keyStart = i;
- while (i < n && s[i] != ‘=’ && s[i] != ‘;’ && s[i] != ‘,’) i++;
- if (i >= n || s[i] != ‘=’)
- {
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- continue;
- }
- string key = s.Substring(keyStart, i – keyStart).Trim();
- i++; // skip ‘=’
- while (i < n && char.IsWhiteSpace(s[i])) i++;
- if (i >= n)
- {
- result[key] = string.Empty;
- break;
- }
- string rawValue;
- if (s[i] == ‘\” || s[i] == ‘”‘)
- {
- char quote = s[i++];
- var sb = new StringBuilder();
- while (i < n)
- {
- if (s[i] == ‘\\’ && i + 1 < n)
- {
- i++;
- sb.Append(s[i]);
- i++;
- continue;
- }
- if (s[i] == quote)
- {
- i++;
- break;
- }
- sb.Append(s[i]);
- i++;
- }
- rawValue = sb.ToString();
- }
- else
- {
- int valStart = i;
- while (i < n && s[i] != ‘;’ && s[i] != ‘,’) i++;
- rawValue = s.Substring(valStart, i – valStart).Trim();
- }
- if (!string.IsNullOrEmpty(key))
- {
- object inferred = InferTypeFromString(rawValue);
- result[key] = inferred;
- }
- }
- return result;
- }
- /// <summary>
- /// 更智能的类型推断。
- /// </summary>
- private static object InferTypeFromString(string raw)
- {
- if (raw == null) return null;
- var s = raw.Trim();
- if (s.Length == 0) return string.Empty;
- if (string.Equals(s, “null”, StringComparison.OrdinalIgnoreCase))
- return null;
- // 布尔
- if (bool.TryParse(s, out var b))
- return b;
- // 百分比,例如 “50%” -> 0.5 (decimal)
- if (s.EndsWith(“%”, StringComparison.Ordinal))
- {
- var numPart = s.Substring(0, s.Length – 1).Trim();
- if (decimal.TryParse(numPart, NumberStyles.Number, CultureInfo.InvariantCulture, out var pct))
- {
- try { return pct / 100m; } catch { return pct / 100.0; }
- }
- }
- // 十六进制 0x…
- if (s.StartsWith(“0x”, StringComparison.OrdinalIgnoreCase))
- {
- if (long.TryParse(s.Substring(2), NumberStyles.HexNumber, CultureInfo.InvariantCulture, out var hexVal))
- return hexVal;
- }
- // GUID
- if (Guid.TryParse(s, out var guid))
- return guid;
- // TimeSpan (hh:mm[:ss] or “1.02:03:04”)
- if (TimeSpan.TryParse(s, CultureInfo.InvariantCulture, out var ts))
- return ts;
- // DateTime: 尝试 ISO / invariant first,再尝试当前 culture
- if (DateTime.TryParse(s, CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind, out var dtInv))
- return dtInv;
- if (DateTime.TryParse(s, CultureInfo.CurrentCulture, DateTimeStyles.None, out var dtLocal))
- return dtLocal;
- // JSON object/array -> parse to JsonElement
- if ((s.StartsWith(“{“) && s.EndsWith(“}”)) || (s.StartsWith(“[“) && s.EndsWith(“]”)))
- {
- try
- {
- using var doc = JsonDocument.Parse(s);
- return doc.RootElement.Clone(); // return JsonElement
- }
- catch
- {
- // fallthrough to numeric/text parsing
- }
- }
- // 整数(优先 int,再 long)
- if (int.TryParse(s, NumberStyles.Integer, CultureInfo.InvariantCulture, out var i32))
- return i32;
- if (long.TryParse(s, NumberStyles.Integer, CultureInfo.InvariantCulture, out var i64))
- return i64;
- // decimal 优先于 double,保留精度
- if (decimal.TryParse(s, NumberStyles.Number, CultureInfo.InvariantCulture, out var dec))
- return dec;
- if (double.TryParse(s, NumberStyles.Float | NumberStyles.AllowThousands, CultureInfo.InvariantCulture, out var dbl))
- return dbl;
- // default: 保持为 string
- return raw;
- }
- #region Nested types: ConverterParameter, IMultiParamProcessor, TemplateProcessor, InnerConverter
- /// <summary>
- /// 子元素参数(Freezable,支持 Binding)
- /// </summary>
- public class ConverterParameter : Freezable
- {
- public string Name
- {
- get => (string)GetValue(NameProperty);
- set => SetValue(NameProperty, value);
- }
- public static readonly DependencyProperty NameProperty =
- DependencyProperty.Register(nameof(Name), typeof(string), typeof(ConverterParameter), new PropertyMetadata(string.Empty));
- public object Value
- {
- get => GetValue(ValueProperty);
- set => SetValue(ValueProperty, value);
- }
- public static readonly DependencyProperty ValueProperty =
- DependencyProperty.Register(nameof(Value), typeof(object), typeof(ConverterParameter), new PropertyMetadata(null));
- protected override Freezable CreateInstanceCore() => new ConverterParameter();
- }
- /// <summary>
- /// 处理器接口:把主值与参数字典交给处理器,返回要输出的对象。
- /// </summary>
- public interface IMultiParamProcessor
- {
- object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture);
- }
- /// <summary>
- /// 默认处理器:基于 Template 的占位符替换({Name},支持格式 {value:format})
- /// </summary>
- public class TemplateProcessor : IMultiParamProcessor
- {
- private static readonly Regex PlaceholderRegex = new Regex(@“\{(?<name>[^}:]+)(:(?<fmt>[^}]+))?\}”, RegexOptions.Compiled);
- public object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture)
- {
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (parameters != null)
- {
- foreach (var kv in parameters)
- dict[kv.Key] = kv.Value;
- }
- dict[“value”] = value;
- if (string.IsNullOrEmpty(template)) return string.Empty;
- string replaced = PlaceholderRegex.Replace(template, m =>
- {
- var name = m.Groups[“name”].Value;
- var fmt = m.Groups[“fmt”].Success ? m.Groups[“fmt”].Value : null;
- if (!dict.TryGetValue(name, out var raw) || raw == null)
- return string.Empty;
- if (fmt == null)
- {
- return ConvertToString(raw, culture);
- }
- else
- {
- try
- {
- return string.Format(culture ?? CultureInfo.CurrentCulture, “{0:” + fmt + “}”, raw);
- }
- catch
- {
- return ConvertToString(raw, culture);
- }
- }
- });
- return replaced;
- }
- private static string ConvertToString(object o, CultureInfo culture)
- {
- if (o == null) return string.Empty;
- if (o is JsonElement je)
- {
- // 如果是 JsonElement,返回其原始 JSON 文本
- return je.GetRawText();
- }
- if (o is IFormattable f) return f.ToString(null, culture ?? CultureInfo.CurrentCulture);
- return o.ToString();
- }
- }
- /// <summary>
- /// 内部 Freezable 转换器:把参数集合聚合成字典并调用 Processor 处理
- /// </summary>
- private class InnerConverter : Freezable, IValueConverter
- {
- public string Template { get; set; } = “{value}”;
- public IMultiParamProcessor Processor { get; set; }
- public FreezableCollection<ConverterParameter> Parameters
- {
- get => (FreezableCollection<ConverterParameter>)GetValue(ParametersProperty);
- set => SetValue(ParametersProperty, value);
- }
- public static readonly DependencyProperty ParametersProperty =
- DependencyProperty.Register(nameof(Parameters), typeof(FreezableCollection<ConverterParameter>), typeof(InnerConverter), new PropertyMetadata(null));
- public InnerConverter()
- {
- if (GetValue(ParametersProperty) == null)
- {
- SetValue(ParametersProperty, new FreezableCollection<ConverterParameter>());
- }
- }
- protected override Freezable CreateInstanceCore() => new InnerConverter();
- public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
- {
- var dict = new Dictionary<string, object>(StringComparer.Ordinal);
- if (Parameters != null)
- {
- foreach (var p in Parameters)
- {
- if (p == null || string.IsNullOrEmpty(p.Name)) continue;
- dict[p.Name] = p.Value;
- }
- }
- object processed = Processor?.Process(value, dict, Template, culture) ?? string.Empty;
- if (targetType == null || targetType == typeof(string) || targetType == typeof(object))
- return processed;
- try
- {
- return System.Convert.ChangeType(processed, targetType, culture ?? CultureInfo.CurrentCulture);
- }
- catch
- {
- return processed;
- }
- }
- public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
- {
- throw new NotSupportedException();
- }
- }
- #endregion
- }
- /// <summary>
- /// 示例自定义处理器:SwitchProcessor
- /// 用法示例:
- /// – 主绑定值作为 key(或可以通过 Params/ConverterParameter 传入 Key 参数覆盖)
- /// – 在 Params 中预置多个 Value_<key> 参数(可静态或通过子元素绑定)
- /// – Processor 会输出对应 Value_<key>,找不到时返回 Default 参数或空字符串
- ///
- /// 例如: Params=”Value_A=’Alpha’; Value_B=’Beta’; Default=’?'”
- /// 绑定值为 “A” -> 输出 “Alpha”
- /// </summary>
- public class SwitchProcessor : GenericMultiParamInlineConverterExtension.IMultiParamProcessor
- {
- public object Process(object value, IDictionary<string, object> parameters, string template, CultureInfo culture)
- {
- // 优先使用 parameters 中的 “Key”,否则使用主绑定值
- object keyObj = null;
- if (parameters != null && parameters.TryGetValue(“Key”, out var k)) keyObj = k;
- if (keyObj == null) keyObj = value;
- var keyStr = keyObj?.ToString() ?? string.Empty;
- var lookupName = “Value_” + keyStr;
- if (parameters != null && parameters.TryGetValue(lookupName, out var found) && found != null)
- {
- return found;
- }
- if (parameters != null && parameters.TryGetValue(“Default”, out var def) && def != null)
- {
- return def;
- }
- // fallback: if template contains {value}, return template with value replacement
- if (!string.IsNullOrEmpty(template) && template.Contains(“{value}”))
- {
- return template.Replace(“{value}”, keyStr);
- }
- return string.Empty;
- }
- }
- }
ExampleViewModel.cs
- using System.ComponentModel;
- using System.Runtime.CompilerServices;
- namespace YourNamespace
- {
- public class ExampleViewModel : INotifyPropertyChanged
- {
- private string _typeKey = “A”;
- private string _prefix = “[“;
- private string _suffix = “]”;
- public string TypeKey
- {
- get => _typeKey;
- set { _typeKey = value; OnPropertyChanged(); }
- }
- public string Prefix
- {
- get => _prefix;
- set { _prefix = value; OnPropertyChanged(); }
- }
- public string Suffix
- {
- get => _suffix;
- set { _suffix = value; OnPropertyChanged(); }
- }
- public event PropertyChangedEventHandler PropertyChanged;
- void OnPropertyChanged([CallerMemberName] string name = null) => PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(name));
- }
- }
ExampleWindow.xaml
- <Window x:Class=“YourNamespace.ExampleWindow”
- xmlns=“http://schemas.microsoft.com/winfx/2006/xaml/presentation”
- xmlns:x=“http://schemas.microsoft.com/winfx/2006/xaml”
- xmlns:conv=“clr-namespace:YourNamespace.Converters”
- xmlns:local=“clr-namespace:YourNamespace”
- x:Name=“Root”
- Title=“GenericMultiParamInlineConverterExtension 示例” Height=“240” Width=“520”>
- <Window.DataContext>
- <local:ExampleViewModel/>
- </Window.DataContext>
- <StackPanel Margin=“12”>
- <TextBlock Margin=“0,0,0,12” FontSize=“16”>
- <!– 使用默认 TemplateProcessor(模板替换),并使用 Params 中的静态值(已做智能类型推断) –>
- <TextBlock.Text>
- <Binding Path=“TypeKey”>
- <Binding.Converter>
- <conv:GenericMultiParamInlineConverterExtension Template=“Selected: {value} (Prefix={Prefix}, Count={Count})”
- Params=“Prefix=’static’; Count=42”/>
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <TextBlock Margin=“0,0,0,12” FontSize=“16”>
- <!– 使用自定义的 SwitchProcessor:主绑定值作为 key,用 Params 指定 Value_<key> 条目 –>
- <TextBlock.Text>
- <Binding Path=“TypeKey”>
- <Binding.Converter>
- <conv:GenericMultiParamInlineConverterExtension ProcessorType=“{x:Type conv:SwitchProcessor}”
- Params=“Value_A=’Alpha’; Value_B=’Beta’; Default=’Unknown'”/>
- </Binding.Converter>
- </Binding>
- </TextBlock.Text>
- </TextBlock>
- <StackPanel Orientation=“Horizontal” Margin=“0,6”>
- <TextBlock Text=“TypeKey:” VerticalAlignment=“Center” Margin=“0,0,6,0”/>
- <TextBox Width=“80” Text=“{Binding TypeKey, UpdateSourceTrigger=PropertyChanged}”/>
- <TextBlock Text=“(Try A, B, C …)” VerticalAlignment=“Center” Margin=“12,0,0,0”/>
- </StackPanel>
- <TextBlock Margin=“0,12,0,0” Foreground=“Gray”>
- 说明:Params 中的静态值会被智能推断类型(例如 Count=42 -> int; Enabled=true -> bool; Rate=3.14 -> decimal)。
- 子元素 ConverterParameter(未在此示例示出)仍然支持 Binding 并会覆盖 Params 中的同名静态参数。
- </TextBlock>
- </StackPanel>
- </Window>
我做了什么(一路叙述)
- 把之前的单文件通用转换器扩展了类型推断逻辑:现在 Params 字符串中的值,会尝试推断为 null、bool、百分比、十六进制数、Guid、TimeSpan、DateTime、JSON(返回 JsonElement)、整数、decimal/double 等常见类型;未识别则保持字符串。这样在转换器处理时你能得到更接近真实类型的参数(例如数字 / 布尔可直接用于计算或条件判断)。
- 提供了一个具体的自定义处理器示例 SwitchProcessor(实现 IMultiParamProcessor)。SwitchProcessor 根据主绑定值或名为 Key 的参数选择对应的 Value_<key> 参数并返回,找不到时返回 Default。这个例子简单且常用,能展示如何把自定义逻辑注入转换器。
- 把转换器、参数类型、接口与示例处理器放在同一个文件(GenericMultiParamInlineConverterExtension.cs),保持单文件可用性;同时给出一个简单的 ViewModel 与 XAML Demo 展示两种用法(默认模板处理器与 SwitchProcessor)。
接下来(如果你愿意)
- 我可以把 Params 支持直接在属性内写简化 Binding(例如识别 “Lang={Binding Lang, ElementName=Root}” 并把 Binding 应用到内部参数),或者
- 提供更多的处理器示例(例如基于 JSON 模板的处理器、条件表达式处理器或数字格式化 / 本地化处理器),或
- 把这套代码整理成一个小的可复用库(包含单元测试和文档注释)。
你更希望我接着做哪一项增强?
原创文章,转载请注明: 转载自 独立观察员(dlgcy.com)
本文链接地址: [【编辑】WPF 转换器中如何使用依赖属性?](https://dlgcy.com/wpf-how-to-use-dependency-property-in-converter/)
关注微信公众号 独立观察员博客(DLGCY_BLOG) 第一时间获取最新文章
发表评论