InkRecognizerContainer InkRecognizerContainer InkRecognizerContainer InkRecognizerContainer Class

Provides properties and methods to manage one or more InkRecognizer objects used for handwriting recognition.

InkRecognizerContainer is null if a recognition engine is not available on the system.

Syntax

Declaration

public sealed class InkRecognizerContainerpublic sealed class InkRecognizerContainerPublic NotInheritable Class InkRecognizerContainerpublic sealed class InkRecognizerContainer

Remarks

If recognition is not required, use an InkStrokeContainer object instead of an InkManager. Previous recognition results are still available through GetRecognitionResults().

If only recognition is required, and not storage, use an InkRecognizerContainer instead of an InkManager.

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

Constructors summary

Creates a new InkRecognizerContainer object to manage InkRecognizer objects used for handwriting recognition.

InkRecognizerContainer is null if a recognition engine is not available on the system.

Methods summary

Gets the collection of installed handwriting recognizers.

Performs handwriting recognition on one or more InkStroke objects.

Sets the default InkRecognizer used for handwriting recognition.

Constructors

  • InkRecognizerContainer()
    InkRecognizerContainer()
    InkRecognizerContainer()
    InkRecognizerContainer()

    Creates a new InkRecognizerContainer object to manage InkRecognizer objects used for handwriting recognition.

    InkRecognizerContainer is null if a recognition engine is not available on the system.

    public InkRecognizerContainer()public New()Public Sub New()public InkRecognizerContainer()

Methods

  • GetRecognizers()
    GetRecognizers()
    GetRecognizers()
    GetRecognizers()

    Gets the collection of installed handwriting recognizers.

    public IVectorView<InkRecognizer> GetRecognizers()public IVectorView<InkRecognizer> GetRecognizers()Public Function GetRecognizers() As IVectorView( Of InkRecognizer )public IVectorView<InkRecognizer> GetRecognizers()

    Returns

    • The installed handwriting recognizers as a collection of InkRecognizer objects.

  • RecognizeAsync(InkStrokeContainer, InkRecognitionTarget)
    RecognizeAsync(InkStrokeContainer, InkRecognitionTarget)
    RecognizeAsync(InkStrokeContainer, InkRecognitionTarget)
    RecognizeAsync(InkStrokeContainer, InkRecognitionTarget)

    Performs handwriting recognition on one or more InkStroke objects.

    public IAsyncOperation<IVectorView<InkRecognitionResult>> RecognizeAsync(InkStrokeContainer strokeCollection, InkRecognitionTarget recognitionTarget)public IAsyncOperation<IVectorView<InkRecognitionResult>> RecognizeAsync(InkStrokeContainer strokeCollection, InkRecognitionTarget recognitionTarget)Public Function RecognizeAsync(strokeCollection As InkStrokeContainer, recognitionTarget As InkRecognitionTarget) As IAsyncOperation( Of IVectorViewInkRecognitionResult )public IAsyncOperation<IVectorView<InkRecognitionResult>> RecognizeAsync(InkStrokeContainer strokeCollection, InkRecognitionTarget recognitionTarget)

    Parameters

    Returns

    • The results of the recognition as a collection of InkRecognitionResult objects.Each item in the collection represents a written word. For example, the string "this is a test" contains four words that are stored as a collection of four items.

    Remarks

    Because RecognizeAsync(InkRecognitionTarget) does not automatically update the existing recognition results stored in the InkManager, typically UpdateRecognitionResults(IVectorView<InkRecognitionResult>) is called after RecognizeAsync(InkRecognitionTarget) has completed.

  • SetDefaultRecognizer(InkRecognizer)
    SetDefaultRecognizer(InkRecognizer)
    SetDefaultRecognizer(InkRecognizer)
    SetDefaultRecognizer(InkRecognizer)

    Sets the default InkRecognizer used for handwriting recognition.

    public void SetDefaultRecognizer(InkRecognizer recognizer)public void SetDefaultRecognizer(InkRecognizer recognizer)Public Function SetDefaultRecognizer(recognizer As InkRecognizer) As voidpublic void SetDefaultRecognizer(InkRecognizer recognizer)

    Parameters

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute

Details

Assembly

Windows.UI.Input.Inking.dll