Share via


DivisionUnits.GetEnumerator Method

Returns an object that implements the System.Collections.IEnumerator interface and that can iterate through the DivisionUnit objects within the DivisionUnits collection.

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

Syntax

'Declaration
Public Function GetEnumerator As DivisionUnits.InkDivisionUnitsEnumerator
'Usage
Dim instance As DivisionUnits 
Dim returnValue As DivisionUnits.InkDivisionUnitsEnumerator 

returnValue = instance.GetEnumerator()
public DivisionUnits.InkDivisionUnitsEnumerator GetEnumerator()
public:
DivisionUnits.InkDivisionUnitsEnumerator^ GetEnumerator()
public function GetEnumerator() : DivisionUnits.InkDivisionUnitsEnumerator

Return Value

Type: Microsoft.Ink.DivisionUnits.InkDivisionUnitsEnumerator
Returns an object that implements the System.Collections.IEnumerator interface and that can iterate through the DivisionUnit objects within the DivisionUnits collection.

Examples

These examples show two ways to iterate over the DivisionUnits collection and get the recognized text for each DivisionUnit object cotained in the collection. The DivisionUnits collection is returned by the DivisionResult.ResultByType method.

In this example, the System.Collections.IEnumerator is obtained for the DivisionUnits collection, and used to enumerate each item of the collection.

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);
}

This example uses the foreach statement, which calls the GetEnumerator method in internal code that the compiler generates to support the statement.

Dim theRecognizedText As ArrayList = New ArrayList()
Dim theDivisionUnits As DivisionUnits = theDivisionResult.ResultByType(InkDivisionType.Paragraph)
For Each theDivisionUnit As DivisionUnit In theDivisionUnits
    theRecognizedText.Add(theDivisionUnit.RecognitionString)
Next
ArrayList theRecognizedText = new ArrayList();
DivisionUnits theDivisionUnits = theDivisionResult.ResultByType(InkDivisionType.Paragraph);
foreach (DivisionUnit theDivisionUnit in theDivisionUnits)
{
    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 Class

DivisionUnits Members

Microsoft.Ink Namespace

DivisionUnit

DivisionResult.ResultByType