LineNode.GetNodesFromTextRange Method (Int32%, Int32%, ContextNodeCollection)

2012-10-19

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: System.Windows.Ink
Assembly: IAWinFX (in IAWinFX.dll)

Syntax

'Declaration
Public Function GetNodesFromTextRange ( _
    ByRef start As Integer, _
    ByRef length As Integer, _
    subTree As ContextNodeCollection _
) As ContextNodeCollection
'Usage
Dim instance As LineNode 
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%

length
Type: System.Int32%

subTree
Type: System.Windows.Ink.ContextNodeCollection

The descendent ContextNode objects to which to narrow the search.

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 within the collection of descendent nodes.

Remarks

The specified text range should be relative to the subTree which is part of the recognized string from the current LineNode and not part of the recognized string from the complete LineNode or the complete 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 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 is the text range for the word "late."

Examples

The following example takes a ContextNodeCollection object, lastWordCollection, which contains one ContextNode that corresponds to the last word in a LineNode, line. 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 = line.GetNodesFromTextRange(start, length, lastWordCollection)

' Set all strokes to black 
For Each Stroke As Stroke In line.Strokes
    Stroke.DrawingAttributes.Color = Colors.Black
Next Stroke
' Set strokes in the collection to red 
For Each node As ContextNode In selectedNodes
    For Each Stroke As Stroke In node.Strokes
        Stroke.DrawingAttributes.Color = Colors.Red
    Next Stroke
Next node

// Get the nodes that correspond to this start and length
ContextNodeCollection selectedNodes =
    line.GetNodesFromTextRange(ref start, ref length, lastWordCollection);

// Set all strokes to black 
foreach (Stroke stroke in line.Strokes)
    stroke.DrawingAttributes.Color = Colors.Black;

// Set strokes in the collection to red 
foreach (ContextNode node in selectedNodes)
{
    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