KeyEventArgs.Handled Property
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Gets or sets a value that marks the routed event as handled. A true value for Handled prevents most handlers along the event route from handling the same event again.
Namespace: System.Windows.Input
Assembly: System.Windows (in System.Windows.dll)
Syntax
'Declaration
Public Property Handled As Boolean
public bool Handled { get; set; }
Property Value
Type: System.Boolean
true to mark the routed event handled; false to leave the routed event unhandled, which permits the event to potentially route further. The default is false.
Remarks
A property named Handled exists on certain routed event data classes in Silverlight, and setting the value to true influences behavior of the Silverlight event system. If you set Handled to true, then the event will generally not be routed to the next object along the event route. Generally, you set Handled to true as part of an application event handler. You do so because the user action that initiated the event is deemed to be appropriately handled by the other code defined in that event handler. You can still choose to respond to the event in the handler without setting Handled to true, but be aware that other objects in the event route will then receive the event and invoke their own event handlers after the current event handler is exited.
For exceptional cases, you can register handlers for a routed event that can act even if Handled is set to true in the event data. This should be done with caution, because the Handled concept is intended as a system to prevent spurious or repetitive handling of the same event in a complex object tree, and acting on an already-handled event goes against this design. For more information, see AddHandler.
For details on how to mark key events as handled, see Keyboard Support.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also