WeakEventManager.ListenerList Class

Reference

Definition

Namespace:: System.Windows

Assembly:: WindowsBase.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.

Provides a built-in collection list for storing listeners for a WeakEventManager.

protected: ref class WeakEventManager::ListenerList

protected class WeakEventManager.ListenerList

Protected Class WeakEventManager.ListenerList

Inheritance: Object
WeakEventManager.ListenerList

Derived: System.Windows.WeakEventManager.ListenerList<TEventArgs>

Remarks

Although this list contains members that resemble those defined by IList and ICollection, and provide similar functionality, this class implements neither of those interfaces.

Most WeakEventManager derived classes do not need to use any members on WeakEventManager.ListenerList. The WeakEventManager methods ProtectedAddListener and ProtectedRemoveListener use a default WeakEventManager.ListenerList internally, one list for each source.

You only need to call WeakEventManager.ListenerList methods if your WeakEventManager class maintains multiple lists for the same event-source combination, with each list created to account for different conditions of the event. In this case, you would not use ProtectedAddListener and ProtectedRemoveListener and would instead implement AddListener or RemoveListener to act upon listeners in just one of the internal listener lists, typically based on a parameter that you add to AddListener or RemoveListener. Also, the handler implementation that receives the raw event cannot simply call DeliverEvent; you must instead keep track of the specifics of the event and deliver the event only to the appropriate list using DeliverEventToList.

The various methods of WeakEventManager.ListenerList are provided so that you can work with your internal lists and so that you can prevent modification of the list during actual delivery of the event.

An example class that used this implementation technique is PropertyChangedEventManager, which maintains separate listener lists for PropertyChanged based on which property changed.

XAML Text Usage

You cannot use this class in XAML.

Constructors

WeakEventManager.ListenerList()	Initializes a new instance of the WeakEventManager.ListenerList class.
WeakEventManager.ListenerList(Int32)	Initializes a new instance of the WeakEventManager.ListenerList class with the specified initial capacity.

Properties

Count	Gets the number of items contained in the WeakEventManager.ListenerList.
Empty	Gets a value that represents an empty list for purposes of comparisons.
IsEmpty	Gets a value that declares whether this WeakEventManager.ListenerList is empty.
Item[Int32]	Gets or sets a specific listener item in the WeakEventManager.ListenerList .

Methods

Add(IWeakEventListener)	Adds a IWeakEventListener object to the WeakEventManager.ListenerList.
AddHandler(Delegate)	Adds an event handler to the WeakEventManager.ListenerList.
BeginUse()	Declares the list to be in use. This prevents direct changes to the list during iterations of the list items.
Clone()	Creates a modifiable clone of this WeakEventManager.ListenerList.
CopyTo(WeakEventManager+ListenerList)	Copies the current WeakEventManager.ListenerList to the specified WeakEventManager.ListenerList.
DeliverEvent(Object, EventArgs, Type)	Delivers the event being managed to each listener in the WeakEventManager.ListenerList.
EndUse()	Unlocks the locked state initiated by BeginUse().
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PrepareForWriting(WeakEventManager+ListenerList)	Checks to see whether the provided list is in use, and if so, sets the list reference parameter to a copy of that list rather than the original.
Purge()	Removes all entries from the list where the underlying reference target is a null reference.
Remove(IWeakEventListener)	Removes the first occurrence of a listener item from the WeakEventManager.ListenerList.
RemoveHandler(Delegate)	Removes an event handler from the WeakEventManager.ListenerList.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to