TextPointer.GetNextInsertionPosition Method (LogicalDirection)

 

Returns a TextPointer to the next insertion position in the specified logical direction.

Namespace:   System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)

public TextPointer GetNextInsertionPosition(
	LogicalDirection direction
)

Parameters

direction
Type: System.Windows.Documents.LogicalDirection

One of the LogicalDirection values that specifies the logical direction in which to search for the next insertion position.

Return Value

Type: System.Windows.Documents.TextPointer

A TextPointer that identifies the next insertion position in the requested direction, or null if no next insertion position can be found.

An insertion position is a position where new content may be added without breaking any semantic rules for the associated content. In practice, an insertion position is anywhere in content where a caret may be positioned. An example of a valid TextPointer position that is not an insertion position is the position between two adjacent Paragraph tags (that is, between the closing tag of the preceding paragraph and the opening tag of the next paragraph).

The following example demonstrates a use for this method. The example uses the GetNextInsertionPosition method to traverse content element boundaries in order to count the number of Paragraph elements present between two specified TextPointer instances.

// This method returns the number of pagragraphs between two
// specified TextPointers.
int GetParagraphCount(TextPointer start, TextPointer end)
{
    int paragraphCount = 0;

    while (start != null && start.CompareTo(end) < 0)
    {
        Paragraph paragraph = start.Paragraph;

        if (paragraph != null)
        {
            paragraphCount++;

            // Advance start to the end of the current paragraph.
            start = paragraph.ContentEnd;
         }

         // Use the GetNextInsertionPosition method to skip over any interceding
         // content element tags.
         start = start.GetNextInsertionPosition(LogicalDirection.Forward);

     } // End while.

         return paragraphCount;

}  // End GetParagraphCount.

.NET Framework
Available since 3.0
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 7.1
Return to top
Show: