mscorlib(4.0.0.0) API with additions
System.Collections.DictionaryBase Class Reference

Provides the abstract base class for a strongly typed collection of key/value pairs. More...

Inheritance diagram for System.Collections.DictionaryBase:
[legend]
Collaboration diagram for System.Collections.DictionaryBase:
[legend]

Public Member Functions

void CopyTo (Array array, int index)
 Copies the T:System.Collections.DictionaryBase elements to a one-dimensional T:System.Array at the specified index. More...
 
void Clear ()
 Clears the contents of the T:System.Collections.DictionaryBase instance. More...
 
IDictionaryEnumerator GetEnumerator ()
 Returns an T:System.Collections.IDictionaryEnumerator that iterates through the T:System.Collections.DictionaryBase instance. More...
 

Protected Member Functions

virtual object OnGet (object key, object currentValue)
 Gets the element with the specified key and value in the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnSet (object key, object oldValue, object newValue)
 Performs additional custom processes before setting a value in the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnInsert (object key, object value)
 Performs additional custom processes before inserting a new element into the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnClear ()
 Performs additional custom processes before clearing the contents of the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnRemove (object key, object value)
 Performs additional custom processes before removing an element from the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnValidate (object key, object value)
 Performs additional custom processes when validating the element with the specified key and value. More...
 
virtual void OnSetComplete (object key, object oldValue, object newValue)
 Performs additional custom processes after setting a value in the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnInsertComplete (object key, object value)
 Performs additional custom processes after inserting a new element into the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnClearComplete ()
 Performs additional custom processes after clearing the contents of the T:System.Collections.DictionaryBase instance. More...
 
virtual void OnRemoveComplete (object key, object value)
 Performs additional custom processes after removing an element from the T:System.Collections.DictionaryBase instance. More...
 

Protected Attributes

IDictionary Dictionary => this
 Gets the list of elements contained in the T:System.Collections.DictionaryBase instance. More...
 

Properties

Hashtable InnerHashtable [get]
 Gets the list of elements contained in the T:System.Collections.DictionaryBase instance. More...
 
int Count [get]
 Gets the number of elements contained in the T:System.Collections.DictionaryBase instance. More...
 
- Properties inherited from System.Collections.IDictionary
object this[object key] [get, set]
 Gets or sets the element with the specified key. More...
 
ICollection Keys [get]
 Gets an T:System.Collections.ICollection object containing the keys of the T:System.Collections.IDictionary object. More...
 
ICollection Values [get]
 Gets an T:System.Collections.ICollection object containing the values in the T:System.Collections.IDictionary object. More...
 
bool IsReadOnly [get]
 Gets a value indicating whether the T:System.Collections.IDictionary object is read-only. More...
 
bool IsFixedSize [get]
 Gets a value indicating whether the T:System.Collections.IDictionary object has a fixed size. More...
 
- Properties inherited from System.Collections.ICollection
int Count [get]
 Gets the number of elements contained in the T:System.Collections.ICollection. More...
 
object SyncRoot [get]
 Gets an object that can be used to synchronize access to the T:System.Collections.ICollection. More...
 
bool IsSynchronized [get]
 Gets a value indicating whether access to the T:System.Collections.ICollection is synchronized (thread safe). More...
 

Detailed Description

Provides the abstract base class for a strongly typed collection of key/value pairs.

Definition at line 8 of file DictionaryBase.cs.

Member Function Documentation

◆ Clear()

void System.Collections.DictionaryBase.Clear ( )

Clears the contents of the T:System.Collections.DictionaryBase instance.

Implements System.Collections.IDictionary.

Definition at line 201 of file DictionaryBase.cs.

◆ CopyTo()

void System.Collections.DictionaryBase.CopyTo ( Array  array,
int  index 
)

Copies the T:System.Collections.DictionaryBase elements to a one-dimensional T:System.Array at the specified index.

Parameters
arrayThe one-dimensional T:System.Array that is the destination of the T:System.Collections.DictionaryEntry objects copied from the T:System.Collections.DictionaryBase instance. The T:System.Array must have zero-based indexing.
indexThe zero-based index in array at which copying begins.
Exceptions
T:System.ArgumentNullExceptionarray is null.
T:System.ArgumentOutOfRangeExceptionindex is less than zero.
T:System.ArgumentExceptionarray is multidimensional.-or- The number of elements in the source T:System.Collections.DictionaryBase is greater than the available space from index to the end of the destination array .
T:System.InvalidCastExceptionThe type of the source T:System.Collections.DictionaryBase cannot be cast automatically to the type of the destination array .

Implements System.Collections.ICollection.

Definition at line 161 of file DictionaryBase.cs.

