WritingRegionNode.GetNodesFromTextRange Method (Int32%, Int32%)

2012-10-19

Returns a collection of descendant ContextNode objects that are from 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 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: System.Windows.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 uses the WritingRegionNode method to mark the strokes that correspond to selected text. The example code assumes that the Text property of the TextBox named theResultsTextBox, is set to the value returned by the GetRecognizedString method: it also assumes that the user has selected some text in theResultsTextBox and that there is an InkAnalyzer named theInkAnalyzer.

' 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. 
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 
For Each stroke As Stroke In writingRegion.Strokes
    stroke.DrawingAttributes.Color = Colors.Black
Next stroke

' Next, set all selected sub nodes to red 
For Each node As ContextNode In selectedRegionSubNodes
    For Each stroke As Stroke In node.Strokes
        stroke.DrawingAttributes.Color = Colors.Red
    Next stroke
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. 
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.Color = Colors.Black;
// Next, set all selected sub nodes to red 
foreach (ContextNode node in selectedRegionSubNodes)
{
    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