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


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

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

CodeDelegate AddDelegate(
	string Name,
	object Location,
	object Type,
	object Position,
	vsCMAccess Access = vsCMAccess.vsCMAccessDefault


Type: System.String

Required. The name of the delegate to add.

Type: System.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 fails.

Type: System.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.

Type: System.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 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.

Type: EnvDTE.vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeDelegate

A CodeDelegate object.

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.


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.

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

        // Create a new delegate.
        cm.AddDelegate("TestDelegate", projItem.Name, 
            vsCMTypeRef.vsCMTypeRefInt, -1, 
    catch (Exception ex)
Return to top