TextPointer Klass

Definition

public ref class TextPointer : System::Windows::Documents::ContentPosition

public class TextPointer : System.Windows.Documents.ContentPosition

type TextPointer = class
    inherit ContentPosition

Public Class TextPointer
Inherits ContentPosition

Arv

Object

ContentPosition

TextPointer

Exempel

I följande exempel visas hur du använder en TextPointer för att hitta en position precis inuti det första Run elementet i en angiven textcontainer.

// This method returns the position just inside of the first text Run (if any) in a 
// specified text container.
TextPointer FindFirstRunInTextContainer(DependencyObject container)
{
    TextPointer position = null;

    if (container != null){
        if (container is FlowDocument)
            position = ((FlowDocument)container).ContentStart;
        else if (container is TextBlock)
            position = ((TextBlock)container).ContentStart;
        else
            return position;
    }
    // Traverse content in forward direction until the position is immediately after the opening 
    // tag of a Run element, or the end of content is encountered.
    while (position != null)
    {
        // Is the current position just after an opening element tag?
        if (position.GetPointerContext(LogicalDirection.Backward) == TextPointerContext.ElementStart)
        {
            // If so, is the tag a Run?
            if (position.Parent is Run)
                break;
        }

        // Not what we're looking for; on to the next position.
        position = position.GetNextContextPosition(LogicalDirection.Forward);
    }
        
    // This will be either null if no Run is found, or a position just inside of the first Run element in the
    // specifed text container.  Because position is formed from ContentStart, it will have a logical direction
    // of Backward.
    return position;
}

' This method returns the position just inside of the first text Run (if any) in a 
' specified text container.
Private Function FindFirstRunInTextContainer(ByVal container As DependencyObject) As TextPointer
    Dim position As TextPointer = Nothing

    If container IsNot Nothing Then
        If TypeOf container Is FlowDocument Then
            position = (CType(container, FlowDocument)).ContentStart
        ElseIf TypeOf container Is TextBlock Then
            position = (CType(container, TextBlock)).ContentStart
        Else
            Return position
        End If
    End If
    ' Traverse content in forward direction until the position is immediately after the opening 
    ' tag of a Run element, or the end of content is encountered.
    Do While position IsNot Nothing
        ' Is the current position just after an opening element tag?
        If position.GetPointerContext(LogicalDirection.Backward) = TextPointerContext.ElementStart Then
            ' If so, is the tag a Run?
            If TypeOf position.Parent Is Run Then
                Exit Do
            End If
        End If

        ' Not what we're looking for on to the next position.
        position = position.GetNextContextPosition(LogicalDirection.Forward)
    Loop

    ' This will be either null if no Run is found, or a position just inside of the first Run element in the
    ' specifed text container.  Because position is formed from ContentStart, it will have a logical direction
    ' of Backward.
    Return position
End Function

I följande exempel implementeras en förenklad sökalgoritm med hjälp av TextPointer anläggningar.

// This method will search for a specified word (string) starting at a specified position.
TextPointer FindWordFromPosition(TextPointer position, string word)
{
    while (position != null)
    {
         if (position.GetPointerContext(LogicalDirection.Forward) == TextPointerContext.Text)
         {
             string textRun = position.GetTextInRun(LogicalDirection.Forward);

             // Find the starting index of any substring that matches "word".
             int indexInRun = textRun.IndexOf(word);
             if (indexInRun >= 0)
             {
                 position = position.GetPositionAtOffset(indexInRun);
                 break;
             }
         }
         else
        {
            position = position.GetNextContextPosition(LogicalDirection.Forward);
        }
    }

     // position will be null if "word" is not found.
     return position; 
}

' This method will search for a specified word (string) starting at a specified position.
Private Function FindWordFromPosition(ByVal position As TextPointer, ByVal word As String) As TextPointer
    Do While position IsNot Nothing
        If position.GetPointerContext(LogicalDirection.Forward) = TextPointerContext.Text Then
            Dim textRun As String = position.GetTextInRun(LogicalDirection.Forward)

            ' Find the starting index of any substring that matches "word".
            Dim indexInRun As Integer = textRun.IndexOf(word)
            If indexInRun >= 0 Then
                position = position.GetPositionAtOffset(indexInRun)
                Exit Do
            End If
        Else
            position = position.GetNextContextPosition(LogicalDirection.Forward)
        End If
    Loop

    ' position will be null if "word" is not found.
    Return position
End Function

Kommentarer

Klassen TextPointer introducerar följande terminologi:

• Position – i sig pekar en TextPointer alltid på en position i innehållet. Sådana positioner hamnar antingen mellan tecken i innehållet eller mellan flödesinnehållselementtaggar som definierar strukturen för innehållet.

