InkRecognizerCollection.GetPriorityInkRecognizer Method (InkRecognizerCapabilities)

Article
12/12/2007

Gets the first recognizer in the collection that supports the specified capabilities.

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

Syntax

'Declaration
Public Function GetPriorityInkRecognizer ( _
    capabilities As InkRecognizerCapabilities _
) As InkRecognizer
'Usage
Dim instance As InkRecognizerCollection
Dim capabilities As InkRecognizerCapabilities
Dim returnValue As InkRecognizer

returnValue = instance.GetPriorityInkRecognizer(capabilities)

public InkRecognizer GetPriorityInkRecognizer (
    InkRecognizerCapabilities capabilities
)

public:
InkRecognizer^ GetPriorityInkRecognizer (
    InkRecognizerCapabilities capabilities
)

public InkRecognizer GetPriorityInkRecognizer (
    InkRecognizerCapabilities capabilities
)

public function GetPriorityInkRecognizer (
    capabilities : InkRecognizerCapabilities
) : InkRecognizer

Not applicable.

Parameters

capabilities
The capabilities that the recognizer supports.

Return Value

The first InkRecognizer in the collection that supports the specified InkRecognizerCapabilities, or a null reference (Nothing in Visual Basic) reference (Nothing in Visual Basic) if the collection contains no such recognizer.

Remarks

The GetPriorityInkRecognizer method only checks for a recognizer that supports the default locale. If there is a recognizer installed that supports the specified capabilities, but not the default locale, GetPriorityInkRecognizer returns a null reference (Nothing in Visual Basic).

Example

The following example gets the first InkRecognizer from the InkRecognizerCollection, theInkRecognizers, that supports boxed input.

' Get the first recognizer from the InkRecognizerCollection that supports
' boxed input.
Dim theFirstBoxedInputInkRecognizer As InkRecognizer = _
    theInkRecognizers.GetPriorityInkRecognizer(InkRecognizerCapabilities.BoxedInput)

// Get the first recognizer from the InkRecognizerCollection that supports
// boxed input.
InkRecognizer theFirstBoxedInputInkRecognizer =
    theInkRecognizers.GetPriorityInkRecognizer(
        InkRecognizerCapabilities.BoxedInput);

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