RoutedEventArgs.Handled Propriété

Définition

Obtient ou définit une valeur qui indique l’état actuel de la gestion des événements pour un événement routé le long de son itinéraire.Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.

public:
 property bool Handled { bool get(); void set(bool value); };
[get: System.Security.SecurityCritical]
[set: System.Security.SecurityCritical]
public bool Handled { get; set; }
member this.Handled : bool with get, set
Public Property Handled As Boolean

Valeur de propriété

Pour la définition, affectez la valeur true si l’événement doit être marqué comme gérée ; sinon, false.If setting, set to true if the event is to be marked handled; otherwise false. Pour la lecture, true indique qu’un gestionnaire de classe (ou un gestionnaire d’instance le long de l’itinéraire) a déjà marqué cet événement comme géré.If reading this value, true indicates that either a class handler, or some instance handler along the route, has already marked this event handled. falseindique qu’aucun gestionnaire n’a marqué l’événement comme géré.false.indicates that no such handler has marked the event handled.

La valeur par défaut est false.The default value is false.

Attributs

Exemples

L’exemple suivant implémente un gestionnaire d’événements qui marque l’événement comme étant géré.The following example implements an event handler that marks the event handled.

protected override void OnPreviewMouseRightButtonDown(System.Windows.Input.MouseButtonEventArgs e)
{
    e.Handled = true; //suppress the click event and other leftmousebuttondown responders
    MyEditContainer ec = (MyEditContainer)e.Source;
    if (ec.EditState)
    { ec.EditState = false; }
    else
    { ec.EditState = true; }
    base.OnPreviewMouseRightButtonDown(e);
}
Protected Overrides Sub OnPreviewMouseRightButtonDown(ByVal e As System.Windows.Input.MouseButtonEventArgs)
    e.Handled = True 'suppress the click event and other leftmousebuttondown responders
    Dim ec As MyEditContainer = CType(e.Source, MyEditContainer)
    If ec.EditState Then
        ec.EditState = False
    Else
        ec.EditState = True
    End If
    MyBase.OnPreviewMouseRightButtonDown(e)
End Sub

Remarques

Le marquage de l’événement géré limite la visibilité de l’événement routé aux écouteurs le long de l’itinéraire d’événement.Marking the event handled will limit the visibility of the routed event to listeners along the event route. L’événement ne déplace toujours pas le reste de l’itinéraire, mais seuls les gestionnaires ajoutés spécifiquement avec HandledEventsToo true dans l’appel de méthode AddHandler(RoutedEvent, Delegate, Boolean) sont appelés en réponse.The event does still travel the remainder of the route, but only handlers specifically added with HandledEventsToo true in the AddHandler(RoutedEvent, Delegate, Boolean) method call will be invoked in response. Les gestionnaires par défaut sur les écouteurs d’instance (tels que ceux exprimés en langage XAML (eXtensible Application Markup Language)Extensible Application Markup Language (XAML)) ne sont pas appelés.Default handlers on instance listeners (such as those expressed in langage XAML (eXtensible Application Markup Language)Extensible Application Markup Language (XAML)) will not be invoked. La gestion des événements marqués comme étant gérés n’est pas un scénario courant.Handling events that are marked handled is not a common scenario.

Si vous êtes un auteur de contrôle définissant vos propres événements, les décisions que vous prenez en ce qui concerne la gestion des événements au niveau de la classe auront un impact sur les utilisateurs de votre contrôle, ainsi que sur les utilisateurs de contrôles dérivés, et éventuellement d’autres éléments qui sont contenus dans votre contrôle. ou qui contiennent votre contrôle.If you are a control author defining your own events, the decisions you make regarding event handling at the class level will impact users of your control as well as any users of derived controls, and potentially other elements that are either contained by your control or that contain your control. Pour plus d’informations, consultez Marquage des événements routés comme gérés et gestion de classe.For more information, see Marking Routed Events as Handled, and Class Handling.

Dans de très rares circonstances, il est approprié de gérer les événements où Handled est marqué true, et de modifier les arguments d’événement en remplaçant Handled par false.In very rare circumstances it is appropriate to handle events where Handled is marked true, and modify the event arguments by changing Handled to false. Cela peut être nécessaire dans certains domaines d’événements d’entrée de contrôles, tels que la gestion des clés de KeyDown par rapport aux TextInput où les événements d’entrée de niveau inférieur et de haut niveau sont en concurrence pour la gestion, et chacun tente d’utiliser une stratégie de routage différente.This can be necessary in certain areas of input events of controls, such as key handling of KeyDown versus TextInput where low level and high level input events compete for the handling, and each is attempting to work with a different routing strategy.

S’applique à