Export (0) Print
Expand All

DictionaryBase.OnClear Method

Performs additional custom processes before clearing the contents of the DictionaryBase instance.

[Visual Basic]
Protected Overridable Sub OnClear()
[C#]
protected virtual void OnClear();
[C++]
protected: virtual void OnClear();
[JScript]
protected function OnClear();

Remarks

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

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 deleting all the elements from the underlying System.Collections.Hashtable. By defining this method, implementers can add functionality to inherited methods without having to override all other methods.

OnClear is invoked before the standard Clear behavior, whereas OnClearComplete is invoked after the standard Clear behavior.

For example, implementers can exempt certain elements from deletion by a global Clear.

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 | OnClearComplete | OnRemove

Show:
© 2014 Microsoft