InkRecognizer.SetAsHighestPriorityInkRecognizer Method

Article
10/19/2012

Sets this InkRecognizer to the highest priority in the InkAnalyzer object's list of recognizers.

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

Syntax

'Declaration
Public Sub SetAsHighestPriorityInkRecognizer
'Usage
Dim instance As InkRecognizer

instance.SetAsHighestPriorityInkRecognizer()

public void SetAsHighestPriorityInkRecognizer()

public:
void SetAsHighestPriorityInkRecognizer()

public function SetAsHighestPriorityInkRecognizer()

Remarks

The SetAsHighestPriorityInkRecognizer method sets the current InkRecognizer as the highest priority. Call SetAsHighestPriorityInkRecognizer to ensure that the InkAnalyzer uses this InkRecognizer when two or more recognizers support the same language and capabilities.

Note

Setting this InkRecognizer as the highest priority does not mean that the InkAnalyzer uses this InkRecognizer to analyze ink. The InkAnalyzer uses the highest-priority InkRecognizer that supports the default locale unless you specify the locale id when you add strokes to the InkAnalyzer.

Examples

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 are 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