添付イベントの概要Attached Events Overview

Extensible Application Markup Language (XAML) は言語コンポーネントと "添付イベント" と呼ばれている種類のイベントを定義します。Extensible Application Markup Language (XAML) defines a language component and type of event called an attached event. 添付イベントという概念を利用すると、イベントを実際に定義または継承する要素にではなく、任意の要素に特定のイベントのハンドラーを追加できます。The concept of an attached event enables you to add a handler for a particular event to an arbitrary element rather than to an element that actually defines or inherits the event. この場合、イベントを発生させる可能性があるオブジェクトとターゲット処理インスタンスのいずれもイベントを定義せず、"所有" しません。In this case, neither the object potentially raising the event nor the destination handling instance defines or otherwise "owns" the event.

必須コンポーネントPrerequisites

このトピックは、「ルーティング イベントの概要」と「XAML の概要 (WPF)」を既に読んでいることを前提としています。This topic assumes that you have read Routed Events Overview and XAML Overview (WPF).

添付イベントの構文Attached Event Syntax

添付イベントには XAML 構文とコーディング パターンが含まれています。コーディング パターンは、添付イベントの使用をサポートする目的でバッキング コードで使用する必要があります。Attached events have a XAML syntax and a coding pattern that must be used by the backing code in order to support the attached event usage.

XAML 構文では、添付イベントはそのイベント名だけでなく、その所有タイプとイベント名により指定されます。所有タイプとイベント名はドット (.) で区切られます。In XAML syntax, the attached event is specified not just by its event name, but by its owning type plus the event name, separated by a dot (.). イベント名はその所有タイプにより修飾されるため、添付イベントの構文では、インスタンス化できるあらゆる要素に添付イベントを添付できます。Because the event name is qualified with the name of its owning type, the attached event syntax allows any attached event to be attached to any element that can be instantiated.

たとえば、カスタム NeedsCleaning 添付イベントのハンドラーを添付する XAML 構文は次のようになります。For example, the following is the XAML syntax for attaching a handler for a custom NeedsCleaning attached event:

<aqua:Aquarium Name="theAquarium" Height="600" Width="800" aqua:AquariumFilter.NeedsCleaning="WashMe"/>

aqua: 接頭辞に注意してください。この場合は、マッピングされたカスタム xmlns から来ているカスタム イベントが添付イベントであるため、この接頭辞が必要になります。Note the aqua: prefix; the prefix is necessary in this case because the attached event is a custom event that comes from a custom mapped xmlns.

WPF で添付イベントを実装する方法How WPF Implements Attached Events

WPF では、添付イベントは RoutedEvent フィールドによりサポートされ、発生後、ツリー経由でルーティングされます。In WPF, attached events are backed by a RoutedEvent field and are routed through the tree after they are raised. 通常、添付イベントの発生源 (イベントを発生させたオブジェクト) はシステムまたはサービス ソースです。そのため、イベントを発生させるコードを実行するオブジェクトは要素ツリーの直接的一部ではありません。Typically, the source of the attached event (the object that raises the event) is a system or service source, and the object that runs the code that raises the event is therefore not a direct part of the element tree.

添付イベントのシナリオScenarios for Attached Events

WPF では、添付イベントは、サービス レベルの抽象化が存在する特定の機能領域に存在します。たとえば、静的な Mouse クラスまたは Validation クラスにより有効化されたイベントに対するサービス レベルの抽象化です。In WPF, attached events are present in certain feature areas where there is service-level abstraction, such as for the events enabled by the static Mouse class or the Validation class. サービスと連動する、またはサービスを利用するクラスは、添付イベント構文のイベントを利用するか、クラスによるサービスの機能統合に含まれるルーティング イベントとして添付イベントを添付できます。Classes that interact with or use the service can either use the event in the attached event syntax, or they can choose to surface the attached event as a routed event that is part of how the class integrates the capabilities of the service.

WPF は添付イベントの数を定義しますが、添付イベントを直接使用または処理するシナリオは非常に限られています。Although WPF defines a number of attached events, the scenarios where you will either use or handle the attached event directly are very limited. 一般的には、添付イベントはアーキテクチャ目的にサービスを提供しますが、その後、非添付の (CLR イベント "ラッパー" でサポートされる) ルーティング イベントに転送されます。Generally, the attached event serves an architecture purpose, but is then forwarded to a non-attached (backed with a CLR event "wrapper") routed event.

