EditPoint.EqualTo Method

  • Article

Returns a value indicating whether the value of the given point object's AbsoluteCharOffset is equal to that of the calling EditPoint object.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Function EqualTo ( _
    Point As TextPoint _
) As Boolean

bool EqualTo(
    TextPoint Point
)

bool EqualTo(
    [InAttribute] TextPoint^ Point
)

abstract EqualTo : 
        Point:TextPoint -> bool 

function EqualTo(
    Point : TextPoint
) : boolean

Parameters

Return Value

Type: System.Boolean
true if Point has the same AbsoluteCharOffset property value as the calling EditPoint point object; otherwise, false.

Implements

TextPoint.EqualTo(TextPoint)

Remarks

EqualTo throws a ArgumentException exception if Point is not in the same document as the calling point object. With the VirtualPoint, EqualTo compares the virtual positions if the argument is a VirtualPoint. Otherwise, it compares the "physical" positions.

Examples

Sub EqualToExample(ByVal dte As DTE2)

    ' Create a new text file.
    dte.ItemOperations.NewFile()
    Dim txtDoc As TextDocument = _
        CType(dte.ActiveDocument.Object(), TextDocument)

    ' Create an edit point at the empty text document's StartPoint 
    ' and EndPoint; CompareEditPoints displays "point1 and point2
    ' occupy the same location."
    Dim point1 As EditPoint = txtDoc.StartPoint.CreateEditPoint()
    Dim point2 As EditPoint = txtDoc.EndPoint.CreateEditPoint()
    CompareEditPoints(point1, point2)

    ' Insert ten lines of text.
    Dim i As Integer
    For i = 1 To 10
        point1.Insert("Line " & i.ToString() & vbCrLf)
    Next

    ' Create an edit point at the text document's StartPoint and 
    ' EndPoint; CompareEditPoints displays "point1 comes before
    ' point2."
    point1 = txtDoc.StartPoint.CreateEditPoint()
    point2 = txtDoc.EndPoint.CreateEditPoint()
    CompareEditPoints(point1, point2)

End Sub

Sub CompareEditPoints(ByVal point1 As EditPoint, _
    ByVal point2 As EditPoint)

    If point1.LessThan(point2) Then
        MsgBox("point1 comes before point2.")
    ElseIf point1.GreaterThan(point2) Then
        MsgBox("point2 comes before point1.")
    ElseIf (point1.EqualTo(point2)) Then
        MsgBox("point1 and point2 occupy the same location.")
    End If

End Sub

public void EqualToExample(DTE2 dte)
{

    // Create a new text file.
    dte.ItemOperations.NewFile(@"General\Text File", "", 
        Constants.vsViewKindPrimary);
    TextDocument txtDoc = 
        (TextDocument)dte.ActiveDocument.Object("TextDocument");

    // Create an edit point at the empty text document's StartPoint 
    // and EndPoint; CompareEditPoints displays "point1 and point2
    // occupy the same location."
    EditPoint point1 = txtDoc.StartPoint.CreateEditPoint();
    EditPoint point2 = txtDoc.EndPoint.CreateEditPoint();
    CompareEditPoints(point1, point2);

    // Insert ten lines of text.
    for (int i = 1; i <= 10; i++)
        point1.Insert("Line " + i.ToString() + "\r\n");

    // Create an edit point at the text document's StartPoint and 
    // EndPoint; CompareEditPoints displays "point1 comes before 
    // point2."
    point1 = txtDoc.StartPoint.CreateEditPoint();
    point2 = txtDoc.EndPoint.CreateEditPoint();
    CompareEditPoints(point1, point2);
}

public void CompareEditPoints(EditPoint point1, EditPoint point2)
{
    if (point1.LessThan(point2))
        MessageBox.Show("point1 comes before point2.");
    else if (point1.GreaterThan(point2))
        MessageBox.Show("point2 comes before point1.");
    else if (point1.EqualTo(point2))
        MessageBox.Show("point1 and point2 occupy the same location.");
}

.NET Framework Security

See Also

Reference

EditPoint Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples