Como criar um evento roteado personalizado

  • Artigo

Para que seu evento personalizado ofereça suporte ao roteamento de eventos, você precisa registrar um RoutedEvent usando o RegisterRoutedEvent método. Este exemplo demonstra as noções básicas da criação de um evento roteado personalizado.

Exemplo

Conforme mostrado no exemplo a seguir, você primeiro registra um RoutedEvent usando o RegisterRoutedEvent método. Por convenção, o nome do campo estático deve terminar com o RoutedEvent sufixo Event. Neste exemplo, o nome do evento é e a estratégia de roteamento do evento é Tap Bubble. Após a chamada de registro, você pode adicionar e remover acessadores de eventos CLR (Common Language Runtime) para o evento.

Observe que, embora o evento seja gerado por meio do método virtual OnTap nesse exemplo específico, a maneira como você gera seu evento ou como ele responde às mudanças depende das suas necessidades.

Observe também que este exemplo basicamente implementa uma subclasse inteira de Button; essa subclasse é criada como um assembly separado e, em seguida, instanciada como uma classe personalizada em uma página XAML separada. Isso é para ilustrar o conceito de que controles subclassificados podem ser inseridos em árvores compostas de outros controles e que, nessa situação, os eventos personalizados nesses controles têm os mesmos recursos de roteamento de eventos que qualquer elemento WPF nativo.

public class MyButtonSimple: Button
{
    // Create a custom routed event by first registering a RoutedEventID
    // This event uses the bubbling routing strategy
    public static readonly RoutedEvent TapEvent = EventManager.RegisterRoutedEvent(
        "Tap", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(MyButtonSimple));

    // Provide CLR accessors for the event
    public event RoutedEventHandler Tap
    {
            add { AddHandler(TapEvent, value); }
            remove { RemoveHandler(TapEvent, value); }
    }

    // This method raises the Tap event
    void RaiseTapEvent()
    {
            RoutedEventArgs newEventArgs = new RoutedEventArgs(MyButtonSimple.TapEvent);
            RaiseEvent(newEventArgs);
    }
    // For demonstration purposes we raise the event when the MyButtonSimple is clicked
    protected override void OnClick()
    {
        RaiseTapEvent();
    }
}

Public Class MyButtonSimple
    Inherits Button

    ' Create a custom routed event by first registering a RoutedEventID
    ' This event uses the bubbling routing strategy
    Public Shared ReadOnly TapEvent As RoutedEvent = EventManager.RegisterRoutedEvent("Tap", RoutingStrategy.Bubble, GetType(RoutedEventHandler), GetType(MyButtonSimple))

    ' Provide CLR accessors for the event
    Public Custom Event Tap As RoutedEventHandler
        AddHandler(ByVal value As RoutedEventHandler)
            Me.AddHandler(TapEvent, value)
        End AddHandler

        RemoveHandler(ByVal value As RoutedEventHandler)
            Me.RemoveHandler(TapEvent, value)
        End RemoveHandler

        RaiseEvent(ByVal sender As Object, ByVal e As RoutedEventArgs)
            Me.RaiseEvent(e)
        End RaiseEvent
    End Event

    ' This method raises the Tap event
    Private Sub RaiseTapEvent()
        Dim newEventArgs As New RoutedEventArgs(MyButtonSimple.TapEvent)
        MyBase.RaiseEvent(newEventArgs)
    End Sub

    ' For demonstration purposes we raise the event when the MyButtonSimple is clicked
    Protected Overrides Sub OnClick()
        Me.RaiseTapEvent()
    End Sub

End Class

<Window  
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:custom="clr-namespace:SDKSample;assembly=SDKSampleLibrary"
    x:Class="SDKSample.RoutedEventCustomApp"

    >
    <Window.Resources>
      <Style TargetType="{x:Type custom:MyButtonSimple}">
        <Setter Property="Height" Value="20"/>
        <Setter Property="Width" Value="250"/>
        <Setter Property="HorizontalAlignment" Value="Left"/>
        <Setter Property="Background" Value="#808080"/>
      </Style>
    </Window.Resources>
    <StackPanel Background="LightGray">
        <custom:MyButtonSimple Name="mybtnsimple" Tap="TapHandler">Click to see Tap custom event work</custom:MyButtonSimple>
    </StackPanel>
</Window>

Os eventos de encapsulamento são criados da mesma maneira, mas com RoutingStrategy definido como Tunnel na chamada de registro. Por convenção, os eventos de tunelamento no WPF são prefixados com a palavra "Preview".

Para ver um exemplo de como eventos de propagação funcionam, consulte Manipular um evento roteado.

Confira também