Información general sobre eventos adjuntosAttached Events Overview

Lenguaje XAML (Extensible Application Markup Language) define un componente de lenguaje y un tipo de evento denominado evento adjunto.Extensible Application Markup Language (XAML) defines a language component and type of event called an attached event. El concepto de un evento adjunto permite agregar un controlador de un evento determinado a un elemento arbitrario, en lugar de agregarlo a un elemento que realmente define o hereda el evento.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. En este caso, ni el objeto que genera potencialmente el evento ni la instancia de control del destino definen ni "poseen" de otro modo el evento.In this case, neither the object potentially raising the event nor the destination handling instance defines or otherwise "owns" the event.

Requisitos previosPrerequisites

En este tema se da por supuesto que ha leído Información general sobre eventos enrutados e Información general sobre XAML (WPF).This topic assumes that you have read Routed Events Overview and XAML Overview (WPF).

Sintaxis de los eventos adjuntosAttached Event Syntax

Los eventos adjuntos tienen una sintaxis XAML y un patrón de codificación que debe usar el código de respaldo para admitir el uso del evento adjunto.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.

En la sintaxis XAML, el evento adjunto se especifica no solo por su nombre de evento, sino también por su tipo propietario más el nombre del evento, separado por un punto (.).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 (.). Dado que el nombre del evento está calificado con el nombre de su tipo de propiedad, la sintaxis del evento adjunto permite que cualquier evento adjunto se adjunte a cualquier elemento del que se pueda crear una instancia.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.

Por ejemplo, la siguiente es la sintaxis XAML NeedsCleaning para adjuntar un controlador para un evento adjunto personalizado: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"/>

Observe el prefijo aqua:, que, en este caso, es necesario porque el evento adjunto es un evento personalizado que procede de un atributo xmlns asignado personalizado.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.

Cómo implementa WPF los eventos adjuntosHow WPF Implements Attached Events

En WPFWPF, los eventos RoutedEvent adjuntos están respaldados por un campo y se enrutan a través del árbol después de que se generan.In WPF, attached events are backed by a RoutedEvent field and are routed through the tree after they are raised. Normalmente, el origen del evento adjunto (el objeto que genera el evento) es un origen del sistema o del servicio y, por tanto, el objeto que ejecuta el código que genera el evento no forma parte directamente del árbol de elementos.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.

Escenarios de eventos adjuntosScenarios for Attached Events

En WPFWPF, los eventos adjuntos están presentes en ciertas áreas de características donde Mouse hay abstracción de nivel de servicio, como para los eventos habilitados por la clase estática o la Validation clase.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. Las clases que interactúan con el servicio o lo usan pueden emplear el evento de la sintaxis del evento adjunto, o bien pueden optar por exponer el evento adjunto como un evento enrutado que forme parte de cómo la clase integra las capacidades del servicio.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.

Aunque WPFWPF define una serie de eventos adjuntos, los escenarios en los que usará o controlará el evento adjunto directamente son muy limitados.Although WPF defines a number of attached events, the scenarios where you will either use or handle the attached event directly are very limited. Por lo general, el evento adjunto tiene un propósito de arquitectura, pero luego se reenvía a un evento enrutado no asociado (respaldado con un evento CLR "wrapper").Generally, the attached event serves an architecture purpose, but is then forwarded to a non-attached (backed with a CLR event "wrapper") routed event.

Por ejemplo, el evento Mouse.MouseDown adjunto subyacente se puede UIElement controlar MouseDown más UIElement fácilmente en cualquier detalle mediante el uso en eso en lugar de tratar con la sintaxis de evento adjunta en XAML o código.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. El evento adjunto cumple un propósito de la arquitectura porque permite la expansión futura de los dispositivos de entrada.The attached event serves a purpose in the architecture because it allows for future expansion of input devices. El dispositivo hipotético sólo tendría Mouse.MouseDown que subir para simular la entrada del Mouse ratón, y no tendría que derivar de hacerlo.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. Sin embargo, este escenario implica el control de código de los eventos y el control XAML del evento adjunto no es relevante para este escenario.However, this scenario involves code handling of the events, and XAML handling of the attached event is not relevant to this scenario.

Control de un evento adjunto en WPFHandling an Attached Event in WPF

El proceso para controlar un evento adjunto y el código del controlador que se va a escribir son, básicamente, los mismos que para un evento enrutado.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 general, un WPFWPF evento adjunto no es muy diferente de un WPFWPF enrutado eventos.In general, a WPF attached event is not very different from a WPF routed event. Las diferencias son cómo se origina el evento y cómo lo expone una clase como miembro (lo que también afecta a la sintaxis del controlador 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).

Sin embargo, como se indicó anteriormente, los eventos adjuntos WPFWPF existentes no están especialmente diseñados para controlar en WPFWPF.However, as noted earlier, the existing WPF attached events are not particularly intended for handling in WPF. Más a menudo, el propósito del evento es habilitar un elemento compuesto para notificar un estado a un elemento primario en la composición, en cuyo caso el evento se genera normalmente en el código y también se basa en el control de clases de la clase primaria pertinente.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. Por ejemplo, se Selector espera que los Selected elementos dentro de a Selector generen el evento adjunto, que, a continuación, es clase controlada por la clase y, a continuación, potencialmente convertidos por la Selector clase en un evento enrutado diferente, 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. Para obtener más información, consulte Marcar eventos enrutados como controlados y control de clases.For more information on routed events and class handling, see Marking Routed Events as Handled, and Class Handling.

