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

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a new delegate in the specified class.

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

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

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

Public Function AddDelegate (Name As String, 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.

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: 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: vsCMAccess

Optional. A vsCMAccess constant specifying the access type.

Returns

CodeDelegate

A CodeDelegate object.

Implements

AddDelegate(String, Object, Object, vsCMAccess)

Attributes: DispIdAttribute

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

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).

Applies to

次の方法で共有