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

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.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 code construct and inserts the code in the correct location.

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(15)]
public EnvDTE.CodeDelegate AddDelegate (string Name, object Type, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault);

[<System.Runtime.InteropServices.DispId(15)>]
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 CodeElement, then the new element is added immediately after it.

If the value is a Long data type, then AddDelegate(String, 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.

Attributes: DispIdAttribute

Examples

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

Remarks

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.

Applies to

Condividi tramite