FileCodeModel2.AddDelegate メソッド (String, Object, Object, vsCMAccess)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

新しいデリゲートコード構成を作成し、適切な位置にコードを挿入します。

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

構文

'宣言
Function AddDelegate ( _
    Name As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess _
) As CodeDelegate
'使用
Dim instance As FileCodeModel2
Dim Name As String
Dim Type As Object
Dim Position As Object
Dim Access As vsCMAccess
Dim returnValue As CodeDelegate

returnValue = instance.AddDelegate(Name, _
    Type, Position, Access)

CodeDelegate AddDelegate(
    string Name,
    Object Type,
    Object Position,
    vsCMAccess Access
)

CodeDelegate^ AddDelegate(
    String^ Name, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access
)

function AddDelegate(
    Name : String, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess
) : CodeDelegate

パラメータ

Name
型 : System.String

必ず指定します。追加するデリゲートの名前。

Type
型 : System.Object

必ず指定します。関数で返されるデータ型を示す vsCMTypeRef 定数。CodeTypeRef オブジェクト、vsCMTypeRef 定数、または完全修飾型名のいずれかになります。

Position
型 : System.Object

省略可能です。既定では 0 が指定されます。ここで指定したコード要素の後に、新しい要素を追加します。値が CodeElement の場合は、その値の直後に新しい要素が追加されます。

値が Long 型の場合、AddDelegate は、後ろに新しい要素が追加される要素を示します。

コレクションのカウントは 1 から始まるため、0 を指定すると新しい要素がコレクションの最初に配置されます。値 -1 は要素を末尾に配置することを示します。

Access
型 : EnvDTE.vsCMAccess

省略可能です。vsCMAccess 定数。

戻り値

型 : EnvDTE.CodeDelegate

CodeDelegate オブジェクトを返します。

実装

FileCodeModel.AddDelegate(String, Object, Object, vsCMAccess)

解説

Visual C++ では、コロン区切り (::) の形式で完全修飾型名を指定する必要があります。他のすべての言語では、ピリオド区切りの書式がサポートされます。

引数が正しいかどうかは、コードモデルの背後にある言語によって決まります。

例

Sub AddDelegateExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem

        ' Create a new delegate.
        projItem.FileCodeModel.AddDelegate("TestDelegate", _
            vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddDelegateExample(DTE2 dte)
{
    // Before running this example, open a code document from 
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;

        // Create a new delegate.
        projItem.FileCodeModel.AddDelegate("TestDelegate", 
            vsCMTypeRef.vsCMTypeRefInt, -1, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}