Przegląd Załączone zdarzeniaAttached Events Overview

Rozszerzalny język znaczników aplikacji (XAML) definiuje składnik języka i typ zdarzenia o nazwie dołączone zdarzenie.Extensible Application Markup Language (XAML) defines a language component and type of event called an attached event. Koncepcja dołączonego zdarzenia umożliwia dodanie programu obsługi dla określonego zdarzenia do dowolnego elementu, a nie do elementu, który faktycznie definiuje lub dziedziczy zdarzenie.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. W takim przypadku ani obiekt potencjalnie wywoływania zdarzenia, ani wystąpienie obsługi docelowej definiuje lub w inny sposób "jest właścicielem" zdarzenia.In this case, neither the object potentially raising the event nor the destination handling instance defines or otherwise "owns" the event.

Wymagania wstępnePrerequisites

W tym temacie przyjęto założenie, że zapoznano się z omówieniem zdarzeń routatrznych i przeglądem XAML (WPF).This topic assumes that you have read Routed Events Overview and XAML Overview (WPF).

Składnia dołączonego zdarzeniaAttached Event Syntax

Dołączone zdarzenia mają składnię XAML i wzorzec kodowania, który musi być używany przez kod zapasowy w celu obsługi użycia dołączonego zdarzenia.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.

W składni XAML dołączone zdarzenie jest określone nie tylko przez jego nazwę zdarzenia, ale przez jego typ posiadania plus nazwę zdarzenia, oddzielone kropką (.).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 (.). Ponieważ nazwa zdarzenia jest kwalifikowana z nazwą jego typu posiadania, składnia dołączonego zdarzenia umożliwia dołączenia do każdego dołączonego zdarzenia do dowolnego elementu, który może zostać szesnasty.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.

Na przykład poniżej znajduje się składnia XAML dołączania NeedsCleaning programu obsługi dla niestandardowego zdarzenia dołączonego: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"/>

Zanotuj aqua: prefiks; prefiks jest konieczne w tym przypadku, ponieważ dołączone zdarzenie jest zdarzenie niestandardowe, które pochodzi z niestandardowych mapowane 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.

Jak implementuje w ramach WPF dołączone zdarzeniaHow WPF Implements Attached Events

W WPFWpfowania są wspierane RoutedEvent przez pole i są kierowane przez drzewo po ich podniesiony.In WPF, attached events are backed by a RoutedEvent field and are routed through the tree after they are raised. Zazwyczaj źródłem dołączonego zdarzenia (obiekt, który wywołuje zdarzenie) jest źródłem systemu lub usługi, a obiekt, który uruchamia kod, który wywołuje zdarzenie, nie jest zatem bezpośrednią częścią drzewa elementów.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.

Scenariusze dla dołączonych zdarzeńScenarios for Attached Events

W WPFWUszone zdarzenia są obecne w niektórych obszarach funkcji, gdzie istnieje abstrakcja Mouse na poziomie Validation usługi, takich jak dla zdarzeń włączonych przez klasę statyczną lub klasę.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. Klasy, które współdziałają z usługą lub korzystają z niej, mogą używać zdarzenia w składni dołączonego zdarzenia lub mogą wybrać powierzchnię dołączonego zdarzenia jako kierowanego zdarzenia, które jest częścią sposobu, w jaki klasa integruje możliwości usługi.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.

Chociaż WPF definiuje liczbę dołączonych zdarzeń, scenariusze, w których będzie można użyć lub obsłużyć dołączone zdarzenie bezpośrednio są bardzo ograniczone.Although WPF defines a number of attached events, the scenarios where you will either use or handle the attached event directly are very limited. Ogólnie rzecz biorąc dołączone zdarzenie służy ma na celu architektury, ale jest następnie przekazywane do nieprzyłączonego (kopii zapasowej ze zdarzeniem CLR "otoka") kierowane zdarzenie.Generally, the attached event serves an architecture purpose, but is then forwarded to a non-attached (backed with a CLR event "wrapper") routed event.

