InkAnalyzer.GetAlternates Method (StrokeCollection)

Article
12/12/2007

Returns a AnalysisAlternateCollection that contains up to 10 analysis alternates for the specified strokes.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.dll)

Syntax

'Declaration
Public Function GetAlternates ( _
    strokes As StrokeCollection _
) As AnalysisAlternateCollection
'Usage
Dim instance As InkAnalyzer
Dim strokes As StrokeCollection
Dim returnValue As AnalysisAlternateCollection

returnValue = instance.GetAlternates(strokes)

public AnalysisAlternateCollection GetAlternates (
    StrokeCollection strokes
)

public:
AnalysisAlternateCollection^ GetAlternates (
    StrokeCollection^ strokes
)

public AnalysisAlternateCollection GetAlternates (
    StrokeCollection strokes
)

public function GetAlternates (
    strokes : StrokeCollection
) : AnalysisAlternateCollection

Not applicable.

Parameters

strokes
The strokes for which to get analysis alternates.

Return Value

Up to 10 of the top analysis alternates for strokes.

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.

The Stroke objects in strokes do not have to represent adjacent areas of the document.

Example

This example gets the top 10 alternates for the StrokeCollection, theStrokes, associated with the InkAnalyzer, theInkAnalyzer. It then adds the recognized strings for the alternates to the StringCollection, theAlternateStrings.

' Get analysis alternates for the strokes collection and add the
' recognized strings to a string collection.
theAlternateCollection = Me.theInkAnalyzer.GetAlternates(theStrokes)
theAlternateStrings.Clear()

For Each theAlternate As AnalysisAlternate In theAlternateCollection
    theAlternateStrings.Add(theAlternate.RecognizedString)
Next theAlternate

// Get analysis alternates for the strokes collection and add the
// recognized strings to a string collection.
theAlternateCollection = this.theInkAnalyzer.GetAlternates(theStrokes);
theAlternateStrings.Clear();
foreach (AnalysisAlternate theAlternate
    in theAlternateCollection)
{
    theAlternateStrings.Add(theAlternate.RecognizedString);
}

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via