This documentation is archived and is not being maintained.

DictionaryBase.OnGet Method

Gets the element with the specified key and value in the DictionaryBase instance.

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)

protected virtual Object OnGet(
	Object key,
	Object currentValue


Type: System.Object
The key of the element to get.
Type: System.Object
The current value of the element associated with key.

Return Value

Type: System.Object
An Object containing the element with the specified key and value.

The default implementation of this method returns currentValue. It is intended to be overridden by a derived class to perform additional action when the specified element is retrieved.

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

The default implementation of this method is an O(1) operation.

Notes to Implementers

This method allows implementers to define processes that must be performed when executing the standard Get behavior of the underlying System.Collections.Hashtable. By defining this method, implementers can add functionality to inherited methods without having to override all other methods.

OnGet can be used to specify processes to perform before returning the value retrieved from the underlying System.Collections.Hashtable. For example, implementers can cast the value into another type before returning it.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.