Share via


InkAnalyzer.GetAlternates Method

Returns up to 10 analysis alternates for all ink associated with the ink analyzer.

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

Syntax

'Declaration
Public Function GetAlternates As AnalysisAlternateCollection
'Usage
Dim instance As InkAnalyzer 
Dim returnValue As AnalysisAlternateCollection 

returnValue = instance.GetAlternates()
public AnalysisAlternateCollection GetAlternates()
public:
AnalysisAlternateCollection^ GetAlternates()
public function GetAlternates() : AnalysisAlternateCollection

Return Value

Type: Microsoft.Ink.AnalysisAlternateCollection
Up to 10 of the top analysis alternates for all ink associated with the ink analyzer.

Remarks

The top alternate is returned as the first alternate of the collection. If there are more that 10 alternates, only the first 10 are returned.

Examples

This example gets the top 10 alternates for all the ink associated with the InkAnalyzer, theInkAnalyzer. It then adds the recognized strings for the alternates to the System.Collections.Specialized.StringCollection, theAlternateStrings.

' Get analysis alternates for the ink analyzer and add the 
' recognized strings to a string collection.
theAlternateCollection = Me.theInkAnalyzer.GetAlternates()
theAlternateStrings.Clear()
Dim theAlternate As Microsoft.Ink.AnalysisAlternate
For Each theAlternate In theAlternateCollection
    theAlternateStrings.Add(theAlternate.RecognizedString)
Next theAlternate
// Get analysis alternates for the ink analyzer and add the 
// recognized strings to a string collection.
theAlternateCollection = this.theInkAnalyzer.GetAlternates();
theAlternateStrings.Clear();
foreach (Microsoft.Ink.AnalysisAlternate theAlternate
    in theAlternateCollection)
{
    theAlternateStrings.Add(theAlternate.RecognizedString);
}

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

InkAnalyzer Class

InkAnalyzer Members

GetAlternates Overload

Microsoft.Ink Namespace

Microsoft.Ink.AnalysisAlternate

Microsoft.Ink.AnalysisAlternateCollection