Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CompareTo Method

TextPointer.CompareTo Method

Performs an ordinal comparison between the positions specified by the current TextPointer and a second specified TextPointer.

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

'Declaration
Public Function CompareTo ( _
	position As TextPointer _
) As Integer

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.

ExceptionCondition
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



Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show:
© 2015 Microsoft