InkRecognizerCollection.GetPriorityInkRecognizer Method ()

Article
12/12/2007

Gets the first InkRecognizer in the collection that supports the default locale.

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

Syntax

'Declaration
Public Function GetPriorityInkRecognizer As InkRecognizer
'Usage
Dim instance As InkRecognizerCollection
Dim returnValue As InkRecognizer

returnValue = instance.GetPriorityInkRecognizer

public InkRecognizer GetPriorityInkRecognizer ()

public:
InkRecognizer^ GetPriorityInkRecognizer ()

public InkRecognizer GetPriorityInkRecognizer ()

public function GetPriorityInkRecognizer () : InkRecognizer

Not applicable.

Return Value

The first InkRecognizer in the collection that supports the default locale, or a a null reference (Nothing in Visual Basic) reference (Nothing in Visual Basic) if the collection is empty.

Example

The following example gets the InkRecognizer that supports Japanese and boxed input and sets it as the highest priority InkRecognizer. The code then calls GetPriorityInkRecognizer to get the highest-priority InkRecognizer for the default locale. The two InkRecognizer objects will be equal only if the default locale is set to Japanese.

Dim theInkRecognizers As InkRecognizerCollection = _
    theInkAnalyzer.GetInkRecognizersByPriority()

' Get the first recognizer from the InkRecognizerCollection that supports
' both region neutral Japanese and boxed input. 
Dim firstJapaneseBoxedInputRecognizer As InkRecognizer = _
        theInkRecognizers.GetPriorityInkRecognizer(&H11, _
            InkRecognizerCapabilities.BoxedInput)

firstJapaneseBoxedInputRecognizer.SetAsHighestPriorityInkRecognizer()

Dim priorityInkRecognizer As InkRecognizer = theInkRecognizers.GetPriorityInkRecognizer()

'firstJapaneseBoxedInputRecognizer and priorityInkRecognizer are equal
'only if the firstJapaneseBoxedInputRecognizer supports the default locale.

InkRecognizerCollection theInkRecognizers = 
    theInkAnalyzer.GetInkRecognizersByPriority();

// Get the first recognizer from the InkRecognizerCollection that supports
// both region neutral Japanese and boxed input.
InkRecognizer firstJapaneseBoxedInputRecognizer =
    theInkRecognizers.GetPriorityInkRecognizer(0x0011,
        InkRecognizerCapabilities.BoxedInput);

firstJapaneseBoxedInputRecognizer.SetAsHighestPriorityInkRecognizer();

InkRecognizer priorityInkRecognizer = theInkRecognizers.GetPriorityInkRecognizer();

//firstJapaneseBoxedInputRecognizer and priorityInkRecognizer are equal
//only if the firstJapaneseBoxedInputRecognizer supports the default locale.

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