CodeDelegate2::AddAttribute Method (String^, String^, Object^)
Creates a new attribute code construct and inserts the code in the correct location.
Assembly: EnvDTE80 (in EnvDTE80.dll)
Parameters
- Name
-
Type:
System::String^
Required. The name of the new attribute.
- Value
-
Type:
System::String^
Required. The value of the attribute, which may be a list, separated by commas, of parameters for a property that has parameters.
- Position
-
Type:
System::Object^
Optional. Default = 0. The code element after which to add the new element.
If Value is a Long data type, then AddAttribute 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.
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). |
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