Definición de eventos adjuntos propios como eventos enrutadosDefining Your Own Attached Events as Routed Events

Si se deriva de clases base comunes de WPFWPF, puede implementar sus propios eventos adjuntos mediante la inclusión de determinados métodos de patrón en la clase y mediante el uso de métodos de utilidad que ya están presentes en las clases 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.

El patrón es el siguiente:The pattern is as follows:

  • Un método AddEventNameHandler con dos parámetros.A method AddEventNameHandler with two parameters. El primer parámetro es la instancia a la que se agrega el controlador de eventos.The first parameter is the instance to which the event handler is added. El segundo parámetro es el controlador de eventos que se va a agregar.The second parameter is the event handler to add. El método public debe staticser y , sin ningún valor devuelto.The method must be public and static, with no return value.

  • Un método RemoveEventNameHandler con dos parámetros.A method RemoveEventNameHandler with two parameters. El primer parámetro es la instancia de la que se quita el controlador de eventos.The first parameter is the instance from which the event handler is removed. El segundo parámetro es el controlador de eventos que se va a quitar.The second parameter is the event handler to remove. El método public debe staticser y , sin ningún valor devuelto.The method must be public and static, with no return value.

El método de descriptor de acceso AddEventNameHandler facilita el procesamiento XAML cuando se declaran atributos de controlador de eventos adjuntos en un elemento.The AddEventNameHandler accessor method facilitates XAML processing when attached event handler attributes are declared on an element. Los métodos AddEventNameHandler y RemoveEventNameHandler también permiten el acceso de código al almacén del controlador de eventos para el evento adjunto.The AddEventNameHandler and RemoveEventNameHandler methods also enable code access to the event handler store for the attached event.

Este patrón general aún no es lo suficientemente preciso para la implementación práctica en un marco de trabajo, porque cualquier implementación de lector XAML determinada podría tener esquemas diferentes para identificar eventos subyacentes en el lenguaje y la arquitectura de soporte.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. Esta es una de las razones por las que WPFWPF implementa eventos adjuntos como eventos enrutados; el identificador que seRoutedEventva a usar para un evento ( ) ya está definido por el sistema de eventos WPFWPF.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. Además, el enrutamiento de un evento es una extensión de implementación natural en el concepto de nivel de lenguaje XAML de un evento adjunto.Also, routing an event is a natural implementation extension on the XAML language-level concept of an attached event.

El AddEventNameHandler implementación para un AddHandler WPFWPF evento adjunto consiste en llamar a la con el evento enrutado y controlador como argumentos.The AddEventNameHandler implementation for a WPF attached event consists of calling the AddHandler with the routed event and handler as arguments.

Esta estrategia de implementación y el sistema de UIElement eventos enrutados en general restringen el control de los eventos adjuntos a clases derivadas o ContentElement clases derivadas, porque solo esas clases tienen AddHandler implementaciones.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.

Por ejemplo, el código NeedsCleaning siguiente define el Aquariumevento adjunto en la clase owner , mediante la estrategia de eventos adjuntos WPFWPF de declarar el evento adjunto como un evento enrutado.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

Tenga en cuenta que el método utilizado RegisterRoutedEventpara establecer el campo de identificador de evento adjunto, , es en realidad el mismo método que se utiliza para registrar un evento enrutado no asociado.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. Todos los eventos adjuntos y eventos enrutados se registran en un almacén interno centralizado.Attached events and routed events all are registered to a centralized internal store. Esta implementación del almacén de eventos permite la consideración conceptual de "eventos como una interfaz" que se describe en Información general sobre eventos enrutados.This event store implementation enables the "events as an interface" conceptual consideration that is discussed in Routed Events Overview.

Generación de un evento adjunto de WPFRaising a WPF Attached Event

Normalmente no es necesario generar eventos adjuntos definidos por WPF existentes desde el código.You do not typically need to raise existing WPF-defined attached events from your code. Estos eventos siguen el modelo conceptual general de InputManager "servicio" y las clases de servicio, como son responsables de generar los eventos.These events follow the general "service" conceptual model, and service classes such as InputManager are responsible for raising the events.

Sin embargo, si está definiendo un evento adjunto personalizado basado RoutedEventen el RaiseEvent modelo WPFWPF de UIElement ContentElementbasar eventos adjuntos en , puede usar para generar un evento adjunto desde cualquier o .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. Generar un evento enrutado (adjunto o no) requiere que se declare un elemento determinado en el árbol de elementos como origen de eventos; ese origen se RaiseEvent notifica como el autor de la llamada.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. Determinar qué elemento se notifica como el origen del árbol es responsabilidad del servicio.Determining which element is reported as the source in the tree is your service's responsibility

Consulte tambiénSee also