TextPointer.CompareTo(TextPointer) Methode

Definition

Namespace:

System.Windows.Documents

Assembly:

PresentationFramework.dll

Führt einen Ordinalvergleich der angegebenen Positionen des aktuellen TextPointer und eines anderen TextPointer aus.

public:
 int CompareTo(System::Windows::Documents::TextPointer ^ position);

public int CompareTo (System.Windows.Documents.TextPointer position);

member this.CompareTo : System.Windows.Documents.TextPointer -> int

Public Function CompareTo (position As TextPointer) As Integer

Parameter

position

TextPointer

Ein TextPointer, der eine Position angibt, die mit der aktuellen Position verglichen werden soll.

Gibt zurück

Int32

–1, wenn der aktuelle TextPointer vor der position liegt; 0, wenn die Positionen identisch sind; +1, wenn der aktuelle TextPointer nach der position liegt.

Ausnahmen

ArgumentException

position gibt eine Position an, die außerhalb des der aktuellen Position zugeordneten Textcontainers liegt.

Beispiele

Im folgenden Beispiel wird eine Verwendung für diese Methode veranschaulicht. Im Beispiel wird die CompareTo -Methode in Verbindung mit der GetInsertionPosition -Methode verwendet, um zu testen, ob ein angegebenes TextElement leer ist.

// Tests to see if the specified TextElement is empty (has no printatble content).
bool IsElementEmpty(TextElement element)
{
    // Find starting and ending insertion positions in the element.
    // Inward-facing directions are used to make sure that insertion position
    // will be found correctly in case when the element may contain inline 
    // formatting elements (such as a Span or Run that contains Bold or Italic elements).
    TextPointer start = element.ContentStart.GetInsertionPosition(LogicalDirection.Forward);
    TextPointer end = element.ContentEnd.GetInsertionPosition(LogicalDirection.Backward);
     
    // The element has no printable content if its first and last insertion positions are equal.
    return start.CompareTo(end) == 0;
} // End IsEmptyElement method.

' Tests to see if the specified TextElement is empty (has no printatble content).
Private Function IsElementEmpty(ByVal element As TextElement) As Boolean
    ' Find starting and ending insertion positions in the element.
    ' Inward-facing directions are used to make sure that insertion position
    ' will be found correctly in case when the element may contain inline 
    ' formatting elements (such as a Span or Run that contains Bold or Italic elements).
    Dim start As TextPointer = element.ContentStart.GetInsertionPosition(LogicalDirection.Forward)
    Dim [end] As TextPointer = element.ContentEnd.GetInsertionPosition(LogicalDirection.Backward)

    ' The element has no printable content if its first and last insertion positions are equal.
    Return start.CompareTo([end]) = 0

End Function ' End IsEmptyElement method.

Hinweise

Der Wert -1 gibt an, dass die vom aktuellen TextPointer angegebene Position der durch angegebenen Position vorangestellt wird position. Der Wert 0 gibt an, dass die angegebenen Positionen gleich sind. Ein Wert von positiver +1 gibt an, dass die vom aktuellen TextPointer angegebene Position der durch positionangegebenen Position folgt.

Weitere Informationen

• IsInSameDocument(TextPointer)