WritingRegionNode Class

Article
12/12/2007

Represents a group of paragraphs with similar orientation.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.dll)
XML Namespace: https://schemas.microsoft.com/winfx/2006/xaml/presentation

Syntax

'Declaration
Public NotInheritable Class WritingRegionNode
    Inherits ContextNode
'Usage
Dim instance As WritingRegionNode

public sealed class WritingRegionNode : ContextNode

public ref class WritingRegionNode sealed : public ContextNode

public final class WritingRegionNode extends ContextNode

public final class WritingRegionNode extends ContextNode

Not applicable.

Remarks

A writing region has a single reading order, such as top down.

Several writing regions can coexist in the same document on the same page if they have different orientations. For example, if a user writes notes that are primarily horizontal but then scribbles a few words diagonally in a corner, the diagonal words are considered to have a different orientation. A new WritingRegion is created for that diagonal text.

A WritingRegionNode object can contain any number of the following types of child elements:

ParagraphNode objects.
Nodes with an unknown Guid value.

Example

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

' Find out what's been selected in the text box
Dim selectionStart As Integer = selectedResultsTextBox.SelectionStart
Dim selectionLength As Integer = selectedResultsTextBox.SelectionLength

' Return if no text is selected.
If selectionLength = 0 Then
    Return
End If 
' Get the nodes that correspond to that range
Dim selectedRegionSubNodes As ContextNodeCollection = writingRegion.GetNodesFromTextRange(selectionStart, selectionLength)


' Use the new start and length value to update the
' selection in the TextBox
selectedResultsTextBox.SelectionStart = selectionStart
selectedResultsTextBox.SelectionLength = selectionLength

' First, set all strokes to black
For Each stroke As Stroke In writingRegion.Strokes
    stroke.DrawingAttributes.Color = Colors.Black
Next stroke

' Next, set all selected sub nodes to red
For Each node As ContextNode In selectedRegionSubNodes
    For Each stroke As Stroke In node.Strokes
        stroke.DrawingAttributes.Color = Colors.Red
    Next stroke
Next node

// Find out what's been selected in the text box
int selectionStart = selectedResultsTextBox.SelectionStart;
int selectionLength = selectedResultsTextBox.SelectionLength;

// Return if no text is selected.
if (selectionLength == 0)
    return;

// Get the nodes that correspond to that range
ContextNodeCollection selectedRegionSubNodes =
        writingRegion.GetNodesFromTextRange(ref selectionStart, ref selectionLength);


// Use the new start and length value to update the
// selection in the TextBox
selectedResultsTextBox.SelectionStart = selectionStart;
selectedResultsTextBox.SelectionLength = selectionLength;

// First, set all strokes to black
foreach (Stroke stroke in writingRegion.Strokes)
    stroke.DrawingAttributes.Color = Colors.Black;
// Next, set all selected sub nodes to red
foreach (ContextNode node in selectedRegionSubNodes)
{
    foreach (Stroke stroke in node.Strokes)
    {
        stroke.DrawingAttributes.Color = Colors.Red;
    }
}

Inheritance Hierarchy

System.Object
System.Windows.Ink.ContextNode
System.Windows.Ink.WritingRegionNode

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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