Share via


WritingRegionNode.GetNodesFromTextRange Method (Int32%, Int32%)

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

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

Syntax

'Declaration
Public Function GetNodesFromTextRange ( _
    ByRef start As Integer, _
    ByRef length As Integer _
) As ContextNodeCollection
'Usage
Dim instance As WritingRegionNode 
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 function GetNodesFromTextRange(
    start : int, 
    length : int
) : ContextNodeCollection

Parameters

  • start
    Type: System.Int32%

    The start of the text range in the recognized string.

  • length
    Type: System.Int32%

    The length of the text range in the recognized string.

Return Value

Type: Microsoft.Ink.ContextNodeCollection
The collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string.

Remarks

The specified text range is relative to the recognized string of this WritingRegionNode rather than the recognized string of the entire RootNode.

Examples

The following example takes a TextBox, selectedResultsTextBox, whose Text property has previously been set to the value returned by GetRecognizedString for a WritingRegionNode, writingRegion. The user has selected some text in the TextBox. The example code takes the selection and marks the Strokes that corresponds to that selection.

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

' Return if no text is selected. 
' selectionLength must be > 0 or GetNodesFromTextRange(...)  
' will throw an ArgumentOutOfRangeException 
If selectionLength = 0 Then 
    Return 
End If 

' Get the nodes that correspond to that range 
Dim selectedRegionSubNodes As ContextNodeCollection = _
    writingRegion.GetNodesFromTextRange(selectionStart, selectionLength)

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

' First, set all strokes to black 
Dim inkStroke As Stroke
For Each inkStroke In writingRegion.Strokes
    inkStroke.DrawingAttributes = New DrawingAttributes(Color.Black)
Next inkStroke
' Next, set all selected sub nodes to red 
Dim node As ContextNode
For Each node In selectedRegionSubNodes
    For Each inkStroke In node.Strokes
        inkStroke.DrawingAttributes = New DrawingAttributes(Color.Red)
    Next inkStroke
Next node
                   // Find out what's been selected in the text box 
                    int selectionStart = selectedResultsTextBox.SelectionStart;
                    int selectionLength = selectedResultsTextBox.SelectionLength;

                    // Return if no text is selected. 
                    // selectionLength must be > 0 or GetNodesFromTextRange(...)  
                    // will throw an ArgumentOutOfRangeException 
                    if (selectionLength == 0)
                        return;

                    // Get the nodes that correspond to that range
                    ContextNodeCollection selectedRegionSubNodes =
                            writingRegion.GetNodesFromTextRange(ref selectionStart, ref selectionLength);


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

                    // First, set all strokes to black 
                    foreach (Stroke stroke in writingRegion.Strokes)
                        stroke.DrawingAttributes =
                                    new DrawingAttributes(Color.Black);
                    // Next, set all selected sub nodes to red 
                    foreach (ContextNode node in selectedRegionSubNodes)
                    {
                        foreach (Stroke stroke in node.Strokes)
                        {
                            stroke.DrawingAttributes =
                                    new DrawingAttributes(Color.Red);
                        }
                    }

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

See Also

Reference

WritingRegionNode Class

WritingRegionNode Members

GetNodesFromTextRange Overload

Microsoft.Ink Namespace