CodeModel2.AddDelegate(String, Object, Object, Object, vsCMAccess) Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Creates a new delegate code construct and inserts the code in the correct location.

EnvDTE::CodeDelegate AddDelegate(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, winrt::Windows::Foundation::IInspectable const & Type, winrt::Windows::Foundation::IInspectable const & Position, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[System.Runtime.InteropServices.DispId(13)]
public EnvDTE.CodeDelegate AddDelegate (string Name, object Location, object Type, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[<System.Runtime.InteropServices.DispId(13)>]
abstract member AddDelegate : string * obj * obj * obj * EnvDTE.vsCMAccess -> EnvDTE.CodeDelegate

Public Function AddDelegate (Name As String, Location As Object, Type As Object, Optional Position As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault) As CodeDelegate

Parameters

Name

String

Required. The name of the delegate to add.

Location

Object

Required. The path and file name for the new delegate definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddDelegate(String, Object, Object, Object, vsCMAccess) fails.

Type

Object

Required. A vsCMTypeRef constant indicating the data type that the function returns. This value can be a CodeTypeRef object, a vsCMTypeRef constant, or a fully qualified type name.

Position

Object

Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

If the value is a Long data type, then AddDelegate(String, Object, Object, Object, vsCMAccess) indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Access

vsCMAccess

Optional. A vsCMAccess constant.

Returns

CodeDelegate

A CodeDelegate object.

Implements

AddDelegate(String, Object, Object, Object, vsCMAccess)

Attributes

DispIdAttribute

Examples

Sub AddDelegateExample2(ByVal dte As DTE2)  

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

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

End Sub  

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

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

Remarks

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

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.