Share via

CodeClass2.GetEndPoint Method

  • Article

Gets a TextPoint object that marks the end of the class.

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

Syntax

'Declaration
Function GetEndPoint ( _
    Part As vsCMPart _
) As TextPoint

TextPoint GetEndPoint(
    vsCMPart Part
)

TextPoint^ GetEndPoint(
    [InAttribute] vsCMPart Part
)

abstract GetEndPoint : 
        Part:vsCMPart -> TextPoint

function GetEndPoint(
    Part : vsCMPart
) : TextPoint

Parameters

Return Value

Type: EnvDTE.TextPoint
A TextPoint object.

Remarks

The GetStartPoint and GetEndPoint methods return a TextPoint object that represents the beginning and end of a specified code element definition. The Part parameter defines the code element definition to return.

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 GetEndPointExample(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)

        ' Get the source code for the class.
        Dim start As TextPoint = cls.GetStartPoint()
        Dim finish As TextPoint = cls.GetEndPoint()
        Dim src As String = start.CreateEditPoint().GetText(finish)

        MsgBox(cls.Name & "'s source code:" & vbCrLf & vbCrLf & src)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

[C#]

public void GetEndPointExample(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);

        // Get the source code for the class.
        TextPoint start = cls.GetStartPoint(vsCMPart.vsCMPartWhole);
        TextPoint finish = cls.GetEndPoint(vsCMPart.vsCMPartWhole);
        string src = start.CreateEditPoint().GetText(finish);

        MessageBox.Show(cls.Name + "'s source code:" + 
            Environment.NewLine + Environment.NewLine + src);
    }
    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#)