ParagraphNode.GetNodesFromTextRange Method (Int32%, Int32%)

2012-10-19

Returns a ContextNodeCollection that contains 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 ParagraphNode 
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: System.Windows.Ink.ContextNodeCollection
A ContextNodeCollection that contains 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 the current ParagraphNode, rather than to the recognized string of the entire RootNode.

Examples

The following example takes a TextBox, selectedResultsTextBox, whose Text property has been set previously to the value returned by GetRecognizedString for a ParagraphNode, paragraph. 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 selStart As Integer = selectedResultsTextBox.SelectionStart
Dim selLength As Integer = selectedResultsTextBox.SelectionLength

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

' Get the nodes that correspond to that range 
Dim selectedSubNodes As ContextNodeCollection = _
    paragraph.GetNodesFromTextRange(selStart, selLength)

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

' First, set all strokes to black 
For Each Stroke As Stroke In paragraph.Strokes
    Stroke.DrawingAttributes.Color = Colors.Black
Next Stroke

' Next, set all selected sub nodes to red 
For Each node As ContextNode In selectedSubNodes
    Dim stroke As Stroke
    For Each stroke In node.Strokes
        stroke.DrawingAttributes.Color = Colors.Red
    Next stroke
Next node

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

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

// Get the nodes that correspond to that range
ContextNodeCollection selectedSubNodes =
        paragraph.GetNodesFromTextRange(ref selStart, ref selLength);


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

// First, set all strokes to black 
foreach (Stroke stroke in paragraph.Strokes)
    stroke.DrawingAttributes.Color = Colors.Black;

// Next, set all selected sub nodes to red 
foreach (ContextNode node in selectedSubNodes)
{
    foreach (Stroke stroke in node.Strokes)
    {
        stroke.DrawingAttributes.Color = Colors.Red;
    }
}

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