RecognitionAlternates.RecognitionAlternatesEnumerator.Current Property
Gets the RecognitionAlternate object in the RecognitionAlternates collection to which the enumerator is pointing.
Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)
Syntax
'Declaration
Public ReadOnly Property Current As RecognitionAlternate
'Usage
Dim instance As RecognitionAlternates.RecognitionAlternatesEnumerator
Dim value As RecognitionAlternate
value = instance.Current
public RecognitionAlternate Current { get; }
public:
property RecognitionAlternate^ Current {
RecognitionAlternate^ get ();
}
public function get Current () : RecognitionAlternate
Property Value
Type: Microsoft.Ink.RecognitionAlternate
The RecognitionAlternate object in the RecognitionAlternates collection to which the enumerator is pointing.
Remarks
After a RecognitionAlternates.RecognitionAlternatesEnumerator 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 RecognitionAlternates 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 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
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
See Also
Reference
RecognitionAlternates.RecognitionAlternatesEnumerator Class
RecognitionAlternates.RecognitionAlternatesEnumerator Members
RecognitionAlternates.RecognitionAlternatesEnumerator.MoveNext
RecognitionAlternates.RecognitionAlternatesEnumerator.Reset