Cómo: Crear un evento enrutado personalizado

  • Artículo

Para que su evento personalizado soporte el enrutamiento de eventos, necesita registrar un RoutedEvent usando el método RegisterRoutedEvent. Este ejemplo muestra los aspectos básicos de la creación de un evento enrutado personalizado.

Ejemplo

Como se muestra en el siguiente ejemplo, primero se registra un RoutedEvent utilizando el método RegisterRoutedEvent. Por convención, el nombre de campo estático RoutedEvent debe terminar con el sufijo Event. En este ejemplo, el nombre del evento es Tap y la estrategia de enrutamiento del evento es Bubble. Después de la llamada de registro, puede proporcionar los descriptores de acceso de eventos de Common Language Runtime (CLR) add y remove del evento.

Tenga en cuenta que, aunque el evento se genera a través del método virtual OnTap en este ejemplo concreto, cómo se genera el evento o cómo este responde a los cambios dependerá de sus necesidades.

Tenga en cuenta también que en este ejemplo se implementa básicamente una subclase completa de Button; esa subclase se compila como un ensamblado independiente y, después, se crea una instancia de esta como una clase personalizada en otra página de XAML. Este ejemplo pretende ilustrar el concepto de que los controles con subclases pueden insertarse en árboles formados por otros controles y que, en esta situación, los eventos personalizados de estos controles tienen las mismas funcionalidades de enrutamiento de eventos que cualquier elemento de 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>

Los eventos de tunelización se crean de la misma manera, pero con RoutingStrategy ajustado a Tunnel en la llamada de registro. Por convención, a los eventos de tunelización de WPF se les antepone la palabra "Preview".

Para ver un ejemplo de cómo funciona la propagación de eventos, consulte Controlar un evento enrutado.

Vea también