WritingRegionNode.GetNodesFromTextRange Method (Int32, Int32, ContextNodeCollection)

Article
12/12/2007

Returns a collection of descendant ContextNode objects that are 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 ContextNodeCollection GetNodesFromTextRange (
    /** @ref */ int start, 
    /** @ref */ int length, 
    ContextNodeCollection subTree
)

Not applicable.

Parameters

start

length

subTree
The descendant ContextNode objects to which to narrow the search.

Return Value

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." The ContextNodeCollection is then likely to have just one ContextNode, 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 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."

Example

The following example takes a ContextNodeCollection, lastParagraphLevelCollection, which contains one ContextNode that corresponds to the last paragraph in a WritingRegion, 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 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

Share via