InkRecognizer Class

Article
10/19/2012

Provides access to handwriting recognizers used by the InkAnalyzer.

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

Syntax

'Declaration
Public Class InkRecognizer _
    Implements IDisposable
'Usage
Dim instance As InkRecognizer

public class InkRecognizer : IDisposable

public ref class InkRecognizer : IDisposable

public class InkRecognizer implements IDisposable

Remarks

A recognizer has specific attributes and properties that enable it to perform recognition. The properties of a recognizer must be determined before recognition can occur. The types of properties that a recognizer supports, determine the types of recognition that it can perform. For instance, if a recognizer does not support cursive handwriting, it returns inaccurate results when a user writes in cursive.

A recognizer also has built-in functionality that automatically manages many aspects of handwriting. For instance, it determines the metrics for the lines on which strokes are drawn. You can return the line number of a stroke, but because of the built-in functionality, you do not need to specify how those line metrics are determined.

The InkAnalyzer maintains a InkRecognizerCollection of available recognizers. To access this collection, use the GetInkRecognizersByPriority method of the InkAnalyzer.

Examples

The following example defines a method that returns a string. The string contains information about a specified InkRecognizer. Not shown in this example is the helper method, ListCapabilities, which uses reflection to return information about the capabilities of the InkRecognizer.

' <summary> 
' Generates a string containing information about the specified InkRecognizer. 
' </summary> 
' <param name="theInkRecognizer"> 
' The InkRecognizer from which to gather the information. 
' </param> 
' <returns> 
' A string containing information about the specified InkRecognizer. 
' </returns> 
Private Function GetInkRecognizerData(ByVal theInkRecognizer As InkRecognizer) As String 
    ' Create a StringBuilder in which to collect the information. 
    Dim result As New System.Text.StringBuilder()

    ' Add the name of the recognizer.
    result.AppendLine(String.Format("Name: {0}", theInkRecognizer.Name))

    ' Add the GUID of the recognizer.
    result.AppendLine(String.Format("   Guid: {0}", theInkRecognizer.Guid))

    ' Add the vendor of the recognizer.
    result.AppendLine(String.Format("   Vendor: {0}", theInkRecognizer.Vendor))

    ' Add the languages the recognizer supports.
    result.AppendLine("   Supports the following languages:")
    If 0 = theInkRecognizer.GetLanguages().Length Then
        result.AppendLine("      No languages supported.")
    Else 
        Dim lcid As Integer 
        For Each lcid In theInkRecognizer.GetLanguages()
            Dim theCultureInfo As New System.Globalization.CultureInfo(lcid)
            result.AppendLine(String.Format("      0x{0:x4}: {1}", lcid, theCultureInfo.EnglishName))
        Next lcid
    End If 

    ' Add the capabilities of the recognizer.
    result.AppendLine(String.Format("   Capabilities: 0x{0:x}", theInkRecognizer.Capabilities))

    ' List each capability separately, using a helper method.
    result.Append(Me.ListCapabilities(theInkRecognizer.Capabilities))

    result.AppendLine(String.Format("      {0} properties supported.", _
        theInkRecognizer.GetSupportedProperties().Length.ToString()))

    Return result.ToString()

End Function 'GetInkRecognizerData

/// <summary> 
/// Generates a string containing information about the specified InkRecognizer. 
/// </summary> 
/// <param name="theInkRecognizer">
/// The InkRecognizer from which to gather the information. 
/// </param> 
/// <returns> 
/// A string containing information about the specified InkRecognizer. 
/// </returns> 
private string GetInkRecognizerData(
    InkRecognizer theInkRecognizer)
{
    // Create a StringBuilder in which to collect the information.
    System.Text.StringBuilder result = new System.Text.StringBuilder();

    // Add the name of the recognizer.
    result.AppendLine(string.Format(
        "Name: {0}", theInkRecognizer.Name));

    // Add the GUID of the recognizer.
    result.AppendLine(string.Format(
        "   Guid: {0}", theInkRecognizer.Guid));

    // Add the vendor of the recognizer.
    result.AppendLine(string.Format(
        "   Vendor: {0}", theInkRecognizer.Vendor));

    // Add the languages the recognizer supports.
    result.AppendLine("   Supports the following languages:");
    if (0 == theInkRecognizer.GetLanguages().Length)
    {
        result.AppendLine("      No languages supported.");
    }
    else
    {
        foreach (int lcid in theInkRecognizer.GetLanguages())
        {
            System.Globalization.CultureInfo theCultureInfo =
                new System.Globalization.CultureInfo(lcid);
            result.AppendLine(string.Format(
                "      0x{0:x4}: {1}", lcid, theCultureInfo.EnglishName));
        }
    }

    // Add the capabilities of the recognizer.
    result.AppendLine(string.Format(
        "   Capabilities: 0x{0:x}", theInkRecognizer.Capabilities));

    // List each capability separately, using a helper method.
    result.Append(this.ListCapabilities(theInkRecognizer.Capabilities));

    result.AppendLine(string.Format("      {0} properties supported.", 
        theInkRecognizer.GetSupportedProperties().Length.ToString()));

    return result.ToString();
}

Inheritance Hierarchy

System.Object
System.Windows.Ink.InkRecognizer

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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