CustomRecognizerNode.GetNodesFromTextRange Method (Int32%, Int32%)
Returns a collection of descendant ContextNode objects that are relevant to the specified text range in the recognized string.
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 _
) As ContextNodeCollection
'Usage
Dim instance As CustomRecognizerNode
Dim start As Integer
Dim length As Integer
Dim returnValue As ContextNodeCollection
returnValue = instance.GetNodesFromTextRange(start, _
length)
public ContextNodeCollection GetNodesFromTextRange(
ref int start,
ref int length
)
public:
ContextNodeCollection^ GetNodesFromTextRange(
int% start,
int% length
)
public function GetNodesFromTextRange(
start : int,
length : int
) : ContextNodeCollection
Parameters
start
Type: System.Int32%The start of the text range in the recognized string.
length
Type: System.Int32%The length of the text range in the recognized string.
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.
Remarks
The specified text range should be relative to the recognized string of this CustomRecognizerNode, rather than to the recognized string of the entire RootNode.
Examples
The following example uses a TextBox, selectedResultsTextBox. Previously, the Text property has been set to the value returned by GetRecognizedString for a CustomRecognizerNode object, customRecognizer. The user has selected some of the text in the TextBox. If the InkRecognitionConfidence level is Strong, then the Strokes that correspond to that selection are highlighted in red.
' Find out what's been selected in the text box
Dim start As Integer = selectedResultsTextBox.SelectionStart
Dim length As Integer = selectedResultsTextBox.SelectionLength
' Only highlight if strong recognition
If customRecognizer.InkRecognitionConfidence = Microsoft.Ink.InkRecognitionConfidence.Strong Then
Dim selectedNodes As ContextNodeCollection = _
customRecognizer.GetNodesFromTextRange(start, length)
' Use the new start and length value to update the
' selection in the TextBox
selectedResultsTextBox.SelectionStart = start
selectedResultsTextBox.SelectionLength = length
' Color the strokes red if part of the selected words.
' Otherwise, color them black.
Dim theStroke As Stroke
For Each theStroke In customRecognizer.Strokes
theStroke.DrawingAttributes = _
New DrawingAttributes(Color.Black)
Next theStroke
Dim selectedNode As ContextNode
For Each selectedNode In selectedNodes
For Each theStroke In selectedNode.Strokes
theStroke.DrawingAttributes = _
New DrawingAttributes(Color.Red)
Next theStroke
Next selectedNode
End If
// Find out what's been selected in the text box
int start = selectedResultsTextBox.SelectionStart;
int length = selectedResultsTextBox.SelectionLength;
// Return if no text is selected.
if (length == 0)
return;
// Only highlight if strong recognition
if (customRecognizer.InkRecognitionConfidence == Microsoft.Ink.InkRecognitionConfidence.Strong)
{
ContextNodeCollection selectedNodes =
customRecognizer.GetNodesFromTextRange(ref start, ref length);
// Use the new start and length value to update the
// selection in the TextBox
selectedResultsTextBox.SelectionStart = start;
selectedResultsTextBox.SelectionLength = length;
// Color the strokes red if part of the selected words.
// Otherwise, color them black.
foreach (Stroke stroke in customRecognizer.Strokes)
{
stroke.DrawingAttributes =
new DrawingAttributes(Color.Black);
}
foreach (ContextNode selectedNode in selectedNodes)
{
foreach (Stroke stroke in selectedNode.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