Share via

CodeClass2.EndPoint Property

  • Article

Gets the edit point that is the location of the end of the code class.

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

Syntax

'Declaration
ReadOnly Property EndPoint As TextPoint

TextPoint EndPoint { get; }

property TextPoint^ EndPoint {
    TextPoint^ get ();
}

abstract EndPoint : TextPoint with get

function get EndPoint () : TextPoint

Property Value

Type: EnvDTE.TextPoint
A TextPoint object.

Remarks

The edit point location is immediately after the last character of the code element (including any semicolon, terminating syntax, or separating syntax). Fetching the property implicitly opens the source file if it can be opened. Some languages, however, cannot open arbitrary files on the disk and can only open files in a currently open solution.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Examples

[Visual Basic]

Sub EndPointExample2(ByVal dte As DTE2)
    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)
        Dim start As EditPoint = cls.StartPoint.CreateEditPoint()
        Dim def As String = start.GetText(cls.EndPoint)

        MsgBox(cls.Name & " has the following definition:" & _
            vbCrLf & vbCrLf & def)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

[C#]

public void EndPointExample2(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        EditPoint start = cls.StartPoint.CreateEditPoint();
        string def = start.GetText(cls.EndPoint);

        MessageBox.Show(cls.Name + 
            " has the following definition:\n\n" + def);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

See Also

Reference

CodeClass2 Interface

EnvDTE80 Namespace

Other Resources

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

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)