Visão geral de eventos anexadosAttached Events Overview

Extensible Application Markup Language (XAML) define um componente de linguagem e o tipo de evento chamado evento anexado.Extensible Application Markup Language (XAML) defines a language component and type of event called an attached event. O conceito de um evento anexado permite que você adicione um manipulador para um evento específico a um elemento arbitrário em vez de um elemento que realmente define ou herda o 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. Nesse caso, nem o objeto potencialmente aumentando o evento, nem a instância de tratamento define ou caso contrário, é "proprietário" do evento.In this case, neither the object potentially raising the event nor the destination handling instance defines or otherwise "owns" the event.

PrerequisitesPrerequisites

Este tópico pressupõe que você leu a visão geral de eventos roteados e visão geral de XAML (WPF).This topic assumes that you have read Routed Events Overview and XAML Overview (WPF).

Sintaxe de evento anexadoAttached Event Syntax

Eventos anexados têm uma sintaxe XAML e um padrão de codificação que devem ser usados pelo código de backup para dar suporte ao uso de eventos anexados.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.

Na sintaxe XAML, o evento anexado é especificado não apenas pelo nome do evento, mas por seu tipo proprietário, mais o nome do evento, separado por um ponto (.).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 (.). Porque o nome do evento é qualificado com o nome do seu tipo proprietário, a sintaxe de evento anexado permite que qualquer evento anexado a ser anexado a qualquer elemento que pode ser instanciado.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 exemplo, veja a seguir a sintaxe XAML para anexar um manipulador a um evento de NeedsCleaning anexado 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 o aqua: prefixo; o prefixo é necessário nesse caso porque o evento anexado é um evento personalizado proveniente de um xmlns personalizado e mapeado.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.

Como o WPF implementa eventos anexadosHow WPF Implements Attached Events

No WPF, os eventos anexados são apoiados por um campo de RoutedEvent e são roteados pela árvore após serem gerados.In WPF, attached events are backed by a RoutedEvent field and are routed through the tree after they are raised. Normalmente, a origem do evento anexado (o objeto que gera o evento) é uma fonte de sistema ou serviço e o objeto que executa o código que gera o evento não é, portanto, uma parte direta da árvore 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.

Cenários para eventos anexadosScenarios for Attached Events

No WPF, os eventos anexados estão presentes em determinadas áreas de recursos em que há abstração de nível de serviço, como para os eventos habilitados pela classe de Mouse estática ou a classe 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 que interagem com ou usam o serviço podem usar o evento na sintaxe de evento anexado ou eles podem escolher aumentar o evento anexado como um evento roteado que faz parte de como a classe integra os recursos do serviço.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.

