InkAnalyzer.GetAlternates Method (StrokeCollection, Int32)

Article
10/19/2012

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

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

Syntax

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

returnValue = instance.GetAlternates(strokes, _
    maximumAlternates)

public AnalysisAlternateCollection GetAlternates(
    StrokeCollection strokes,
    int maximumAlternates
)

public:
AnalysisAlternateCollection^ GetAlternates(
    StrokeCollection^ strokes, 
    int maximumAlternates
)

public function GetAlternates(
    strokes : StrokeCollection, 
    maximumAlternates : int
) : AnalysisAlternateCollection

Parameters

strokes
Type: System.Windows.Ink.StrokeCollection

maximumAlternates
Type: System.Int32

The number of analysis alternates to be returned.

Return Value

Type: System.Windows.Ink.AnalysisAlternateCollection
Up to maximumAlternates of the top analysis alternates for strokes.

Remarks

The top alternate is returned as the first alternate of the collection.

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

Examples

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

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

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

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

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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