CodeClass2.GetStartPoint メソッド (vsCMPart)

[アーティクル]
08/09/2011

クラスの先頭を定義する TextPoint オブジェクトを取得します。

名前空間: EnvDTE80
アセンブリ: EnvDTE80 (EnvDTE80.dll 内)

構文

'宣言
Function GetStartPoint ( _
    Part As vsCMPart _
) As TextPoint

TextPoint GetStartPoint(
    vsCMPart Part
)

TextPoint^ GetStartPoint(
    [InAttribute] vsCMPart Part
)

abstract GetStartPoint : 
        Part:vsCMPart -> TextPoint

function GetStartPoint(
    Part : vsCMPart
) : TextPoint

パラメーター

Part
型: EnvDTE.vsCMPart
省略可能です。取得するクラスの部分を指定する vsCMPart 定数です。

戻り値

型: EnvDTE.TextPoint
TextPoint オブジェクト。

実装

CodeClass.GetStartPoint(vsCMPart)

解説

GetStartPoint メソッドと GetEndPoint メソッドは、指定されたコード要素定義の先頭および末尾を表す TextPoint オブジェクトを返します。 Part パラメーターは、取り出すコード要素定義を定義します。

注意

特定の種類の編集を行うと、クラス、構造体、関数、属性、デリゲートなどのコードモデル要素が非確定的な値になる場合があります。つまり、これらの要素の値は、常に同じ値になるとは限りません。詳細については、「コードモデルを使用したコードの調査 (Visual Basic)」で、コードモデル要素値を変更する方法についての説明を参照してください。

例

[Visual Basic]

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

[C#]

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