RecognitionResult.GetAlternatesFromSelection Method (Int32, Int32, Int32)

Article
12/08/2012

Returns the RecognitionAlternates collection from a range within the best result string of the RecognitionResult object, so that each RecognitionAlternate object in the collection corresponds to only one segment of ink. The returned collection is limited to a specified size.

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

Syntax

'Declaration
Public Function GetAlternatesFromSelection ( _
    selectionStart As Integer, _
    selectionLength As Integer, _
    maximumAlternates As Integer _
) As RecognitionAlternates
'Usage
Dim instance As RecognitionResult 
Dim selectionStart As Integer 
Dim selectionLength As Integer 
Dim maximumAlternates As Integer 
Dim returnValue As RecognitionAlternates 

returnValue = instance.GetAlternatesFromSelection(selectionStart, _
    selectionLength, maximumAlternates)

public RecognitionAlternates GetAlternatesFromSelection(
    int selectionStart,
    int selectionLength,
    int maximumAlternates
)

public:
RecognitionAlternates^ GetAlternatesFromSelection(
    int selectionStart, 
    int selectionLength, 
    int maximumAlternates
)

public function GetAlternatesFromSelection(
    selectionStart : int, 
    selectionLength : int, 
    maximumAlternates : int
) : RecognitionAlternates

Parameters

selectionStart
Type: System.Int32

The start of the text selection from which the RecognitionAlternates collection is returned. The default value is 0 (zero).

selectionLength
Type: System.Int32

The length of the text selection from which the RecognitionAlternates collection is returned. The default value is –1, which specifies the text beginning from the start of the selection to the end of the string.

maximumAlternates
Type: System.Int32

The maximum number of alternates to return. The default value is 10. Recognizers that cannot compute the number of alternates, because of degree of difficulty or length of time, return an arbitrary number of alternates.

Return Value

Type: Microsoft.Ink.RecognitionAlternates
Returns the RecognitionAlternates collection from a selection within the best result string of the RecognitionResult object, so that each RecognitionAlternate object in the collection corresponds to only one segment of ink.

Remarks

Note

The number of alternates increases exponentially for large ranges and for some languages. Applications should specify the number of alternates rather than query for the maximum number of alternates that the recognizer can return.

A recognizer is likely to divide "how are you" into three segments—depending on the spacing between segments—one for each word. Call the GetAlternatesFromSelection method to return the alternates for only one segment of this selection.

Note the difference between the GetAlternatesFromSelection method and the AlternatesWithConstantPropertyValues, LineAlternates, and ConfidenceAlternates methods of the RecognitionAlternate object. Although the GetAlternatesFromSelection method returns a RecognitionAlternates collection in which each RecognitionAlternate object corresponds to only one segment of ink within a selection, the AlternatesWithConstantPropertyValues, LineAlternates, and ConfidenceAlternates methods return the RecognitionAlternates collection in which the RecognitionAlternate objects correspond to each segment of ink within a selection.

Examples

This C# example returns up to five RecognitionAlternate objects for the user selection in a TextBox control, theTextBox, which has already been filled with the top result from the RecognitionResult object. The alternates are stored in the RecognitionAlternates collection, theRecognitionAlternates, by using the GetAlternatesFromSelection method. This is a useful way to enable a user to select text that has been recognized and search through the alternates for that text in order to insert a correction.

[C#]

using Microsoft.Ink;
// . . .
try
{
    if (theTextBox.SelectionLength != 0)
    {
        RecognitionAlternates theRecognitionAlternates =
            theRecognitionResult.GetAlternatesFromSelection(
                theTextBox.SelectionStart, theTextBox.SelectionLength, 5);
        // Do something with theRecognitionAlternates here.
    }
}
catch
{
    // handle exceptions here.
}

This Microsoft® Visual Basic® .NET example returns up to five RecognitionAlternate objects for the user selection in a TextBox control, theTextBox, which has already been filled with the top result from the RecognitionResult object. The alternates are stored in the RecognitionAlternates collection, theRecognitionAlternates, by using the GetAlternatesFromSelection method. This is a useful way to enable a user to select text that has been recognized and search through the alternates for that text in order to insert a correction.

[Visual Basic]

Imports Microsoft.Ink
' . . .
Try
    If theTextBox.SelectionLength != 0 Then
        Dim theRecognitionAlternates As RecognitionAlternates
        theRecognitionAlternates = _
            theRecognitionResult.GetAlternatesFromSelection( _
                theTextBox.SelectionStart, _
                theTextBox.SelectionLength, 5)
        'Do something with theRecognitionAlternates here.
    End If
Catch
    'Handle exceptions here.
End Try

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

Share via