Vue d'ensemble des événements attachésAttached Events Overview

Extensible Application Markup Language (XAML) définit un composant de langage et le type d’événement appelé événement attaché.Extensible Application Markup Language (XAML) defines a language component and type of event called an attached event. Le concept d’un événement attaché vous permet d’ajouter un gestionnaire pour un événement particulier à un élément arbitraire plutôt qu’à un élément qui définit réellement l’événement ou qui en hérite.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. Dans ce cas, ni l’objet qui déclenche potentiellement l’événement, ni l’instance de gestion de destination ne définit ou ne « détient » l’événement.In this case, neither the object potentially raising the event nor the destination handling instance defines or otherwise "owns" the event.

PrérequisPrerequisites

Cette rubrique suppose que vous avez lu Vue d’ensemble des événements routés et Vue d’ensemble du langage XAML (WPF).This topic assumes that you have read Routed Events Overview and XAML Overview (WPF).

Syntaxe d’un événement attachéAttached Event Syntax

Les événements attachés ont une syntaxe XAML et un modèle de codage qui doivent être utilisés par le code de stockage afin de prendre en charge l’utilisation des événements attachés.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.

Dans la syntaxe XAML, l’événement attaché est spécifié non seulement par son nom d’événement, mais par son type propriétaire plus le nom de l’événement, séparé par un point (.).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 (.). Comme le nom de l’évènement est qualifié avec le nom de son type propriétaire, la syntaxe de l’événement attaché permet à celui-ci d’être attaché à tout élément pouvant être instancié.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.

Par exemple, voici la syntaxe XAML permettant d’attacher un gestionnaire pour un événement attaché personnalisé NeedsCleaning :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"/>

Notez le préfixe aqua:. Ce préfixe est nécessaire dans le cas présent, car l’événement attaché est un événement personnalisé qui provient d’un fichier xmlns mappé personnalisé.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.

Comment WPF implémente des événements attachésHow WPF Implements Attached Events

Dans WPF, les événements attachés sont sauvegardés RoutedEvent par un champ et sont routés via l’arborescence après leur déclenchement.In WPF, attached events are backed by a RoutedEvent field and are routed through the tree after they are raised. En général, la source de l’événement attaché (l’objet qui déclenche l’événement) est une source système ou de service. L’objet qui exécute le code qui déclenche l’événement ne fait donc pas directement partie de l’arborescence d’éléments.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.

Scénarios pour les événements attachésScenarios for Attached Events

Dans WPF, les événements attachés sont présents dans certains domaines de fonctionnalités où il existe une abstraction au niveau du service, par exemple pour les Mouse événements activés Validation par la classe statique ou la classe.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. Les classes qui interagissent avec le service, ou qui l’utilisent, peuvent employer l’événement dans la syntaxe de l’événement attaché ou choisir de surfacer l’événement attaché en tant qu’événement routé faisant partie de la façon dont la classe intègre les fonctionnalités du service.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.