• Aktuell position – Eftersom en TextPointer alltid indikerar en position, och eftersom många av de åtgärder som kan utföras via en TextPointer är relativa till den position som för närvarande pekas på av TextPointer, är det klokt att helt enkelt referera till den position som anges av en TextPointer som den aktuella positionen.

• Infogningsposition – En infogningsposition är en position där nytt innehåll kan läggas till utan att bryta mot några semantiska regler för det associerade innehållet. I praktiken finns en insättningsposition var som helst i innehåll där en caret kan placeras. Ett exempel på en giltig TextPointer position som inte är en infogningsposition är positionen mellan två intilliggande Paragraph taggar (det vill säga mellan den avslutande taggen i föregående stycke och den inledande taggen i nästa stycke).

• Symbol – För TextPointer åtgärder som omfattar symboler anses något av följande vara en symbol:

  • En inledande eller avslutande tagg för ett TextElement element.

  • Ett UIElement element som finns i en InlineUIContainer eller BlockUIContainer. Observera att en UIElement sådan alltid räknas som exakt en symbol. Eventuella ytterligare innehåll eller element som ingår i UIElement räknas inte som symboler.

  • Varje 16-bitars Unicode-tecken inuti ett textelement Run .

• Textcontainer – en textcontainer är det element som utgör den ultimata kantlinjen för det aktuella flödesinnehållet. positionen som anges av en TextPointer alltid faller inom en textcontainer. För närvarande måste en textcontainer vara antingen en FlowDocument eller en TextBlock. Generellt sett stöds inte åtgärder mellan TextPointer instanser i olika textcontainrar.

• Dokument – Innehållet i en textcontainer kallas för ett dokument, som i IsInSameDocument metoden och DocumentStart egenskaperna och DocumentEnd .

Klassen TextPointer är avsedd att underlätta bläddering och manipulering av innehåll som representeras av Windows Presentation Foundation (WPF) flödesinnehållselement. I allmänhet härleds sådana element från TextElement. Några av de åtgärder som TextPointer underlättar omfattar följande:

• Utför en ordningsjämförelse av den aktuella positionen med en andra angiven position. CompareTo Se metoden.

• Fastställ vilken typ av innehåll som ligger intill den aktuella positionen i en angiven riktning. GetPointerContext Se metoden och TextPointerContext uppräkningen.

• Hämta omfången TextElement eller ligger intill den aktuella positionen. Se Paragraph och GetAdjacentElement metoden.

• Hämta textcontainern som omfattar det aktuella dokumentet. Se egenskapen Parent .

• Hämta ett angivet antal tecken före eller efter den aktuella positionen. GetTextInRun Se metoden.

• Infoga en sträng med tecken i den aktuella positionen. InsertTextInRun Se metoden.

• Hitta radgränser i innehåll. GetLineStartPosition Se metoden och IsAtLineStartPosition egenskapen.

• Översätt mellan TextPointer positioner och symbolförskjutningar till innehåll. GetOffsetToPosition Se metoderna ochGetPositionAtOffset.

• Utför visuell träfftestning genom att översätta mellan en TextPointer position och en Point som representerar relativa koordinater.

• Hitta en infogningsposition i närheten eller kontrollera om den aktuella positionen är en insättningsposition. GetInsertionPosition Se metoderna och GetNextInsertionPosition och egenskapenIsAtInsertionPosition.

Positionen och LogicalDirection som anges av ett TextPointer objekt är oföränderlig. När innehållet redigeras eller ändras ändras inte den position som anges av en TextPointer i förhållande till den omgivande texten. Snarare justeras förskjutningen av den positionen från början av innehållet på motsvarande sätt för att återspegla den nya relativa positionen i innehållet. Till exempel fortsätter en TextPointer som anger en position i början av ett visst stycke att peka på början av det stycket även när innehållet infogas eller tas bort före eller efter stycket.

Klassen TextPointer tillhandahåller inga offentliga konstruktorer. En instans av TextPointer skapas med hjälp av egenskaper eller metoder för andra objekt (inklusive andra TextPointer objekt). Följande lista innehåller några exempel på metoder och egenskaper som skapar och returnerar en TextPointer. Den här listan är inte fullständig:

• Från : TextRangeStart och End.

• Från : TextElementContentStart, ContentEnd, ElementStartoch ElementEnd.

• Från en TextBlock (textcontainer): ContentStart, ContentEndoch GetPositionFromPoint.

• Från en FlowDocument (textcontainer): ContentStart, och ContentEnd

• Från en befintlig TextPointer: DocumentStart, DocumentEnd, GetNextInsertionPositionoch GetPositionAtOffset.

Se även

• TextRange
• TextPointerContext
• TextElement