다음을 통해 공유


CodeClass.GetStartPoint(vsCMPart) Method

Definition

Returns a TextPoint object that defines the beginning of the code element definition.

EnvDTE::TextPoint GetStartPoint(EnvDTE::vsCMPart Part = EnvDTE.vsCMPart.vsCMPartWholeWithAttributes);
[System.Runtime.InteropServices.DispId(15)]
[System.Runtime.InteropServices.TypeLibFunc(1024)]
public EnvDTE.TextPoint GetStartPoint (EnvDTE.vsCMPart Part = EnvDTE.vsCMPart.vsCMPartWholeWithAttributes);
[<System.Runtime.InteropServices.DispId(15)>]
[<System.Runtime.InteropServices.TypeLibFunc(1024)>]
abstract member GetStartPoint : EnvDTE.vsCMPart -> EnvDTE.TextPoint
Public Function GetStartPoint (Optional Part As vsCMPart = EnvDTE.vsCMPart.vsCMPartWholeWithAttributes) As TextPoint

Parameters

Part
vsCMPart

Optional. A vsCMPart constant specifying the portion of the code to retrieve.

Returns

A TextPoint object.

Attributes

Examples

 Sub GetStartPointExample(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)  

        ' Display 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  
public void GetStartPointExample(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);  

        // Display 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);  
    }  
}  

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).

Applies to