RecognizerContext.Recognize Method

Article
12/12/2007

Returns a RecognitionResult object for a Strokes collection.

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

Syntax

'Declaration
Public Function Recognize ( _
    <OutAttribute> ByRef recognitionStatus As RecognitionStatus _
) As RecognitionResult
'Usage
Dim instance As RecognizerContext
Dim recognitionStatus As RecognitionStatus
Dim returnValue As RecognitionResult

returnValue = instance.Recognize(recognitionStatus)

public RecognitionResult Recognize (
    out RecognitionStatus recognitionStatus
)

public:
RecognitionResult^ Recognize (
    [OutAttribute] RecognitionStatus% recognitionStatus
)

public RecognitionResult Recognize (
    /** @attribute OutAttribute() */ /** @ref */ RecognitionStatus recognitionStatus
)

Not applicable.

Parameters

recognitionStatus
A member of the RecognitionStatus enumeration that indicates whether an error occurred during recognition and, if so, which error occurred.

Return Value

The RecognitionResult object for a recognized Strokes collection.

Remarks

This method returns null (Nothing in Microsoft® Visual Basic® .NET) if the recognizer cannot compute a result for the Strokes collection.

Note

You must use a try/catch block when calling the Recognize method because an exception is thrown when the Ink object contains no strokes.

This method performs recognition synchronously. To start background, or asynchronous recognition, call the BackgroundRecognize or BackgroundRecognizeWithAlternates methods.

Example

This C# example shows an event handler for a Button control's Click event, buttonSubmit_Click, that recognizes the ink in its RecognizerContext object, theRecognizerContext, declared in a containing scope. The example then displays the RecognitionResult object, theRecognitionResult in a TextBox control if no errors occurred.

private void buttonSubmit_Click(object sender, System.EventArgs e)
{
    RecognitionStatus theRecognitionStatus;
    theRecognizerContext.EndInkInput();
    try
    {
      theRecognitionResult = theRecognizerContext.Recognize(out theRecognitionStatus);
      if (RecognitionStatus.NoError == theRecognitionStatus)
      {
        theTextBox.Text = theRecognitionResult.TopString;
      }
      else
      {
         theTextBox.Text = "";
      }
    }
    catch
    {
      // If Ink object in theRecognizerContext contains no strokes or only
      // deleted strokes, exception is thrown.
      theTextBox.Text = "";
    }
}

This Microsoft® Visual Basic® .NET example shows an event handler for a Button control's Click event, buttonSubmit_Click, that recognizes the ink in its RecognizerContext object, theRecognizerContext, declared in a containing scope. The example then displays the RecognitionResult object, theRecognitionResult in a TextBox control if no errors occurred.

Private Sub Button1_Click( ByVal sender As System.Object, _
  ByVal e As System.EventArgs) Handles Button1.Click
    theRecognizerContext.EndInkInput()
    Dim theRecognitionStatus As RecognitionStatus
    Try
        theRecognitionResult = theRecognizerContext.Recognize(theRecognitionStatus)
        If RecognitionStatus.NoError = theRecognitionStatus Then
            RichTextBox1.Text = theRecognitionResult.TopString
        Else
            'Handle the error conditions here.
            RichTextBox1.Text = ""
        End If
    Catch
        ' If Ink object in theRecognizerContext contains no strokes or only
        ' deleted strokes, exception is thrown.
        RichTextBox1.Text = ""
    End Try
End Sub

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