ParagraphNode.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 ParagraphNode
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 function GetNodesFromTextRange(
start : int,
length : int,
subTree : ContextNodeCollection
) : ContextNodeCollection
Parameters
start
Type: System.Int32%The start of the text range in the subTree portion of the recognized string.
length
Type: System.Int32%The length of the text range in the recognized string.
subTree
Type: Microsoft.Ink.ContextNodeCollectionThe descendent ContextNode objects to which to narrow the search.
Return Value
Type: Microsoft.Ink.ContextNodeCollection
Returns 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 ParagraphNode, rather than to the recognized string of the entire ParagraphNode or 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."
Examples
The following example takes a ContextNodeCollection object, lastLineCollection, which contains one ContextNode object that corresponds to the last line in a ParagraphNode, paragraph. 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 = paragraph.GetNodesFromTextRange(start, length, lastLineCollection)
' Set all strokes to black
Dim inkStroke As Stroke
For Each inkStroke In paragraph.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 =
paragraph.GetNodesFromTextRange(ref start, ref length, lastLineCollection);
// Set all strokes to black
foreach (Stroke stroke in paragraph.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 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