RecognitionAlternates.GetEnumerator Method
Returns an object that implements the System.Collections.IEnumerator interface that can iterate through the RecognitionAlternate objects within the RecognitionAlternates collection.
Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)
Syntax
'Declaration
Public Function GetEnumerator As RecognitionAlternates.RecognitionAlternatesEnumerator
'Usage
Dim instance As RecognitionAlternates
Dim returnValue As RecognitionAlternates.RecognitionAlternatesEnumerator
returnValue = instance.GetEnumerator()
public RecognitionAlternates.RecognitionAlternatesEnumerator GetEnumerator()
public:
RecognitionAlternates.RecognitionAlternatesEnumerator^ GetEnumerator()
public function GetEnumerator() : RecognitionAlternates.RecognitionAlternatesEnumerator
Return Value
Type: Microsoft.Ink.RecognitionAlternates.RecognitionAlternatesEnumerator
Returns an object that implements the System.Collections.IEnumerator interface that can iterate through the RecognitionAlternate objects within the RecognitionAlternates collection.
Examples
These examples show two ways to traverse a RecognitionAlternates collection and add the string representation for each RecognitionAlternate object contained in the collection to a generic list of string.
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());
}
This example uses the foreach statement (For Each in Visual Basic), which calls the GetEnumerator method in internal code that the compiler generates to support the statement.
Dim inkRecogAlternates As List(Of String) = New List(Of String)
' get the RecognitionAlternates from the RecognitionResult object
Dim mAlternates As RecognitionAlternates = mRecognitionResult.GetAlternatesFromSelection()
' traverse the collection
For Each theRecognitionAlternate As RecognitionAlternate In mAlternates
inkRecogAlternates.Add(theRecognitionAlternate.ToString())
Next
List<String> inkRecogAlternates = new List<string>();
// get the RecognitionAlternates from the RecognitionResult object
RecognitionAlternates mAlternates = mRecognitionResult.GetAlternatesFromSelection();
// traverse the collection
foreach (RecognitionAlternate theRecognitionAlternate in mAlternates)
{
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