RoutedEventArgs.InvokeEventHandler(Delegate, Object) Method

Reference

Definition

Namespace:: System.Windows

Assembly:: PresentationCore.dll

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.

When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation.

protected:
 virtual void InvokeEventHandler(Delegate ^ genericHandler, System::Object ^ genericTarget);

protected virtual void InvokeEventHandler (Delegate genericHandler, object genericTarget);

abstract member InvokeEventHandler : Delegate * obj -> unit
override this.InvokeEventHandler : Delegate * obj -> unit

Protected Overridable Sub InvokeEventHandler (genericHandler As Delegate, genericTarget As Object)

Parameters

genericHandler: Delegate

The generic handler / delegate implementation to be invoked.

genericTarget: Object

The target on which the provided handler should be invoked.

Examples

The following is pseudocode that illustrates a basic pattern that can be used for implementation. Here, MyRoutedEventHandler is a subclass of RoutedEventHandler.

public class MyRoutedEventArgs : RoutedEventArgs 
{
// other members omitted
    protected override void InvokeEventHandler(Delegate genericHandler, object genericTarget) {
        MyRoutedEventHandler handler = (MyRoutedEventHandler) genericHandler;
        handler(genericTarget, this);
    }
}

Public Class MyRoutedEventArgs
    Inherits RoutedEventArgs
' other members omitted
    Protected Overrides Sub InvokeEventHandler(ByVal genericHandler As System.Delegate, ByVal genericTarget As Object)
        Dim handler As MyRoutedEventHandler = CType(genericHandler, MyRoutedEventHandler)
        handler(genericTarget, Me)
    End Sub
End Class

Remarks

The base implementation incorporates reflection to determine the right handler for any case where the handler is not literally RoutedEventHandler, and this reflection step does have some performance consequences. Invocations can be made more efficient by not relying on reflection. This is the scenario that motivates this method being available for any routed event arguments class that choose to override it. Implementations should not call the base for this method, because your implementation should already be responsible for invoking the type safe handlers.

Notes to Inheritors

This method is intended to be overridden by derived event data classes to provide more efficient invocation of their delegates. The implementation should cast the provided genericHandler to the type-specific delegate, and then invoke that handler.

The default implementation will attempt to invoke the provided handler, attempting to cast it as RoutedEventHandler. If either genericHandler or genericTarget is provided as null, exceptions will be raised.

Applies to

Jaa