RootNode.GetNodesFromTextRange Method (Int32, Int32, ContextNodeCollection)
Returns a collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string within a collection of descendent nodes.
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, _
subTree As ContextNodeCollection _
) As ContextNodeCollection
'Usage
Dim instance As RootNode
Dim start As Integer
Dim length As Integer
Dim subTree As ContextNodeCollection
Dim returnValue As ContextNodeCollection
returnValue = instance.GetNodesFromTextRange(start, length, subTree)
public ContextNodeCollection GetNodesFromTextRange (
ref int start,
ref int length,
ContextNodeCollection subTree
)
public:
ContextNodeCollection^ GetNodesFromTextRange (
int% start,
int% length,
ContextNodeCollection^ subTree
)
public ContextNodeCollection GetNodesFromTextRange (
/** @ref */ int start,
/** @ref */ int length,
ContextNodeCollection subTree
)
Not applicable.
Parameters
- start
The start of the text range in the subTree portion of the recognized string.
- length
The length of the text range in the recognized string.
- subTree
The descendent ContextNode objects to which to narrow the search.
Return Value
The collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string within the collection of descendent nodes.
Remarks
The specified text range should be relative to the subTree part of the recognized string of this RootNode, rather than to the recognized string of the entire RootNode.
The start and length parameters are references because their values can be changed. For example, 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." The ContextNodeCollection is then likely to have just one ContextNode, which is the InkWordNode that corresponds to the word "late." In this case, the value of start is changed to 5 and the value of length is changed to 4, corresponding to the entire word "late."
Note
The start parameter is relative to the nodes in the subTree parameter. In the previous example, if you pass in a subTree parameter with nodes for "am" and "late" but not "I," then a start parameter of 3 and a length of 4 are the text range for the word "late."
Example
The following example takes a ContextNodeCollection object, lastRegionCollection, which contains one ContextNode object that corresponds to the last paragraph in a RootNode, theRootNode. It then marks all of the Strokes in black except for the ones that correspond to the selected text in the last line, which it changes to red.
' Get the nodes that correspond to this start and length
Dim selectedNodes As ContextNodeCollection = theRootNode.GetNodesFromTextRange(start, length, lastRegionCollection)
' Set all strokes to black
Dim inkStroke As Stroke
For Each inkStroke In theRootNode.Strokes
inkStroke.DrawingAttributes = New DrawingAttributes(Color.Black)
Next inkStroke
' Set strokes in the collection to red
Dim node As ContextNode
For Each node In selectedNodes
For Each inkStroke In node.Strokes
inkStroke.DrawingAttributes = New DrawingAttributes(Color.Red)
Next inkStroke
Next node
// Get the nodes that correspond to this start and length
ContextNodeCollection selectedNodes =
theRootNode.GetNodesFromTextRange(ref start, ref length, lastRegionCollection);
// Set all strokes to black
foreach (Stroke stroke in theRootNode.Strokes)
stroke.DrawingAttributes = new DrawingAttributes(Color.Black);
// Set strokes in the collection to red
foreach (ContextNode node in selectedNodes)
{
foreach (Stroke stroke in node.Strokes)
{
stroke.DrawingAttributes = new DrawingAttributes(Color.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