Dictionary<TKey,TValue>.Enumerator.IDictionaryEnumerator.Key Property

Definition

Namespace:

System.Collections.Generic

Assembly:

System.Collections.dll

Source:

Dictionary.cs

Gets the key of the element at the current position of the enumerator.

property System::Object ^ System::Collections::IDictionaryEnumerator::Key { System::Object ^ get(); };

object System.Collections.IDictionaryEnumerator.Key { get; }

member this.System.Collections.IDictionaryEnumerator.Key : obj

 ReadOnly Property Key As Object Implements IDictionaryEnumerator.Key

Property Value

Object

The key of the element in the dictionary at the current position of the enumerator.

Implements

Key

Exceptions

InvalidOperationException

The enumerator is positioned before the first element of the collection or after the last element.

Remarks

IDictionaryEnumerator.Key is undefined under any of the following conditions:

• The enumerator is positioned before the first element of the collection. That happens after an enumerator is created or after the IEnumerator.Reset method is called. The MoveNext method must be called to advance the enumerator to the first element of the collection before reading the value of the IDictionaryEnumerator.Key property.

• The last call to MoveNext returned false, which indicates the end of the collection and that the enumerator is positioned after the last element of the collection.

• The enumerator is invalidated due to changes made in the collection, such as adding, modifying, or deleting elements.

IDictionaryEnumerator.Key does not move the position of the enumerator, and consecutive calls to IDictionaryEnumerator.Key return the same object until either MoveNext or IEnumerator.Reset is called.

See also

• IDictionaryEnumerator
• Current
• MoveNext()
• IEnumerator