Como criar um evento roteado personalizado

Para que o evento personalizado dê suporte ao roteamento de eventos, você precisa registrar uma RoutedEvent usando o método RegisterRoutedEvent. Este exemplo demonstra os conceitos básicos da criação de um evento roteado personalizado.

Exemplo

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

Observe que, embora o evento seja gerado por meio do método virtual OnTap neste exemplo específico, como você aciona seu evento ou como seu evento responde às alterações depende de 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 os controles subclasse podem ser inseridos em árvores compostas por outros controles e que, nessa situação, os eventos personalizados nesses controles têm os mesmos recursos de roteamento de eventos que qualquer elemento nativo do WPF.

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 túnel são criados da mesma maneira, mas com RoutingStrategy definido como Tunnel na chamada de registro. Por convenção, os eventos de túnel no WPF são precedidos pela palavra "Preview".

Para ver um exemplo de como os eventos de bubbling funcionam, consulte Manipular um evento roteado.

Consulte também

• Visão Geral de Eventos Roteados
• Visão Geral da Entrada
• Visão geral da criação de controle