DictionaryBase.OnGet Method (Object, Object)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top