EventToCommandBehavior

O EventToCommandBehavior é um behavior que permite que o usuário invoque um Command por meio de um Event. O recurso foi projetado para associar Comandos a eventos expostos por controles que não foram projetados para dar suporte a Comandos e permite que você mapeie para um Comando qualquer evento arbitrário em um controle.

Sintaxe

Os exemplos a seguir mostram como adicionar um EventToCommandBehavior a um controle Button e, em seguida, manipular o evento clicado.

XAML

Incluir o namespace XAML

Para usar o kit de ferramentas no XAML, o xmlns a seguir precisa ser adicionado à sua página ou exibição:

xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"

Portanto, o seguinte:

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml">

</ContentPage>

Seria modificado para incluir o xmlns conforme o seguinte:

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
    xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit">

</ContentPage>

Usando EventToCommandBehavior

O EventToCommandBehavior pode ser usado da seguinte maneira em XAML:

<ContentPage 
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
    xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
    x:Class="MyLittleApp.MainPage"
    x:Name="Page">
    
    <Button x:Name="MyButton">
        <Button.Behaviors>
            <toolkit:EventToCommandBehavior
                EventName="Clicked"
                BindingContext="{Binding Path=BindingContext, Source={x:Reference MyButton}, x:DataType=Button}"
                Command="{Binding Source={x:Reference Page}, Path=BindingContext.MyCustomCommand, x:DataType=ContentPage}" />
        </Button.Behaviors>
    </Button>
</ContentPage>

C#

O EventToCommandBehavior pode ser usado da seguinte maneira em C#:

class EventToCommandBehaviorPage : ContentPage
{
    public EventToCommandBehaviorPage()
    {
        var button = new Button();

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

        button.Behaviors.Add(behavior);

        Content = entry;
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup fornece uma maneira muito mais concisa de usar esse Behavior em C#.

using CommunityToolkit.Maui.Markup;

class EventToCommandBehaviorPage : ContentPage
{
    public EventToCommandBehaviorPage()
    {
        Content = new Button()
        .Behaviors(new EventToCommandBehavior
        {
            EventName = nameof(Button.Clicked),
            Command = new MyCustomCommand()
        });                 
    }
}

Acessando o EventArgs do evento

É possível passar o EventArgs do evento específico para o Command. Há duas maneiras de fazer isso:

1. Use a implementação genérica

Ao usar a implementação EventToCommandBehavior<T>, o EventArgs será passado para a propriedade Command se ambas as propriedades CommandParameter e Converter não estiverem definidas. Para nos referirmos ao tipo genérico em XAML, precisamos fazer uso da diretiva x:TypeArguments.

O exemplo a seguir mostra como usar a implementação genérica para passar WebNavigatedEventArgs para o comando.

<WebView 
    Source="https://github.com"
    x:Name="MyWebView">
    <WebView.Behaviors>
        <toolkit:EventToCommandBehavior
            x:TypeArguments="WebNavigatedEventArgs"
            EventName="Navigated"
            BindingContext="{Binding Path=BindingContext, Source={x:Reference MyWebView}, x:DataType=WebView}"
            Command="{Binding WebViewNavigatedCommand}" />
    </WebView.Behaviors>
</WebView>

2. Use a propriedade Converter

Ao usar esse behavior com eventos de seleção ou toque expostos por ListView, é necessário um conversor adicional. Esse conversor converte os argumentos do evento em um parâmetro de comando que é então passado para o Command. Eles também estão disponíveis no .NET MAUI Community Toolkit:

• ItemTappedEventArgsConverter
• SelectedItemEventArgsConverter

Propriedades

Exemplos

Você pode encontrar um exemplo desse comportamento em ação no Aplicativo de exemplo do .NET MAUI Community Toolkit.

API

O código-fonte do EventToCommandBehavior pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.