RecognitionAlternates.RecognitionAlternatesEnumerator.Reset Method

Article
10/19/2012

Resets the enumerator index to the beginning of the RecognitionAlternates collection.

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

Syntax

'Declaration
Public Sub Reset
'Usage
Dim instance As RecognitionAlternates.RecognitionAlternatesEnumerator

instance.Reset()

public void Reset()

public:
virtual void Reset() sealed

public final function Reset()

Implements

IEnumerator.Reset()

Remarks

The RecognitionAlternates.RecognitionAlternatesEnumerator class supports iterating over a RecognitionAlternates collection and implements the IEnumerator interface.

This method inherits from the Reset method.

Examples

This example gets the System.Collections.IEnumerator for the RecognitionAlternates collection, and uses it to traverse the collection.

Dim inkRecogAlternates As List(Of String) = New List(Of String)
' get the RecognitionAlternates from the RecognitionResult object 
Dim mAlternates As RecognitionAlternates = mRecognitionResult.GetAlternatesFromSelection()
' get the enumerator 
Dim iEnum As RecognitionAlternates.RecognitionAlternatesEnumerator = mAlternates.GetEnumerator()
iEnum.Reset()
' traverse the collection 
While iEnum.MoveNext()
    Dim theRecognitionAlternate As RecognitionAlternate = iEnum.Current
    inkRecogAlternates.Add(theRecognitionAlternate.ToString())
End While

List<String> inkRecogAlternates = new List<string>();
// get the RecognitionAlternates from the RecognitionResult object
RecognitionAlternates mAlternates = mRecognitionResult.GetAlternatesFromSelection();
// get the enumerator
RecognitionAlternates.RecognitionAlternatesEnumerator iEnum = mAlternates.GetEnumerator();
iEnum.Reset();
// traverse the collection 
while (iEnum.MoveNext())
{
    RecognitionAlternate theRecognitionAlternate = iEnum.Current;
    inkRecogAlternates.Add(theRecognitionAlternate.ToString());
}

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