Na przykład podstawowe dołączone Mouse.MouseDown zdarzenie może być łatwiej obsługiwane UIElement na MouseDown dowolnym UIElement podanym przy użyciu na tym, a nie do czynienia z dołączoną składnią zdarzeń w języku XAML lub kod.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. Dołączone zdarzenie służy celowi w architekturze, ponieważ pozwala na przyszłe rozszerzanie urządzeń wejściowych.The attached event serves a purpose in the architecture because it allows for future expansion of input devices. Hipotetyczne urządzenie musiałoby tylko podnieść, Mouse.MouseDown aby symulować wprowadzanie danych myszy i Mouse nie musiałoby się z tego prowadzać.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. Jednak ten scenariusz obejmuje obsługę kodu zdarzeń i obsługi XAML dołączonego zdarzenia nie jest istotne dla tego scenariusza.However, this scenario involves code handling of the events, and XAML handling of the attached event is not relevant to this scenario.

Obsługa dołączonego zdarzenia w WPFHandling an Attached Event in WPF

Proces obsługi dołączonego zdarzenia i kod obsługi, który zostanie napisaniu, jest zasadniczo taki sam jak dla kierowanego zdarzenia.The process for handling an attached event, and the handler code that you will write, is basically the same as for a routed event.

Ogólnie rzecz biorąc WPF dołączone zdarzenie nie różni się bardzo od WPF kierowane zdarzenie.In general, a WPF attached event is not very different from a WPF routed event. Różnice są jak zdarzenie jest pozyskiwane i jak jest narażony przez klasę jako element członkowski (co również wpływa na składnię programu obsługi 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).

Jednak jak wspomniano wcześniej, istniejące zdarzenia dołączone do WPF nie są szczególnie przeznaczone do obsługi w WPF.However, as noted earlier, the existing WPF attached events are not particularly intended for handling in WPF. Częściej celem zdarzenia jest włączenie kompozytowego elementu do raportowania stanu do elementu nadrzędnego w komponowaniu, w którym to przypadku zdarzenie jest zwykle wywoływane w kodzie, a także opiera się na obsłudze klasy w odpowiedniej klasie nadrzędnej.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. Na przykład elementy Selector w a oczekuje się Selected podnieść dołączone zdarzenie, które Selector jest następnie klasa obsługiwana przez klasę, a następnie potencjalnie konwertowane przez Selector klasę do innego zdarzenia kierowane, 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. Aby uzyskać więcej informacji na temat kierowanych zdarzeń i obsługi klas, zobacz Oznaczanie zdarzeń kierowanych jako obsługiwane i Obsługa klas.For more information on routed events and class handling, see Marking Routed Events as Handled, and Class Handling.

Definiowanie własnych dołączonych zdarzeń jako zdarzeń trasowanychDefining Your Own Attached Events as Routed Events

Jeśli pochodzą z typowych klas podstawowych WPF, można zaimplementować własne dołączone zdarzenia, w tym niektórych metod wzorca w klasie i przy użyciu metod narzędzia, które są już obecne w klasach podstawowych.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.

Wzór jest następujący:The pattern is as follows:

  • Metoda Dodajprogram obsługi nazwy zdarzenia z dwoma parametrami.A method AddEventNameHandler with two parameters. Pierwszy parametr jest wystąpieniem, do którego jest dodawany program obsługi zdarzeń.The first parameter is the instance to which the event handler is added. Drugi parametr jest program obsługi zdarzeń, aby dodać.The second parameter is the event handler to add. Metoda musi public być statici , bez wartości zwracanej.The method must be public and static, with no return value.

  • Metoda Usuń program obsługinazwy zdarzenia z dwoma parametrami.A method RemoveEventNameHandler with two parameters. Pierwszy parametr jest wystąpienie, z którego program obsługi zdarzeń jest usuwany.The first parameter is the instance from which the event handler is removed. Drugi parametr jest program obsługi zdarzeń do usunięcia.The second parameter is the event handler to remove. Metoda musi public być statici , bez wartości zwracanej.The method must be public and static, with no return value.