たとえば、基になる添付イベント Mouse.MouseDown を特定の UIElement でより簡単に処理するには、添付イベント構文を XAML またはコードで使用するのではなく、その UIElementMouseDown を使用します。For instance, the underlying attached event Mouse.MouseDown can more easily be handled on any given UIElement by using MouseDown on that UIElement rather than dealing with attached event syntax either in XAML or code. 添付イベントは、入力機器の将来の拡張を可能にするため、アーキテクチャにおける目的にサービスを提供します。The attached event serves a purpose in the architecture because it allows for future expansion of input devices. 想定される機器では、マウスの入力をシミュレートするために、Mouse.MouseDown を発生させることのみが必要となります。その目的で Mouse から派生させる必要はありません。The hypothetical device would only need to raise Mouse.MouseDown in order to simulate mouse input, and would not need to derive from Mouse to do so. ただし、このシナリオでは、イベントのコードが処理されます。添付イベントの XAML 処理はこのシナリオには関係しません。However, this scenario involves code handling of the events, and XAML handling of the attached event is not relevant to this scenario.

WPF で添付イベントを処理するHandling an Attached Event in WPF

添付イベントと記述するハンドラー コードを処理するプロセスは基本的にルーティング イベントの場合と同じです。The process for handling an attached event, and the handler code that you will write, is basically the same as for a routed event.

一般的には、WPF 添付イベントは WPF ルーティング イベントとそれほど異なっているわけではありません。In general, a WPF attached event is not very different from a WPF routed event. 違いは、イベントの発生源とメンバーとしてクラスにより公開される方法 (これは XAML ハンドラー構文にも影響を与えます) です。The differences are how the event is sourced and how it is exposed by a class as a member (which also affects the XAML handler syntax).

ただし、前述のように、既存の WPF 添付イベントは WPF での取り扱いを特に意図しているわけではありません。However, as noted earlier, the existing WPF attached events are not particularly intended for handling in WPF. 多くの場合、このイベントの目的は、合成中、合成された要素が親要素に状態を報告できるようにすることです。合成においては、イベントは通常、コードで発生します。また、関連する親クラスにおいて、クラスの処理に依存します。More often, the purpose of the event is to enable a composited element to report a state to a parent element in compositing, in which case the event is usually raised in code and also relies on class handling in the relevant parent class. たとえば、Selector 内の項目は添付 Selected イベントを発生させることが予想されます。このイベントは、Selector クラスにより処理されるクラスであり、可能性として Selector クラスにより別のルーティング イベント SelectionChanged に変換されます。For instance, items within a Selector are expected to raise the attached Selected event, which is then class handled by the Selector class and then potentially converted by the Selector class into a different routed event, SelectionChanged. ルーティング イベントとクラス処理については、「ルーティング イベントの処理済みとしてのマーキング、およびクラス処理」を参照してください。For more information on routed events and class handling, see Marking Routed Events as Handled, and Class Handling.

独自の添付イベントをルーティング イベントとして定義するDefining Your Own Attached Events as Routed Events

共通の WPF 基底クラスから派生させる場合、独自の添付イベントを実装できます。クラスに特定のパターン メソッドを追加し、基底クラスに既に存在するユーティリティ メソッドを使用します。If you are deriving from common WPF base classes, you can implement your own attached events by including certain pattern methods in your class and by using utility methods that are already present on the base classes.

パターンは次のとおりです。The pattern is as follows:

  • メソッド AddEventNameHandler と 2 つのパラメーター。A method AddEventNameHandler with two parameters. 最初のパラメーターは、イベント ハンドラーが追加されるインスタンスです。The first parameter is the instance to which the event handler is added. 2 番目のパラメーターは追加するイベント ハンドラーです。The second parameter is the event handler to add. メソッドには publicstatic を指定する必要があります。戻り値はありません。The method must be public and static, with no return value.

  • メソッド RemoveEventNameHandler と 2 つのパラメーター。A method RemoveEventNameHandler with two parameters. 最初のパラメーターは、イベント ハンドラーが削除されるインスタンスです。The first parameter is the instance from which the event handler is removed. 2 番目のパラメーターは削除するイベント ハンドラーです。The second parameter is the event handler to remove. メソッドには publicstatic を指定する必要があります。戻り値はありません。The method must be public and static, with no return value.

AddEventNameHandler アクセサー メソッドは、添付イベント ハンドラーの属性が要素で宣言されているとき、XAML 処理を容易にします。The AddEventNameHandler accessor method facilitates XAML processing when attached event handler attributes are declared on an element. AddEventNameHandler メソッドと RemoveEventNameHandler メソッドはまた、添付イベントのイベント ハンドラー ストアへのコード アクセスを可能にします。The AddEventNameHandler and RemoveEventNameHandler methods also enable code access to the event handler store for the attached event.

この一般的パターンには、フレームワークの実用的実装のための十分な精度がありません。サポートする言語とアーキテクチャで基礎イベントを識別する方法に関して、特定の XAML リーダー実装で異なるスキームが与えられる可能性があるためです。This general pattern is not yet precise enough for practical implementation in a framework, because any given XAML reader implementation might have different schemes for identifying underlying events in the supporting language and architecture. そのような理由から、WPF は添付イベントをルーティング イベントとして実装します。イベント (RoutedEvent) に使用する識別子が WPF イベント システムによって既に定義されています。This is one of the reasons that WPF implements attached events as routed events; the identifier to use for an event (RoutedEvent) is already defined by the WPF event system. また、イベントのルーティングは、添付イベントの XAML 言語レベル概念で自然な実装です。Also, routing an event is a natural implementation extension on the XAML language-level concept of an attached event.

