CustomRecognizerNode.GetNodesFromTextRange Method (Int32, Int32)

Article
12/12/2007

Returns a collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string.

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

Syntax

'Declaration
Public Function GetNodesFromTextRange ( _
    ByRef start As Integer, _
    ByRef length As Integer _
) As ContextNodeCollection
'Usage
Dim instance As CustomRecognizerNode
Dim start As Integer
Dim length As Integer
Dim returnValue As ContextNodeCollection

returnValue = instance.GetNodesFromTextRange(start, length)

public ContextNodeCollection GetNodesFromTextRange (
    ref int start,
    ref int length
)

public:
ContextNodeCollection^ GetNodesFromTextRange (
    int% start, 
    int% length
)

public ContextNodeCollection GetNodesFromTextRange (
    /** @ref */ int start, 
    /** @ref */ int length
)

Not applicable.

Parameters

start
The start of the text range in the recognized string.

length
The length of the text range in the recognized string.

Return Value

Returns the collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string.

Remarks

The specified text range should be relative to the recognized string of this CustomRecognizerNode, rather than to the recognized string of the entire RootNode.

Example

The following example uses a TextBox, selectedResultsTextBox. Previously, the Text property has been set to the value returned by GetRecognizedString for a CustomRecognizerNode object, customRecognizer. The user has selected some of the text in the TextBox. If the InkRecognitionConfidence level is Strong, then the Strokes that correspond to that selection are highlighted in red.

' Find out what's been selected in the text box
Dim start As Integer = selectedResultsTextBox.SelectionStart
Dim length As Integer = selectedResultsTextBox.SelectionLength

' Return if no text is selected.
If length = 0 Then
    Return
End If

' Only highlight if strong recognition
If customRecognizer.InkRecognitionConfidence = _
   InkRecognitionConfidence.Strong Then

    Dim selectedNodes As ContextNodeCollection = _
        customRecognizer.GetNodesFromTextRange(start, length)

    ' Use the new start and length value to update the
    ' selection in the TextBox
    selectedResultsTextBox.SelectionStart = start
    selectedResultsTextBox.SelectionLength = length

    ' Color the strokes red if part of the selected words.
    ' Otherwise, color them black.
    For Each Stroke As Stroke In customRecognizer.Strokes
        Stroke.DrawingAttributes.Color = Colors.Black
    Next Stroke

    For Each selectedNode As ContextNode In selectedNodes
        For Each Stroke As Stroke In selectedNode.Strokes
            Stroke.DrawingAttributes.Color = Colors.Red
        Next Stroke
    Next selectedNode
End If

// Find out what's been selected in the text box
int start = selectedResultsTextBox.SelectionStart;
int length = selectedResultsTextBox.SelectionLength;

// Return if no text is selected.
if (length == 0)
    return;

// Only highlight if strong recognition
if (customRecognizer.InkRecognitionConfidence == InkRecognitionConfidence.Strong)
{
    ContextNodeCollection selectedNodes =
        customRecognizer.GetNodesFromTextRange(ref start, ref length);

    // Use the new start and length value to update the
    // selection in the TextBox
    selectedResultsTextBox.SelectionStart = start;
    selectedResultsTextBox.SelectionLength = length;

    // Color the strokes red if part of the selected words.
    // Otherwise, color them black.
    foreach (Stroke stroke in customRecognizer.Strokes)
    {
        stroke.DrawingAttributes.Color = Colors.Black;
    }
    foreach (ContextNode selectedNode in selectedNodes)
    {
        foreach (Stroke stroke in selectedNode.Strokes)
        {
            stroke.DrawingAttributes.Color = Colors.Red;
        }
    }
}

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