Add EventNameHandler metody ułatwia przetwarzanie XAML, gdy dołączone atrybuty obsługi zdarzeń są zadeklarowane na element.The AddEventNameHandler accessor method facilitates XAML processing when attached event handler attributes are declared on an element. Metody Dodaj program obsługii usuń obsługę zdarzeń również włączyć dostęp do kodu do magazynu obsługi zdarzeń dla dołączonego zdarzenia.The AddEventNameHandler and RemoveEventNameHandler methods also enable code access to the event handler store for the attached event.

Ten ogólny wzorzec nie jest jeszcze wystarczająco precyzyjne dla praktycznej implementacji w ramach, ponieważ każda implementacja czytnika XAML może mieć różne schematy do identyfikowania podstawowych zdarzeń w języku i architekturze obsługi.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. Jest to jeden z powodów, dla których WPF implementuje dołączone zdarzenia jako kierowane zdarzenia; identyfikator do użycia dla zdarzeniaRoutedEvent( ) jest już zdefiniowany przez system zdarzeń 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. Ponadto routing zdarzenia jest naturalnym rozszerzeniem implementacji na poziomie języka XAML koncepcji dołączonego zdarzenia.Also, routing an event is a natural implementation extension on the XAML language-level concept of an attached event.

Implementacja Dodaj program obsługi zdarzeniaDla zdarzenia dołączonego AddHandler WPF WPF składa się z wywoływania z kierowanego zdarzenia i obsługi jako argumenty.The AddEventNameHandler implementation for a WPF attached event consists of calling the AddHandler with the routed event and handler as arguments.

Ta strategia implementacji i kierowane systemu zdarzeń w ogóle UIElement ograniczyć obsługę ContentElement dołączonych zdarzeń do klas AddHandler pochodnych lub klas pochodnych, ponieważ tylko te klasy mają implementacje.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.

Na przykład poniższy kod NeedsCleaning definiuje dołączone zdarzenie w Aquariumklasie właściciela , przy użyciu strategii zdarzenia dołączone WPF deklarowania dołączone zdarzenie jako zdarzenie routowane.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

Należy zauważyć, że metoda używana do ustanowienia RegisterRoutedEventdołączonego pola identyfikatora zdarzenia, jest w rzeczywistości tą samą metodą, która jest używana do rejestrowania nieprzyłączonego zdarzenia kierowanego.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. Dołączone zdarzenia i kierowane zdarzenia są rejestrowane w scentralizowanym magazynie wewnętrznym.Attached events and routed events all are registered to a centralized internal store. Ta implementacja magazynu zdarzeń umożliwia "zdarzenia jako interfejs" uwagę koncepcyjną, która jest omówiona w Przeglądzie zdarzeń routowanych.This event store implementation enables the "events as an interface" conceptual consideration that is discussed in Routed Events Overview.

Podnoszenie WPF Dołączone zdarzenieRaising a WPF Attached Event

Zazwyczaj nie trzeba podnieść istniejące zdarzenia dołączone zdefiniowane w UPF z kodu.You do not typically need to raise existing WPF-defined attached events from your code. Zdarzenia te są zgodne z ogólnym modelem koncepcyjnym "usługi" i klas usług, takich jak InputManager są odpowiedzialne za podnoszenie zdarzeń.These events follow the general "service" conceptual model, and service classes such as InputManager are responsible for raising the events.

Jeśli jednak definiujesz niestandardowe dołączone zdarzenie na podstawie modelu WPF opartego RoutedEventna dołączonych zdarzeniach, można użyć RaiseEvent do podniesienia dołączonego zdarzenia z dowolnego UIElement lub 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. Wywoływanie kierowane zdarzenie (dołączone lub nie) wymaga zadeklarowania określonego elementu w drzewie elementów jako źródła zdarzenia; to źródło jest RaiseEvent zgłaszane jako wywołujący.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. Określenie, który element jest zgłaszany jako źródło w drzewie, jest obowiązkiem usługiDetermining which element is reported as the source in the tree is your service's responsibility

Zobacz teżSee also