◆ GetEnumerator()

IDictionaryEnumerator System.Collections.DictionaryBase.GetEnumerator ( )

Returns an T:System.Collections.IDictionaryEnumerator that iterates through the T:System.Collections.DictionaryBase instance.

Returns
An T:System.Collections.IDictionaryEnumerator for the T:System.Collections.DictionaryBase instance.

Implements System.Collections.IDictionary.

Definition at line 235 of file DictionaryBase.cs.

◆ OnClear()

virtual void System.Collections.DictionaryBase.OnClear ( )
protectedvirtual

Performs additional custom processes before clearing the contents of the T:System.Collections.DictionaryBase instance.

Definition at line 272 of file DictionaryBase.cs.

◆ OnClearComplete()

virtual void System.Collections.DictionaryBase.OnClearComplete ( )
protectedvirtual

Performs additional custom processes after clearing the contents of the T:System.Collections.DictionaryBase instance.

Definition at line 306 of file DictionaryBase.cs.

◆ OnGet()

virtual object System.Collections.DictionaryBase.OnGet ( object  key,
object  currentValue 
)
protectedvirtual

Gets the element with the specified key and value in the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to get.
currentValueThe current value of the element associated with key .
Returns
An T:System.Object containing the element with the specified key and value.

Definition at line 251 of file DictionaryBase.cs.

◆ OnInsert()

virtual void System.Collections.DictionaryBase.OnInsert ( object  key,
object  value 
)
protectedvirtual

Performs additional custom processes before inserting a new element into the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to insert.
valueThe value of the element to insert.

Definition at line 267 of file DictionaryBase.cs.

◆ OnInsertComplete()

virtual void System.Collections.DictionaryBase.OnInsertComplete ( object  key,
object  value 
)
protectedvirtual

Performs additional custom processes after inserting a new element into the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to insert.
valueThe value of the element to insert.

Definition at line 301 of file DictionaryBase.cs.

◆ OnRemove()

virtual void System.Collections.DictionaryBase.OnRemove ( object  key,
object  value 
)
protectedvirtual

Performs additional custom processes before removing an element from the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to remove.
valueThe value of the element to remove.

Definition at line 279 of file DictionaryBase.cs.

◆ OnRemoveComplete()

virtual void System.Collections.DictionaryBase.OnRemoveComplete ( object  key,
object  value 
)
protectedvirtual

Performs additional custom processes after removing an element from the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to remove.
valueThe value of the element to remove.

Definition at line 313 of file DictionaryBase.cs.

◆ OnSet()

virtual void System.Collections.DictionaryBase.OnSet ( object  key,
object  oldValue,
object  newValue 
)
protectedvirtual

Performs additional custom processes before setting a value in the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to locate.
oldValueThe old value of the element associated with key .
newValueThe new value of the element associated with key .

Definition at line 260 of file DictionaryBase.cs.

◆ OnSetComplete()

virtual void System.Collections.DictionaryBase.OnSetComplete ( object  key,
object  oldValue,
object  newValue 
)
protectedvirtual

Performs additional custom processes after setting a value in the T:System.Collections.DictionaryBase instance.

Parameters
keyThe key of the element to locate.
oldValueThe old value of the element associated with key .
newValueThe new value of the element associated with key .

Definition at line 294 of file DictionaryBase.cs.

◆ OnValidate()

virtual void System.Collections.DictionaryBase.OnValidate ( object  key,
object  value 
)
protectedvirtual

Performs additional custom processes when validating the element with the specified key and value.

Parameters
keyThe key of the element to validate.
valueThe value of the element to validate.

Definition at line 286 of file DictionaryBase.cs.

Member Data Documentation

◆ Dictionary

IDictionary System.Collections.DictionaryBase.Dictionary => this
protected

Gets the list of elements contained in the T:System.Collections.DictionaryBase instance.

Returns
An T:System.Collections.IDictionary representing the T:System.Collections.DictionaryBase instance itself.

Definition at line 28 of file DictionaryBase.cs.

Property Documentation

◆ Count

int System.Collections.DictionaryBase.Count
get

Gets the number of elements contained in the T:System.Collections.DictionaryBase instance.

Returns
The number of elements contained in the T:System.Collections.DictionaryBase instance.

Definition at line 33 of file DictionaryBase.cs.

◆ InnerHashtable

Hashtable System.Collections.DictionaryBase.InnerHashtable
getprotected

Gets the list of elements contained in the T:System.Collections.DictionaryBase instance.

Returns
A T:System.Collections.Hashtable representing the T:System.Collections.DictionaryBase instance itself.

Definition at line 15 of file DictionaryBase.cs.


The documentation for this class was generated from the following file: