This documentation is archived and is not being maintained.

TextPointer.GetNextInsertionPosition Method

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

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

public TextPointer GetNextInsertionPosition (
	LogicalDirection direction
)
public TextPointer GetNextInsertionPosition (
	LogicalDirection direction
)
public function GetNextInsertionPosition (
	direction : LogicalDirection
) : TextPointer
You cannot use methods in XAML.

Parameters

direction

A logical direction in which to search for the next insertion position.

Return Value

A TextPointer to 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 TextPointers.

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

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.

.NET Framework

Supported in: 3.0
Show: