AnalysisWarningCollection.AnalysisWarningCollectionEnumerator.Current Property

Article
10/19/2012

Gets the AnalysisWarningBase object in the AnalysisWarningBaseCollection 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 AnalysisWarning
'Usage
Dim instance As AnalysisWarningCollection.AnalysisWarningCollectionEnumerator 
Dim value As AnalysisWarning 

value = instance.Current

public AnalysisWarning Current { get; }

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

public function get Current () : AnalysisWarning

Property Value

Type: Microsoft.Ink.AnalysisWarning
The AnalysisWarning object in the AnalysisWarningCollection to which the enumerator is pointing.

Remarks

After an AnalysisWarningCollection.AnalysisWarningCollectionEnumerator 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 AnalysisWarningCollection.

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 is 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, then the Current property returns the element to which it is set, even if the enumerator is already invalidated.

Examples

The following example iterates through all of the AnalysisWarning objects in an AnalysisWarningCollection, warnings, and collects all of the associated AnalysisHintNode objects.

' Version using GetEnumerator() 
Dim enumerator As AnalysisWarningCollection.AnalysisWarningCollectionEnumerator _
    = warnings.GetEnumerator()
While enumerator.MoveNext()
    Dim hint As AnalysisHintNode _
        = CType(enumerator.Current, AnalysisWarning).AnalysisHint
    hints.Add(hint)
End While

           // Version using GetEnumerator()
            AnalysisWarningCollection.AnalysisWarningCollectionEnumerator enumerator = warnings.GetEnumerator();
            while (enumerator.MoveNext())
            {
                AnalysisHintNode hint = ((AnalysisWarning)enumerator.Current).AnalysisHint;
                hints.Add(hint);
            }

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