WPF 添付イベントの AddEventNameHandler 実装は、ルーティング イベントとハンドラーを引数として AddHandler を呼び出すことで行われます。The AddEventNameHandler implementation for a WPF attached event consists of calling the AddHandler with the routed event and handler as arguments.

この実装方法と一般的なルーティング イベント システムでは、添付イベントの処理が UIElement 派生クラスまたは ContentElement 派生クラスに制限されます。これらのクラスだけに AddHandler 実装が与えられるためです。This implementation strategy and the routed event system in general restrict handling for attached events to either UIElement derived classes or ContentElement derived classes, because only those classes have AddHandler implementations.

たとえば、次のコードでは、添付イベントをルーティング イベントとして宣言する WPF 添付イベント方法を利用し、所有者クラス AquariumNeedsCleaning 添付イベントが定義されます。For example, the following code defines the NeedsCleaning attached event on the owner class Aquarium, using the WPF attached event strategy of declaring the attached event as a routed event.

public static readonly RoutedEvent NeedsCleaningEvent = EventManager.RegisterRoutedEvent("NeedsCleaning", RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(AquariumFilter));
public static void AddNeedsCleaningHandler(DependencyObject d, RoutedEventHandler handler)
{
    UIElement uie = d as UIElement;
    if (uie != null)
    {
        uie.AddHandler(AquariumFilter.NeedsCleaningEvent, handler);
    }
}
public static void RemoveNeedsCleaningHandler(DependencyObject d, RoutedEventHandler handler)
{
    UIElement uie = d as UIElement;
    if (uie != null)
    {
        uie.RemoveHandler(AquariumFilter.NeedsCleaningEvent, handler);
    }
}
Public Shared ReadOnly NeedsCleaningEvent As RoutedEvent = EventManager.RegisterRoutedEvent("NeedsCleaning", RoutingStrategy.Bubble, GetType(RoutedEventHandler), GetType(AquariumFilter))
Public Shared Sub AddNeedsCleaningHandler(ByVal d As DependencyObject, ByVal handler As RoutedEventHandler)
    Dim uie As UIElement = TryCast(d, UIElement)
    If uie IsNot Nothing Then
        uie.AddHandler(AquariumFilter.NeedsCleaningEvent, handler)
    End If
End Sub
Public Shared Sub RemoveNeedsCleaningHandler(ByVal d As DependencyObject, ByVal handler As RoutedEventHandler)
    Dim uie As UIElement = TryCast(d, UIElement)
    If uie IsNot Nothing Then
        uie.RemoveHandler(AquariumFilter.NeedsCleaningEvent, handler)
    End If
End Sub

添付イベント識別子フィールド RegisterRoutedEvent を設定するメソッドは、実際、非添付のルーティング イベントを登録するためのメソッドと同じです。Note that the method used to establish the attached event identifier field, RegisterRoutedEvent, is actually the same method that is used to register a non-attached routed event. 添付イベントとルーティング イベントはすべて、集中管理されている内部ストアに登録されます。Attached events and routed events all are registered to a centralized internal store. このイベント ストア実装により "インターフェイスとしてのイベント" という概念が可能になります。この概念に関する説明は「ルーティング イベントの概要」にあります。This event store implementation enables the "events as an interface" conceptual consideration that is discussed in Routed Events Overview.

WPF 添付イベントを発生させるRaising a WPF Attached Event

通常、WPF 定義の既存の添付イベントはコードから発生させる必要がありません。You do not typically need to raise existing WPF-defined attached events from your code. これらのイベントは一般的な "サービス" 概念モデルに従います。InputManager のようなサービス クラスがイベントの生成を担当します。These events follow the general "service" conceptual model, and service classes such as InputManager are responsible for raising the events.

ただし、添付イベントの基礎を RoutedEvent とする WPF モデルを基盤にカスタムの添付イベントを定義する場合、RaiseEvent を利用し、任意の UIElement または ContentElement から添付イベントを発生させることができます。However, if you are defining a custom attached event based on the WPF model of basing attached events on RoutedEvent, you can use RaiseEvent to raise an attached event from any UIElement or ContentElement. ルーティング イベント (添付または非添付) を発生させるには、イベント ソースとして要素ツリーで特定の要素を宣言する必要があります。そのソースは RaiseEvent 呼び出し元として報告されます。Raising a routed event (attached or not) requires that you declare a particular element in the element tree as the event source; that source is reported as the RaiseEvent caller. ツリーのソースとして報告される要素を決定することはサービスの担当です。Determining which element is reported as the source in the tree is your service's responsibility

関連項目See also