InkAnalyzer.GetStrokeLanguageId Method

Article
10/19/2012

Returns the locale identifier of the specified Stroke.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in Microsoft.Ink.Analysis.dll)

Syntax

'Declaration
Public Function GetStrokeLanguageId ( _
    stroke As Stroke _
) As Integer
'Usage
Dim instance As InkAnalyzer 
Dim stroke As Stroke 
Dim returnValue As Integer 

returnValue = instance.GetStrokeLanguageId(stroke)

public int GetStrokeLanguageId(
    Stroke stroke
)

public:
int GetStrokeLanguageId(
    Stroke^ stroke
)

public function GetStrokeLanguageId(
    stroke : Stroke
) : int

Parameters

stroke
Type: Microsoft.Ink.Stroke

The stroke for which to return the locale identifier.

Return Value

Type: System.Int32
The locale identifier of stroke.

Remarks

The stroke's locale is set when you add the stroke by calling AddStroke or AddStrokes. To change the stroke's locale call, InkAnalyzer.SetStrokeLanguageId.

Examples

This example defines a method, GetLanguagesInNode, for returning all the locale identifiers for the strokes in a ContextNode.

''' <summary> 
''' Returns the locale identifiers for all the strokes in the node. 
''' </summary> 
''' <param name="theInkAnalyzer">The ink analyzer containing the node.</param> 
''' <param name="theContextNode">The node to check.</param> 
''' <returns>An array of unique locale identifiers.</returns> 
Private Function GetLanguagesInNode( _
    ByVal theInkAnalyzer As Microsoft.Ink.InkAnalyzer, _
    ByVal theContextNode As Microsoft.Ink.ContextNode) As Integer()

    ' Iterate through the strokes within the context node and add the locale 
    ' identifiers to a collection. 
    Dim theLanguages As New System.Collections.ArrayList()
    Dim theStroke As Microsoft.Ink.Stroke
    For Each theStroke In theContextNode.Strokes
        Dim theStrokeLanguage As Integer = _
            theInkAnalyzer.GetStrokeLanguageId(theStroke)
        If Not theLanguages.Contains(theStrokeLanguage) Then
            theLanguages.Add(theStrokeLanguage)
        End If 
    Next theStroke

    ' Return the elements of the collection as an array. 
    Return CType(theLanguages.ToArray(GetType(Integer)), Integer())

End Function 'GetLanguagesInNode

/// <summary> 
/// Returns the locale identifiers for all the strokes in the node. 
/// </summary> 
/// <param name="theInkAnalyzer">The ink analyzer containing the node.</param>
/// <param name="theContextNode">The node to check.</param>
/// <returns>An array of unique locale identifiers.</returns> 
private int[] GetLanguagesInNode(
    Microsoft.Ink.InkAnalyzer theInkAnalyzer,
    Microsoft.Ink.ContextNode theContextNode)
{
    // Iterate through the strokes within the context node and add the locale 
    // identifiers to a collection.
    System.Collections.ArrayList theLanguages =
        new System.Collections.ArrayList();
    foreach (Microsoft.Ink.Stroke theStroke in theContextNode.Strokes)
    {
        int theStrokeLanguage =
            theInkAnalyzer.GetStrokeLanguageId(theStroke);
        if (!theLanguages.Contains(theStrokeLanguage))
        {
            theLanguages.Add(theStrokeLanguage);
        }
    }

    // Return the elements of the collection as an array. 
    return (int[])(theLanguages.ToArray(typeof(int)));
}

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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