CodeClass2.AddDelegate Method

Creates a new delegate in the specified class.

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

Syntax

'Declaration
Function AddDelegate ( _
    Name As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess _
) As CodeDelegate

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

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

abstract AddDelegate : 
        Name:string * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess -> CodeDelegate

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

Parameters

• Name
  Type: String

  Required. The name of the delegate to add.

• Type
  Type: Object

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

• Position
  Type: Object

  Optional. Default = 0. The code element after which to add the new element.

  If the value is a Long data type, then Position 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
  Type: EnvDTE.vsCMAccess

  Optional. A vsCMAccess constant specifying the access type.

Return Value

Type: EnvDTE.CodeDelegate
A CodeDelegate object.

Remarks

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages use 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. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Examples

[C#]

public void CodeClass2AddDelegateExample(DTE2 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.
        TextSelection sel =
            TextSelection)dte2.ActiveDocument.Selection;
        CodeClass cls =
            (CodeClass)sel.ActivePoint.get_CodeElement(
             vsCMElement.vsCMElementClass);

        object pos = -1; // Place class at end of members collection
        // Add delegate.
        CodeDelegate cdel = cls.AddDelegate("TestDelegate",
            vsCMTypeRef.vsCMTypeRefBool,
            pos, vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CodeClass2 Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)