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

Article
2012-10-20

Returns a collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string for 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 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 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 used to narrow the search.

Return Value

Type: System.Windows.Ink.ContextNodeCollection
The collection of descendant ContextNode objects corresponding to the specified text range in the recognized string within the collection of descendent nodes.

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, these parameters correspond to the letter "a." Therefore, the ContextNodeCollection is likely to contain just one ContextNode, namely, a InkWordNode that corresponds to the word "late." In this example, 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 represent the text range for the word "late."

Examples

The following example uses the GetNodesFromTextRange method to mark the strokes that correspond to selected text. The example code assumes that the Text property of the TextBox named theResultsTextBox, is set to the value returned by the GetRecognizedString method. The example also assumes that the user has selected some text in theResultsTextBoxand that there is an InkAnalyzer named theInkAnalyzer.

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

    ' Set all strokes to black 
    For Each stroke As Stroke In theRootNode.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

End Sub 'showLastWritingRegion_Click

// 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.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