.NET Framework Class Library  

DictionaryBase.OnRemove Method

Performs additional custom processes before removing an element from the DictionaryBase instance.

[Visual Basic]
Protected Overridable Sub OnRemove( _
   ByVal key As Object, _
   ByVal value As Object _
)
[C#]
protected virtual void OnRemove(
   object key,
   object value
);
[C++]
protected: virtual void OnRemove(
   Object* key,
   Object* value
);
[JScript]
protected function OnRemove(
   key : Object,
   value : Object
);

Parameters

key
The key of the element to remove.
value
The value of the element to remove.

Remarks

The default implementation of this method is intended to be overridden by a derived class to perform some action before the specified element is removed.

The On* methods are invoked only on the instance returned by the Dictionary property, but not on the instance returned by the InnerHashtable property.

Notes to Implementers:  

This method allows implementers to define processes that must be performed before removing the element from the underlying System.Collections.Hashtable. By defining this method, implementers can add functionality to inherited methods without having to override all other methods.

OnRemove is invoked before the standard Remove behavior, whereas OnRemoveComplete is invoked after the standard Remove behavior.

For example, implementers can prevent removal of elements by always throwing an exception in OnRemove.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

DictionaryBase Class | DictionaryBase Members | System.Collections Namespace | OnRemoveComplete | OnClear