InkAnalyzer.GetInkRecognizersByPriority Method

Article
10/19/2012

Returns the ordered collection of recognizers.

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

Syntax

'Declaration
Public Function GetInkRecognizersByPriority As InkRecognizerCollection
'Usage
Dim instance As InkAnalyzer 
Dim returnValue As InkRecognizerCollection 

returnValue = instance.GetInkRecognizersByPriority()

public InkRecognizerCollection GetInkRecognizersByPriority()

public:
InkRecognizerCollection^ GetInkRecognizersByPriority()

public function GetInkRecognizersByPriority() : InkRecognizerCollection

Return Value

Type: System.Windows.Ink.InkRecognizerCollection
The ordered collection of recognizers.

Remarks

Applications may check the order of a particular instance of the InkAnalyzer, by calling the GetInkRecognizersByPriority method.

The order of recognizers in this collection represents the order in which recognizers will be evaluated.

This method will return the active InkRecognizerCollection associated with the current InkAnalyzer.

Examples

The following example gets the InkRecognizer that supports Japanese and boxed input, setting 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 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