UIElement.OnPreviewKeyDown(KeyEventArgs) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Invoked when an unhandled PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
protected:
virtual void OnPreviewKeyDown(System::Windows::Input::KeyEventArgs ^ e);protected virtual void OnPreviewKeyDown (System.Windows.Input.KeyEventArgs e);abstract member OnPreviewKeyDown : System.Windows.Input.KeyEventArgs -> unit
override this.OnPreviewKeyDown : System.Windows.Input.KeyEventArgs -> unitProtected Overridable Sub OnPreviewKeyDown (e As KeyEventArgs)Parameters
The KeyEventArgs that contains the event data.
Remarks
This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.
The purpose of this method is similar to the common language runtime (CLR) event pattern On* methods: this method provides the means to handle the matching event from derived classes by establishing a class handler instead of an instance handler. In this case the matching event is a routed event. The implementation pattern of the On* methods is different for routed events because a routed event can be raised by a child element, which is not necessarily the element that will invoke handlers. Therefore, your implementation needs to examine the source properties of the event data. It should not try to reraise the event in most cases.
Either by overriding this method or by registering class handlers with RegisterClassHandler, derived classes of UIElement can call private class handler methods when the event is received along the event route. One scenario where class handling is appropriate is to manipulate the event data and mark the routed event as handled. Another scenario that is specifically for Preview events is to mark them handled so that the matching bubbling class handlers are not invoked.
