Практическое руководство. Создание пользовательских перенаправленных событий

Чтобы обеспечить поддержку перенаправления событий в пользовательском событии, зарегистрируйте объект RoutedEvent с помощью метода RegisterRoutedEvent. В этом примере описываются основные принципы создания пользовательских перенаправленных событий.

Пример

Как показано в следующем примере, сначала выполняется регистрация объекта RoutedEvent с помощью метода RegisterRoutedEvent. В соответствии с соглашением, имя статического поля RoutedEvent должно заканчиваться суффиксом Event. В этом примере для события Tap используется стратегия перенаправления событий Bubble. После вызова регистрации для события можно предоставить методы доступа для добавления и удаления событий common language runtime (CLR).

Обратите внимание, что даже при вызове события с помощью виртуального метода OnTap вызов события и реакция события на изменения зависят от потребностей разработчика.

Обратите внимание, что в этом примере в основном реализуется весь подкласс Button. Этот подкласс создается в виде отдельной сборки, после чего на отдельной странице Extensible Application Markup Language (XAML) создается его экземпляр в качестве пользовательского класса. Это позволяет проиллюстрировать возможность вставки производных элементов управления в деревья, состоящие из других элементов управления. В этом случае пользовательские события в этих элементах управления включают в себя те же функции перенаправления событий, что и любой собственный элемент Windows Presentation Foundation (WPF).

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

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();
    }

}

<Window  
    xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="https://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>

Если создается событие с нисходящей маршрутизацией, при вызове регистрации для свойства RoutingStrategy устанавливается значение Tunnel. В соответствии с соглашением, в WPF к событиям с нисходящей маршрутизацией добавляется префикс "Preview".

Пример использования событий с восходящей маршрутизацией см. в разделе Практическое руководство. Обработка перенаправленных событий.

См. также

Основные понятия

Общие сведения о перенаправленных событиях

Общие сведения о входных данных

Общие сведения о разработке управления