WeakEventManager<TEventSource, TEventArgs> Class

.NET Framework (current version)
 

Provides a type-safe WeakEventManager that enables you to specify the event handler to use for the "weak event listener" pattern. This class defines a type parameter for the source of the event and a type parameter for the event data that is used.

Namespace:   System.Windows
Assembly:  WindowsBase (in WindowsBase.dll)

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.WeakEventManager
      System.Windows.WeakEventManager<TEventSource, TEventArgs>

public class WeakEventManager<TEventSource, TEventArgs> : WeakEventManager
where TEventArgs : EventArgs

Type Parameters

TEventSource

The type that raises the event.

TEventArgs

The type that holds the event data.

NameDescription
System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_protpropertyItem[Object]

Gets or sets the data being stored for the specified source.(Inherited from WeakEventManager.)

System_CAPS_protpropertyReadLock

Establishes a read-lock on the underlying data table, and returns an IDisposable.(Inherited from WeakEventManager.)

System_CAPS_protpropertyWriteLock

Establishes a write-lock on the underlying data table, and returns anIDisposable.(Inherited from WeakEventManager.)

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticAddHandler(TEventSource, String, EventHandler<TEventArgs>)

Adds the specified event handler to the specified event.

System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_protmethodDeliverEvent(Object, EventArgs)

Delivers the event being managed to each listener.(Inherited from WeakEventManager.)

System_CAPS_protmethodDeliverEventToList(Object, EventArgs, WeakEventManager.ListenerList)

Delivers the event being managed to each listener in the provided list.(Inherited from WeakEventManager.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodNewListenerList()

Returns a new object to contain listeners to an event.(Overrides WeakEventManager.NewListenerList().)

System_CAPS_protmethodProtectedAddHandler(Object, Delegate)

Adds the specified delegate as an event handler of the specified source.(Inherited from WeakEventManager.)

System_CAPS_protmethodProtectedAddListener(Object, IWeakEventListener)

Adds the provided listener to the provided source for the event being managed.(Inherited from WeakEventManager.)

System_CAPS_protmethodProtectedRemoveHandler(Object, Delegate)

Removes the previously added handler from the specified source.(Inherited from WeakEventManager.)

System_CAPS_protmethodProtectedRemoveListener(Object, IWeakEventListener)

Removes a previously added listener from the provided source.(Inherited from WeakEventManager.)

System_CAPS_protmethodPurge(Object, Object, Boolean)

Removes inactive listener entries from the data list for the provided source. Returns true if some entries were actually removed from the list.(Inherited from WeakEventManager.)

System_CAPS_protmethodRemove(Object)

Removes all listeners for the specified source.(Inherited from WeakEventManager.)

System_CAPS_pubmethodSystem_CAPS_staticRemoveHandler(TEventSource, String, EventHandler<TEventArgs>)

Removes the specified event handler from the specified event.

System_CAPS_protmethodScheduleCleanup()

Requests that a purge of unused entries in the underlying listener list be performed on a lower priority thread.(Inherited from WeakEventManager.)

System_CAPS_protmethodStartListening(Object)

Starts listening for the event on the specified object.(Overrides WeakEventManager.StartListening(Object).)

System_CAPS_protmethodStopListening(Object)

Stops listening for the event on the specified object.(Overrides WeakEventManager.StopListening(Object).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

The WeakEventManager class enables you to leverage the weak event listener pattern by specifying the event to subscribe to, the source of the event, and event handler. You can use WeakEventManager<TEventSource, TEventArgs> as an alternative to implementing the IWeakEventListener interface and using a specialized WeakEventManager. When you call AddHandler, the source must be of type TEventSource and the event handler you pass must have TEventArgs as its event data. This ensures that type checking occurs at compile time.

.NET Framework
Available since 4.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: