[Proposal] Event-To-Command Behavior

EventToCommandBehavior

• Proposed
• Prototype
• Implementation
  • iOS Support
  • Android Support
  • macOS Support
  • Windows Support
• Unit Tests
• Documentation
• Sample

Summary

The EventToCommandBehavior is a Behavior that allows the user to invoke an ICommand through an Event. It is designed to associate ICommand to events exposed by controls that were not designed to support Commands. It allows you to map any arbitrary event on a control to an ICommand.

Detailed Design

public class EventToCommandBehavior : BaseBehavior<VisualElement>
{
    public static readonly BindableProperty EventNameProperty;
    public static readonly BindableProperty CommandProperty;
    public static readonly BindableProperty CommandParameterProperty;
    public static readonly BindableProperty EventArgsConverterProperty;

    public string? EventName { get; set; }
    public ICommand? Command { get; set; }
    public object? CommandParameter { get; set; }
    public IValueConverter EventArgsConverter { get; set; }
}

Usage Syntax

XAML Usage

<Button.Behaviors>
    <toolkit:EventToCommandBehavior
        EventName="Clicked"
        Command="{Binding MyCustomCommand}" />
</Button.Behaviors>

C# Usage

var button = new Button();
button.Behaviors.Add(new EventToCommandBehavior
{
    EventName = nameof(Button.Clicked),
    Command = new MyCustomCommand()
});

Drawbacks

Alternatives

Unresolved Questions

[CliffAgius]

Hey @IndianaGary don’t worry we all have busy times and projects to complete. I’m between projects at the moment so will pick this one up.

[bijington]

Done. Thanks @CliffAgius