TextPointer.CompareTo Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Performs an ordinal comparison between the positions specified by the current TextPointer and a second specified TextPointer.
Assembly: System.Windows (in System.Windows.dll)
Parameters
- position
- Type: System.Windows.Documents.TextPointer
A TextPointer that specifies a position to compare to the current position.
Return Value
Type: System.Int32-1 if the current TextPointer precedes position; 0 if the locations are the same; +1 if the current TextPointer follows positions.
| Exception | Condition |
|---|---|
| ArgumentException | position specifies a position from a different RichTextBox associated with the current position. |
The following code uses the CompareTo method to find out if the RichTextBox is empty. This code example is part of a larger example used in the TextPointer class.
'This method returns true if the RichTextBox is empty.
Public Function isRichTextBoxEmpty() As Boolean
Dim startPointer As TextPointer = MyRTB1.ContentStart.GetNextInsertionPosition(LogicalDirection.Forward)
Dim endPointer As TextPointer = MyRTB1.ContentEnd.GetNextInsertionPosition(LogicalDirection.Backward)
If (startPointer.CompareTo(endPointer) = 0) Then
Return True
Else
Return False
End If
End Function