CompareTo Method

Compares positions of this C1TextPointer with another C1TextPointer.

Syntax

Visual Basic
C#

'Declaration
 
Public Function CompareTo( _
   ByVal other As C1TextPointer _
) As System.Integer

'Usage
 
Dim instance As C1TextPointer
Dim other As C1TextPointer
Dim value As System.Integer
 
value = instance.CompareTo(other)

public System.int CompareTo( 
   C1TextPointer other
)

Parameters

other: The C1TextPointer to compare with.

Return Value

Less than zero: this C1TextPointer precedes position. Zero: this C1TextPointer is at the same location as position. Greater than zero: this C1TextPointer follows position.

Exceptions

Exception	Description
System.ArgumentException	Throws ArgumentException if position does not belong to the same text container as this C1TextPointer.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

C1TextPointer Class
C1TextPointer Members