Bien que WPF définisse plusieurs événements attachés, les scénarios où vous allez utiliser ou gérer directement l’événement attaché sont très limités.Although WPF defines a number of attached events, the scenarios where you will either use or handle the attached event directly are very limited. En règle générale, l’événement attaché répond à un objectif d’architecture, mais est ensuite transféré à un événement routé non attaché (avec un wrapper d’événement 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.

Par exemple, l’événement Mouse.MouseDown attaché sous-jacent peut être géré plus facilement sur tout donné MouseDown UIElement en utilisant UIElement sur, plutôt que de traiter la syntaxe de l’événement attaché en XAML ou dans le code.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. L’événement attaché a une fonction d’architecture, car il permet l’extension future des périphériques d’entrée.The attached event serves a purpose in the architecture because it allows for future expansion of input devices. L’appareil hypothétique n’aurait besoin d’être Mouse.MouseDown déclenché que pour simuler l’entrée de la souris et n’aurait pas Mouse besoin de dériver de pour ce faire.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. Toutefois, ce scénario implique la gestion du code des événements, et la gestion XAML de l’événement attaché ne s’applique pas à ce scénario.However, this scenario involves code handling of the events, and XAML handling of the attached event is not relevant to this scenario.

Gestion d’un événement attaché dans WPFHandling an Attached Event in WPF

La gestion d’un événement attaché et le code du gestionnaire que vous allez écrire sont essentiellement les mêmes que pour un événement routé.The process for handling an attached event, and the handler code that you will write, is basically the same as for a routed event.

En général, un événement attaché WPF n’est pas très différent d’un événement routé WPF.In general, a WPF attached event is not very different from a WPF routed event. Les différences sont le mode de source de l’événement et la façon dont il est exposé par une classe en tant que membre (ce qui affecte également la syntaxe du gestionnaire 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).

Toutefois, comme indiqué précédemment, les événements attachés WPF existants ne sont pas particulièrement destinés à être pris en charge dans WPF.However, as noted earlier, the existing WPF attached events are not particularly intended for handling in WPF. Le plus souvent, le but de l’événement est de permettre à un élément composé de signaler un état à un élément parent au moment de la composition. Dans ce cas, l’événement est généralement déclenché dans du code et compte également sur une gestion de classe dans la classe parente appropriée.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. Par exemple, les éléments d' Selector un sont censés déclencher l' Selected événement attaché, qui est ensuite géré par la Selector classe, puis potentiellement converti par la Selector classe en un événement routé différent, 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. Pour plus d’informations sur les événements routés et la gestion de classe, consultez Marquage des événements routés comme gérés et gestion de classe.For more information on routed events and class handling, see Marking Routed Events as Handled, and Class Handling.

Définition de vos propres événements attachés en tant qu’événements routésDefining Your Own Attached Events as Routed Events

Si vous effectuez une dérivation à partir de classes de base WPF courantes, vous pouvez implémenter vos propres événements attachés en incluant certaines méthodes de modèle dans votre classe et en utilisant des méthodes utilitaires déjà présentes sur les classes de base.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.

Le modèle est le suivant :The pattern is as follows:

  • Un Gestionnaire AddEventName de méthode avec deux paramètres.A method AddEventNameHandler with two parameters. Le premier paramètre est l’instance à laquelle le gestionnaire d’événements est ajouté.The first parameter is the instance to which the event handler is added. Le deuxième paramètre est le gestionnaire d’événements à ajouter.The second parameter is the event handler to add. La méthode doit être public et static, sans valeur de retour.The method must be public and static, with no return value.

  • Un gestionnaire de méthode RemoveEventName avec deux paramètres.A method RemoveEventNameHandler with two parameters. Le premier paramètre est l’instance à partir de laquelle le gestionnaire d’événements est supprimé.The first parameter is the instance from which the event handler is removed. Le deuxième paramètre est le gestionnaire d’événements à supprimer.The second parameter is the event handler to remove. La méthode doit être public et static, sans valeur de retour.The method must be public and static, with no return value.

La méthode d’accesseur AddEventNameHandler facilite le traitement XAML lorsque des attributs de gestionnaire d’événements attachés sont déclarés sur un élément.The AddEventNameHandler accessor method facilitates XAML processing when attached event handler attributes are declared on an element. Les méthodes de gestionnaire AddEventName et RemoveNomÉvénement permettent également d’accéder au code du magasin de gestionnaires d’événements pour l’événement attaché.The AddEventNameHandler and RemoveEventNameHandler methods also enable code access to the event handler store for the attached event.

Ce modèle général n’est pas encore suffisamment précis pour une implémentation pratique dans une infrastructure, car toute implémentation de lecteur XAML donnée peut avoir des modèles différents pour identifier les événements sous-jacents dans le langage et l’architecture de prise en charge.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. C’est l’une des raisons pour lesquelles WPF implémente les événements attachés en tant qu’événements routés; l’identificateur à utiliser pour un événement (RoutedEvent) est déjà défini par le système d’événements 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. En outre, le routage d’un événement est une extension d’implémentation naturelle sur le concept de niveau de langage XAML d’un événement attaché.Also, routing an event is a natural implementation extension on the XAML language-level concept of an attached event.

L’implémentation du Gestionnaire AddNomÉvénement pour un événement attaché WPF consiste à appeler AddHandler le avec l’événement routé et le gestionnaire comme arguments.The AddEventNameHandler implementation for a WPF attached event consists of calling the AddHandler with the routed event and handler as arguments.

Cette stratégie d’implémentation et le système d’événement routé en général restreignent la gestion des événements UIElement attachés à ContentElement des classes dérivées ou à des classes AddHandler dérivées, car seules ces classes ont des implémentations.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.

Par exemple, le code suivant définit l' NeedsCleaning événement attaché sur la classe Aquariumpropriétaire, à l’aide de la stratégie d’événement attaché WPF qui consiste à déclarer l’événement attaché en tant qu’événement routé.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

Notez que la méthode utilisée pour établir le champ d’identificateur d’événement attaché RegisterRoutedEvent,, est en fait la même méthode que celle utilisée pour enregistrer un événement routé non attaché.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. Les événements attachés et les événements routés sont tous inscrits dans un magasin interne centralisé.Attached events and routed events all are registered to a centralized internal store. Cette implémentation du magasin d’événements rend possible la considération conceptuelle des « événements en tant qu’interface » traitée dans Vue d’ensemble des événements routés.This event store implementation enables the "events as an interface" conceptual consideration that is discussed in Routed Events Overview.

Déclenchement d’un événement attaché WPFRaising a WPF Attached Event

En général, vous n’avez pas besoin de déclencher des événements attachés définis par WPF existants à partir de votre code.You do not typically need to raise existing WPF-defined attached events from your code. Ces événements suivent le modèle conceptuel «service» général, et les classes de service InputManager telles que sont chargées de déclencher les événements.These events follow the general "service" conceptual model, and service classes such as InputManager are responsible for raising the events.

Toutefois, si vous définissez un événement attaché personnalisé basé sur le modèle WPF d’événements attachés de base RoutedEventsur, vous pouvez RaiseEvent utiliser pour déclencher un événement attaché à UIElement partir ContentElementde n’importe quel ou.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. Le déclenchement d’un événement routé (attaché ou non) requiert que vous déclariez un élément particulier dans l’arborescence d’éléments comme source d’événement; cette source est signalée comme RaiseEvent appelant.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. Votre service est chargé de déterminer quel est l’élément signalé en tant que source dans l’arborescenceDetermining which element is reported as the source in the tree is your service's responsibility

Voir aussiSee also