Embora o WPF defina vários eventos anexados, os cenários em que você usará ou manipulará o evento anexado diretamente serão muito 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. Em geral, o evento anexado atende a uma finalidade de arquitetura, mas, em seguida, é encaminhado para um evento roteado não anexado (apoiado com um 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 exemplo, o evento anexado subjacente Mouse.MouseDown pode ser manipulado com mais facilidade em qualquer UIElement determinado usando MouseDown no UIElement em vez de lidar com a sintaxe do evento anexado em XAML ou 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. O evento anexado serve um propósito na arquitetura porque permite expansão futura de dispositivos de entrada.The attached event serves a purpose in the architecture because it allows for future expansion of input devices. O dispositivo hipotético só precisaria gerar Mouse.MouseDown para simular a entrada do mouse e não precisaria derivar de Mouse para fazer isso.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. No entanto, esse cenário envolve a manipulação de código dos eventos, e a manipulação XAML do evento anexado não é relevante para esse cenário.However, this scenario involves code handling of the events, and XAML handling of the attached event is not relevant to this scenario.

Tratando um evento anexado no WPFHandling an Attached Event in WPF

O processo para identificar um evento anexado e o código do manipulador que você vai escrever, é basicamente o mesmo para um evento roteado.The process for handling an attached event, and the handler code that you will write, is basically the same as for a routed event.

Em geral, um evento anexado do WPF não é muito diferente de um evento roteado do WPF.In general, a WPF attached event is not very different from a WPF routed event. As diferenças são como o evento é originado e como ele é exposto por uma classe como um membro (que também afeta a sintaxe do manipulador 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).

No entanto, como observado anteriormente, os eventos anexados do WPF existentes não são especialmente destinados ao tratamento no WPF.However, as noted earlier, the existing WPF attached events are not particularly intended for handling in WPF. Com mais frequência, o objetivo do evento é habilitar um elemento de composição para relatar um estado para um elemento pai na composição, no qual, o evento é gerado normalmente em código e também depende do tratamento da classe na classe pai relevante.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 exemplo, espera-se que os itens dentro de um Selector gerem o evento de Selected anexado, que é então a classe manipulada pela classe Selector e, em seguida, potencialmente convertida pela classe Selector em um evento roteado 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 obter mais informações sobre eventos roteados e identificação por classe, consulte Marcando eventos roteados como manipulados e tratamento de classes.For more information on routed events and class handling, see Marking Routed Events as Handled, and Class Handling.

Definir seus próprios eventos anexados como eventos roteadosDefining Your Own Attached Events as Routed Events

Se você estiver derivando de classes base comuns do WPF, poderá implementar seus próprios eventos anexados, incluindo determinados métodos de padrão em sua classe e usando métodos de utilitário que já estão presentes nas classes 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.

O padrão é o seguinte:The pattern is as follows:

  • Um método adicione o manipuladorEventName a dois parâmetros.A method AddEventNameHandler with two parameters. O primeiro parâmetro é a instância para a qual o manipulador de eventos é adicionado.The first parameter is the instance to which the event handler is added. O segundo parâmetro é o manipulador de eventos a ser adicionado.The second parameter is the event handler to add. O método deve ser public e static, sem valor de retorno.The method must be public and static, with no return value.

  • Um método remova o manipuladorEventName por dois parâmetros.A method RemoveEventNameHandler with two parameters. O primeiro parâmetro é a instância da qual o manipulador de eventos é removido.The first parameter is the instance from which the event handler is removed. O segundo parâmetro é o manipulador de eventos a ser removido.The second parameter is the event handler to remove. O método deve ser public e static, sem valor de retorno.The method must be public and static, with no return value.

O método Adicionar acessador do manipuladorEventName facilita o processamento XAML quando os atributos do manipulador de eventos anexados são declarados em um elemento.The AddEventNameHandler accessor method facilitates XAML processing when attached event handler attributes are declared on an element. Os métodos Adicionar manipuladorEventName e RemoveEventName também habilitam o acesso do código ao repositório do manipulador de eventos para o evento anexado.The AddEventNameHandler and RemoveEventNameHandler methods also enable code access to the event handler store for the attached event.

Esse padrão geral ainda não é preciso para uma implementação prática em uma estrutura, pois uma determinada implementação de leitor XAML pode ter esquemas diferentes para identificar eventos subjacentes na linguagem e arquitetura de suporte.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. Essa é uma das razões pelas quais o WPF implementa eventos anexados como eventos roteados; o identificador a ser usado para um evento (RoutedEvent) já está definido pelo sistema de eventos do 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. Além disso, o roteamento de um evento é uma extensão de implementação natural no conceito de nível de linguagem XAML de um evento anexado.Also, routing an event is a natural implementation extension on the XAML language-level concept of an attached event.

A implementação do manipulador deeventoAdd para um evento anexado do WPF consiste em chamar o AddHandler com o evento roteado e o manipulador como argumentos.The AddEventNameHandler implementation for a WPF attached event consists of calling the AddHandler with the routed event and handler as arguments.

Essa estratégia de implementação e o sistema de eventos roteados em geral restringem o tratamento de eventos anexados para UIElement classes derivadas ou ContentElement classes derivadas, pois somente essas classes têm implementações 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.

Por exemplo, o código a seguir define o evento NeedsCleaning anexado na classe Owner Aquarium, usando a estratégia de evento anexada do WPF de declarar o evento anexado como um evento roteado.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

Observe que o método usado para estabelecer o campo identificador de evento anexado, RegisterRoutedEvent, é, na verdade, o mesmo método usado para registrar um evento roteado não anexado.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. Eventos anexados e eventos roteados são registrados para um repositório centralizado interno.Attached events and routed events all are registered to a centralized internal store. Essa implementação de repositório de eventos permite a consideração conceitual de "eventos como uma interface" que é abordada na visão geral de eventos roteados.This event store implementation enables the "events as an interface" conceptual consideration that is discussed in Routed Events Overview.

Gerar um evento anexado WPFRaising a WPF Attached Event

Normalmente, você não precisa gerar eventos anexados existentes definidos pelo WPF a partir do seu código.You do not typically need to raise existing WPF-defined attached events from your code. Esses eventos seguem o modelo conceitual "serviço" geral, e as classes de serviço, como InputManager, são responsáveis por gerar os eventos.These events follow the general "service" conceptual model, and service classes such as InputManager are responsible for raising the events.

No entanto, se você estiver definindo um evento anexado personalizado com base no modelo WPF de baseando eventos anexados em RoutedEvent, poderá usar RaiseEvent para gerar um evento anexado de qualquer UIElement ou 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. Gerar um evento roteado (anexado ou não) requer que você declare um elemento específico na árvore de elementos como a origem do evento; essa fonte é relatada como o chamador 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. Determinar qual elemento é relatado como a fonte na árvore é responsabilidade do serviçoDetermining which element is reported as the source in the tree is your service's responsibility

Consulte tambémSee also