CodeDelegate2.AddAttribute(String, String, Object) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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

EnvDTE::CodeAttribute AddAttribute(std::wstring const & Name, std::wstring const & Value, winrt::Windows::Foundation::IInspectable const & Position);

[System.Runtime.InteropServices.DispId(40)]
public EnvDTE.CodeAttribute AddAttribute (string Name, string Value, object Position);

[<System.Runtime.InteropServices.DispId(40)>]
abstract member AddAttribute : string * string * obj -> EnvDTE.CodeAttribute

Public Function AddAttribute (Name As String, Value As String, Optional Position As Object) As CodeAttribute

Parameters

Name: String

Required. The name of the new attribute.

Value: String

Required. The value of the attribute, which may be a list, separated by commas, of parameters for a property that has parameters.

Position: Object

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

If Value is a Long data type, then AddAttribute(String, String, Object) 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.

Returns

CodeAttribute

A CodeAttribute object.

Implements

AddAttribute(String, String, Object)

Attributes: DispIdAttribute

Examples

Before running this example, load a project with a class and insert the following line along with the example code. After both the line and the example code are added, click the Delegate line to place the insertion point there, and then run the example.

[VisualBasic]

Delegate Sub MySubDelegate(ByVal x As Integer)

[C#]

public delegate void MySubDelegate(int x);

[VisualBasic]

Public Sub addDelegateAttribExample(ByVal dte As DTE2)  
    Try  
        ' Retrieve the CodeClass at the insertion point.  
        Dim sel As TextSelection = _  
          CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim del As CodeDelegate2 = _  
          CType(sel.ActivePoint.CodeElement( _  
        vsCMElement.vsCMElementDelegate), CodeDelegate2)  

        ' Add a new attribute to the delegate.  
        del.AddAttribute("someNewAttribute", "someValue", -1)  
    Catch ex As System.Exception  
        MsgBox(ex.ToString)  
    End Try  
End Sub

Remarks

If the attribute already exists, AddAttribute adds another. This may be incorrect for the attribute or 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

共用方式為