Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Updated Ultimate WPF Method Binding Extension
// Updated Ultimate WPF Event Method Binding implementation by Mike Marynowski
// View the article here: http://www.singulink.com/CodeIndex/post/updated-ultimate-wpf-event-method-binding
// Licensed under the Code Project Open License: http://www.codeproject.com/info/cpol10.aspx
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.Linq;
using System.Reflection;
using System.Windows;
using System.Windows.Data;
using System.Windows.Markup;
namespace Singulink.Windows.Data
{
public class MethodBindingExtension : MarkupExtension
{
private static readonly List<DependencyProperty> StorageProperties = new List<DependencyProperty>();
private readonly object[] _arguments;
private readonly List<DependencyProperty> _argumentProperties = new List<DependencyProperty>();
public MethodBindingExtension(object method) : this(new[] { method }) { }
public MethodBindingExtension(object arg0, object arg1) : this(new[] { arg0, arg1 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2) : this(new[] { arg0, arg1, arg2 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2, object arg3) : this(new[] { arg0, arg1, arg2, arg3 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2, object arg3, object arg4) : this(new[] { arg0, arg1, arg2, arg3, arg4 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2, object arg3, object arg4, object arg5) : this(new[] { arg0, arg1, arg2, arg3, arg4, arg5 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2, object arg3, object arg4, object arg5, object arg6) : this(new[] { arg0, arg1, arg2, arg3, arg4, arg5, arg6 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2, object arg3, object arg4, object arg5, object arg6, object arg7) : this(new[] { arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7 }) { }
public MethodBindingExtension(object arg0, object arg1, object arg2, object arg3, object arg4, object arg5, object arg6, object arg7, object arg8) : this(new[] { arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8 }) { }
private MethodBindingExtension(object[] arguments)
{
_arguments = arguments;
}
public override object ProvideValue(IServiceProvider serviceProvider)
{
var provideValueTarget = (IProvideValueTarget)serviceProvider.GetService(typeof(IProvideValueTarget));
var target = provideValueTarget.TargetObject as FrameworkElement;
Type eventHandlerType = null;
if (provideValueTarget.TargetProperty is EventInfo eventInfo)
{
eventHandlerType = eventInfo.EventHandlerType;
}
else if (provideValueTarget.TargetProperty is MethodInfo methodInfo)
{
var parameters = methodInfo.GetParameters();
if (parameters.Length == 2)
eventHandlerType = parameters[1].ParameterType;
}
if (target == null || eventHandlerType == null)
return this;
foreach (object argument in _arguments)
{
var argumentProperty = SetUnusedStorageProperty(target, argument);
_argumentProperties.Add(argumentProperty);
}
return CreateEventHandler(target, eventHandlerType);
}
private Delegate CreateEventHandler(FrameworkElement element, Type eventHandlerType)
{
EventHandler handler = (sender, eventArgs) =>
{
object arg0 = element.GetValue(_argumentProperties[0]);
if (arg0 == null)
{
Trace.TraceWarning("[MethodBinding] First method binding argument is required and cannot resolve to null - method name or method target expected.");
return;
}
int methodArgsStart;
object methodTarget;
// If the first argument is a string then it must be the name of the method to invoke on the data context.
// If not then it is the excplicit method target object and the second argument will be name of the method to invoke.
if (arg0 is string methodName)
{
methodTarget = element.DataContext;
methodArgsStart = 1;
}
else if (_argumentProperties.Count >= 2)
{
methodTarget = arg0;
methodArgsStart = 2;
object arg1 = element.GetValue(_argumentProperties[1]);
if (arg1 == null)
{
Trace.TraceWarning($"[MethodBinding] First argument resolved as a method target object of type '{methodTarget.GetType()}', second argument must resolve to a method name and cannot resolve to null.");
return;
}
methodName = arg1 as string;
if (methodName == null)
{
Trace.TraceWarning($"[MethodBinding] First argument resolved as a method target object of type '{methodTarget.GetType()}', second argument (method name) must resolve to a '{typeof(string)}' (actual type: '{arg1.GetType()}').");
return;
}
}
else
{
Trace.TraceWarning($"[MethodBinding] Method name must resolve to a '{typeof(string)}' (actual type: '{arg0.GetType()}').");
return;
}
var arguments = new object[_argumentProperties.Count - methodArgsStart];
for (int i = methodArgsStart; i < _argumentProperties.Count; i++)
{
object argValue = element.GetValue(_argumentProperties[i]);
if (argValue is EventSenderExtension)
argValue = sender;
else if (argValue is EventArgsExtension eventArgsEx)
argValue = eventArgsEx.GetArgumentValue(eventArgs, element.Language);
arguments[i - methodArgsStart] = argValue;
}
var methodTargetType = methodTarget.GetType();
// Try invoking the method by resolving it based on the arguments provided
try
{
methodTargetType.InvokeMember(methodName, BindingFlags.InvokeMethod, null, methodTarget, arguments);
return;
}
catch (MissingMethodException) { }
// Couldn't match a method with the raw arguments, so check if we can find a method with the same name
// and parameter count and try to convert any XAML string arguments to match the method parameter types
var method = methodTargetType.GetMethods().SingleOrDefault(m => m.Name == methodName && m.GetParameters().Length == arguments.Length);
if (method != null) {
var parameters = method.GetParameters();
for (int i = 0; i < _arguments.Length; i++)
{
if (arguments[i] == null)
{
if (parameters[i].ParameterType.IsValueType)
{
method = null;
break;
}
}
else if (_arguments[i] is string && parameters[i].ParameterType != typeof(string))
{
// The original value provided for this argument was a XAML string so try to convert it
arguments[i] = TypeDescriptor.GetConverter(parameters[i].ParameterType).ConvertFromString((string)_arguments[i]);
}
else if (!parameters[i].ParameterType.IsInstanceOfType(arguments[i]))
{
method = null;
break;
}
}
method?.Invoke(methodTarget, arguments);
}
if (method == null)
Trace.TraceWarning($"[MethodBinding] Could not find a method '{methodName}' on target type '{methodTargetType}' that accepts the parameters provided.");
};
return Delegate.CreateDelegate(eventHandlerType, handler.Target, handler.Method);
}
private DependencyProperty SetUnusedStorageProperty(DependencyObject obj, object value)
{
var property = StorageProperties.FirstOrDefault(p => obj.ReadLocalValue(p) == DependencyProperty.UnsetValue);
if (property == null)
{
property = DependencyProperty.RegisterAttached("Storage" + StorageProperties.Count, typeof(object), typeof(MethodBindingExtension), new PropertyMetadata());
StorageProperties.Add(property);
}
var markupExtension = value as MarkupExtension;
if (markupExtension != null)
{
var resolvedValue = markupExtension.ProvideValue(new ServiceProvider(obj, property));
obj.SetValue(property, resolvedValue);
}
else
{
obj.SetValue(property, value);
}
return property;
}
private class ServiceProvider : IServiceProvider, IProvideValueTarget
{
public object TargetObject { get; }
public object TargetProperty { get; }
public ServiceProvider(object targetObject, object targetProperty)
{
TargetObject = targetObject;
TargetProperty = targetProperty;
}
public object GetService(Type serviceType)
{
return serviceType.IsInstanceOfType(this) ? this : null;
}
}
}
public class EventSenderExtension : MarkupExtension
{
public override object ProvideValue(IServiceProvider serviceProvider)
{
return this;
}
}
public class EventArgsExtension : MarkupExtension
{
public PropertyPath Path { get; set; }
public IValueConverter Converter { get; set; }
public object ConverterParameter { get; set; }
public Type ConverterTargetType { get; set; }
[TypeConverter(typeof(CultureInfoIetfLanguageTagConverter))]
public CultureInfo ConverterCulture { get; set; }
public EventArgsExtension()
{
}
public EventArgsExtension(string path)
{
Path = new PropertyPath(path);
}
public override object ProvideValue(IServiceProvider serviceProvider)
{
return this;
}
internal object GetArgumentValue(EventArgs eventArgs, XmlLanguage language)
{
if (Path == null)
return eventArgs;
object value = PropertyPathHelpers.Evaluate(Path, eventArgs);
if (Converter != null)
value = Converter.Convert(value, ConverterTargetType ?? typeof(object), ConverterParameter, ConverterCulture ?? language.GetSpecificCulture());
return value;
}
}
public static class PropertyPathHelpers
{
public static object Evaluate(PropertyPath path, object source)
{
var target = new DependencyTarget();
var binding = new Binding() { Path = path, Source = source, Mode = BindingMode.OneTime };
BindingOperations.SetBinding(target, DependencyTarget.ValueProperty, binding);
return target.Value;
}
private class DependencyTarget : DependencyObject
{
public static readonly DependencyProperty ValueProperty = DependencyProperty.Register("Value", typeof(object), typeof(DependencyTarget));
public object Value
{
get => GetValue(ValueProperty);
set => SetValue(ValueProperty, value);
}
}
}
}
@mikernet
Copy link
Author

mikernet commented Dec 22, 2020

@songminkyu - the link to the article explaining how this works is in the comments at the top of the file above: http://www.singulink.com/CodeIndex/post/updated-ultimate-wpf-event-method-binding

@mikernet
Copy link
Author

mikernet commented Dec 22, 2020

@songminkyu Even though you can, you generally don't want to method bind with the sender element and the event args - the view models should not have any dependencies on the UI framework. If at all possible, then you should set up your method signature so that you can pass the data you actually want to the method. Sometimes that's not possible though (i.e. a view model method that handles mouse events which needs to get the mouse position), in which case you can use {data:EventArgs} as the method parameter and it will pass in the event args.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment