InkAnalyzer.GetTextRangeFromNodes Method

Article
12/12/2007

Finds the text range in the recognized string that corresponds to a collection of ContextNode objects.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.dll)

Syntax

'Declaration
Public Sub GetTextRangeFromNodes ( _
    nodesToSearch As ContextNodeCollection, _
    <OutAttribute> ByRef start As Integer, _
    <OutAttribute> ByRef length As Integer _
)
'Usage
Dim instance As InkAnalyzer
Dim nodesToSearch As ContextNodeCollection
Dim start As Integer
Dim length As Integer

instance.GetTextRangeFromNodes(nodesToSearch, start, length)

public void GetTextRangeFromNodes (
    ContextNodeCollection nodesToSearch,
    out int start,
    out int length
)

public:
void GetTextRangeFromNodes (
    ContextNodeCollection^ nodesToSearch, 
    [OutAttribute] int% start, 
    [OutAttribute] int% length
)

public void GetTextRangeFromNodes (
    ContextNodeCollection nodesToSearch, 
    /** @attribute OutAttribute() */ /** @ref */ int start, 
    /** @attribute OutAttribute() */ /** @ref */ int length
)

Not applicable.

Parameters

nodesToSearch
The collection of ContextNode objects for which to find the text range.

start
When this method returns, the start parameter contains a 32-bit signed integer that indicates the start of the text range. This parameter is passed uninitialized.

length
When this method returns, the length parameter contains a 32-bit signed integer that indicates the length of the text range. This parameter is passed uninitialized.

Remarks

If nodesToSearch contains ContextNode objects that are not adjacent to each other, this method returns the smallest text range that covers all of the ContextNode objects.

This method throws a ArgumentException when nodesToSearch contains a ContextNode that is not associated with the InkAnalyzer.

Example

This example defines a method, SelectTextRangeFromNodes, that sets the text of the TextBox, theResultsTextBox, to the recognition string of the InkAnalyzer, theInkAnalyzer. It then sets the text box selection to span the recognized text for the parameter, theContextNodes.

Private Sub SelectTextRangeFromNodes(ByVal theContextNodes As ContextNodeCollection) 

    ' Set the text of theResultsTextBox.
    Me.theResultsTextBox.Text = Me.theInkAnalyzer.GetRecognizedString()
    
    ' Get the text range for theContextNodes.
    Dim theStart As Integer
    Dim theLength As Integer
    
    Me.theInkAnalyzer.GetTextRangeFromNodes(theContextNodes, theStart, theLength)
    
    ' Select the text range in the TextBox.
    Me.theResultsTextBox.Select(theStart, theLength)

End Sub 'SelectTextRangeFromNodes

private void SelectTextRangeFromNodes(ContextNodeCollection theContextNodes)
{
    // Set the text of theResultsTextBox.
    this.theResultsTextBox.Text = this.theInkAnalyzer.GetRecognizedString();

    // Get the text range for theContextNodes.
    int theStart;
    int theLength;

    this.theInkAnalyzer.GetTextRangeFromNodes(
        theContextNodes, out theStart, out theLength);
    
    // Select the text range in the TextBox.
    this.theResultsTextBox.Select(theStart, theLength);
}

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