ContextLinkCollection.ContextLinkCollectionEnumerator.Current Property

Article
10/19/2012

Gets the ContextLink object in the ContextLinkCollection to which the enumerator is pointing.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in Microsoft.Ink.Analysis.dll)

Syntax

'Declaration
Public ReadOnly Property Current As ContextLink
'Usage
Dim instance As ContextLinkCollection.ContextLinkCollectionEnumerator 
Dim value As ContextLink 

value = instance.Current

public ContextLink Current { get; }

public:
property ContextLink^ Current {
    ContextLink^ get ();
}

public function get Current () : ContextLink

Property Value

Type: Microsoft.Ink.ContextLink
The ContextLink object in the ContextLinkCollection to which the enumerator is pointing.

Remarks

After a ContextLinkCollection.ContextLinkCollectionEnumerator enumerator is created, or after the 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 Current property. Otherwise, the Current property is undefined.

The Current property throws an exception if the last call to the MoveNext method returns false. If the last call to the MoveNext method returns false, then the enumerator has reached the end of the ContextLinkCollection.

The Current property does not move the position of the enumerator. Consecutive calls to the Current property return the same object until either the MoveNext method or the Reset method is called.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, then the enumerator is invalidated irrecoverably. The next call to the MoveNext method or the Reset method throws an InvalidOperationException exception. If the collection is modified between calling the MoveNext method and calling the Current property, the Current property returns the element to which it is set, even if the enumerator is already invalidated.

Examples

This example gets the Systems.Collections.IEnumerator for the ContextLinkCollection, links, and uses it to place each ContextLink object contained in the collection into an an ArrayList.

Dim customLinks As New ArrayList()
' Version using GetEnumerator() 
Dim enumerator As ContextLinkCollection.ContextLinkCollectionEnumerator = _
    links.GetEnumerator()
enumerator.Reset()
While enumerator.MoveNext()
    Dim aLink As ContextLink = CType(enumerator.Current, ContextLink)
    customLinks.Add(aLink)
End While

ArrayList customLinks = new ArrayList();
// Version using GetEnumerator()
ContextLinkCollection.ContextLinkCollectionEnumerator
    enumerator = links.GetEnumerator();
enumerator.Reset();
while (enumerator.MoveNext())
{
    ContextLink aLink = ((ContextLink)enumerator.Current);
    customLinks.Add(aLink);
}

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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

Version Information

.NET Framework

Supported in: 3.0

Share via