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

Article
2012-10-07

Returns a collection of descendant ContextNode objects from the specified text range in the recognized string within a collection of descendant 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 WritingRegionNode 
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 descendant ContextNode objects used to narrow the search.

Return Value

Type: System.Windows.Ink.ContextNodeCollection
The collection of descendant ContextNode objects that are from the specified text range in the recognized string. The nodes are limited to those that are descendants of subTree.

Remarks

The start and length parameters are reference values that may be changed to specify the entire string associated with the returned ContextNodeCollection. For example, if the return value of GetRecognizedString is "I am late" and you pass in values of start = 6 and length = 1, the parameters correspond to the letter "a." In this case, the ContextNodeCollection is likely to have just one ContextNode, a 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 part of the recognized string of this WritingRegionNode, rather than the recognized string of the entire WritingRegionNode or the entire RootNode. In the previous example, if you pass in a subTree parameter with nodes for "am" and "late," but not "I," 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, lastParagraphLevelCollection. This collection contains one ContextNode that corresponds to the last paragraph in a WritingRegion named writingRegion. It then marks all of the Strokes black except for the ones in the last paragraph, which it changes to red.

' Get the nodes that correspond to this start and length 
Dim selectedNodes As ContextNodeCollection = writingRegion.GetNodesFromTextRange(start, length, lastParagraphCollection)

' Set all strokes to black 
For Each stroke As Stroke In writingRegion.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 =
    writingRegion.GetNodesFromTextRange(ref start, ref length, lastParagraphCollection);

// Set all strokes to black 
foreach (Stroke stroke in writingRegion.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