Share via


DivisionUnits.InkDivisionUnitsEnumerator.Current Property

Gets the DivisionUnit object in the DivisionUnits collection to which the enumerator is pointing.

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

Syntax

'Declaration
Public ReadOnly Property Current As DivisionUnit
'Usage
Dim instance As DivisionUnits.InkDivisionUnitsEnumerator 
Dim value As DivisionUnit 

value = instance.Current
public DivisionUnit Current { get; }
public:
property DivisionUnit^ Current {
    DivisionUnit^ get ();
}
public function get Current () : DivisionUnit

Property Value

Type: Microsoft.Ink.DivisionUnit
The DivisionUnit object in the DivisionUnits collection to which the enumerator is pointing.

Remarks

After a DivisionUnits.InkDivisionUnitsEnumerator 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, the enumerator has reached the end of the DivisionUnits collection.

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 or 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—the enumerator is irrecoverably invalidated. The next call to the MoveNext or Reset method throws an System.InvalidOperationException exception. If the collection is modified between calling the MoveNext method and calling the Current property, the Current property returns the element that it is set to, even if the enumerator is already invalidated.

Examples

In this example, the System.Collections.IEnumerator is obtained for the DivisionUnits collection, and used to enumerate each item of the collection. The DivisionUnits collection is returned by the DivisionResult.ResultByType method.

Dim theRecognizedText As ArrayList = New ArrayList()
Dim theDivisionUnits As DivisionUnits = theDivisionResult.ResultByType(InkDivisionType.Paragraph)
Dim iEnum As System.Collections.IEnumerator = theDivisionUnits.GetEnumerator()
iEnum.Reset()
While iEnum.MoveNext()
    Dim theDivisionUnit As DivisionUnit = DirectCast(iEnum.Current, DivisionUnit)
    theRecognizedText.Add(theDivisionUnit.RecognitionString)
End While
ArrayList theRecognizedText = new ArrayList();
DivisionUnits theDivisionUnits = theDivisionResult.ResultByType(InkDivisionType.Paragraph);
System.Collections.IEnumerator iEnum = theDivisionUnits.GetEnumerator();
iEnum.Reset();
while (iEnum.MoveNext())
{
    DivisionUnit theDivisionUnit = (DivisionUnit)iEnum.Current;
    theRecognizedText.Add(theDivisionUnit.RecognitionString);
}

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

See Also

Reference

DivisionUnits.InkDivisionUnitsEnumerator Class

DivisionUnits.InkDivisionUnitsEnumerator Members

Microsoft.Ink Namespace

DivisionUnits

DivisionUnit

DivisionUnits.InkDivisionUnitsEnumerator.MoveNext

DivisionUnits.InkDivisionUnitsEnumerator.Reset

Other Resources

System.Collections.IEnumerator