LineNode.GetNodesFromTextRange Method (Int32, Int32)
Returns a collection of descendant ContextNode objects that are relevant to 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 LineNode
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
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 LineNode and not the recognized string of the entire RootNode.
The start and length parameters are references because their values can be changed. For example, if the return value of GetRecognizedString is "I am late" and you pass in values of start = 6 and length = 1, corresponding to the letter "a," then the ContextNodeCollection is likely to have just one ContextNode, which is the InkWordNode that corresponds to the word "late." In this case, the value of start will be changed to 5 and the value of length will be changed to 4, corresponding to the entire word "late."
Example
The following example takes a TextBoxTextBox, selectedResultsTextBox, whose TextBox.TextTextBox.Text property has been set previously to the value returned by GetRecognizedString for a LineNode, line. The user has selected some text in the TextBoxTextBox. 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 start As Integer = selectedResultsTextBox.SelectionStart
Dim length As Integer = selectedResultsTextBox.SelectionLength
' Return if no text is selected.
If start = 0 Then
Return
End If
' Get the nodes that correspond to that range
Dim selectedNodes As ContextNodeCollection
selectedNodes = line.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 node As ContextNode In line.SubNodes
Dim inkStroke As Stroke
For Each inkStroke In node.Strokes
If selectedNodes.Contains(node) Then
inkStroke.DrawingAttributes = New DrawingAttributes(Color.Red)
Else
inkStroke.DrawingAttributes = New DrawingAttributes(Color.Black)
End If
Next inkStroke
Next node
// 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;
// Get the nodes that correspond to that range
ContextNodeCollection selectedNodes =
line.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 (ContextNode node in line.SubNodes)
{
foreach (Stroke stroke in node.Strokes)
{
if (selectedNodes.Contains(node))
{
stroke.DrawingAttributes =
new DrawingAttributes(Color.Red);
}
else
{
stroke.DrawingAttributes =
new DrawingAttributes(Color.Black);
}
}
}
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