DictionaryBase.OnGet(Object, Object) Method

Definition

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

protected:
 virtual System::Object ^ OnGet(System::Object ^ key, System::Object ^ currentValue);
protected virtual object OnGet (object key, object currentValue);
protected virtual object? OnGet (object key, object? currentValue);
abstract member OnGet : obj * obj -> obj
override this.OnGet : obj * obj -> obj
Protected Overridable Function OnGet (key As Object, currentValue As Object) As Object

Parameters

key
Object

The key of the element to get.

currentValue
Object

The current value of the element associated with key.

Returns

An Object containing the element with the specified key and value.

Remarks

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 Inheritors

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

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

Applies to