CodeEvent.AddAttribute Method

Creates a new attribute code construct and inserts the code in the correct location.

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

Syntax

'Declaration
Function AddAttribute ( _
    Name As String, _
    Value As String, _
    Position As Object _
) As CodeAttribute

CodeAttribute AddAttribute(
    string Name,
    string Value,
    Object Position
)

CodeAttribute^ AddAttribute(
    String^ Name, 
    String^ Value, 
    Object^ Position
)

abstract AddAttribute : 
        Name:string * 
        Value:string * 
        Position:Object -> CodeAttribute

function AddAttribute(
    Name : String, 
    Value : String, 
    Position : Object
) : CodeAttribute

Parameters

• Name
  Type: System.String

  The name of the attribute.

• Value
  Type: System.String

  The value of the attribute, which may be a comma separated list of parameters for a parameterized property.

• Position
  Type: System.Object

  Optional. The position of the element after which to add the new element.

  If the value is zero, the new element is added at the beginning of the collection (default); if the value is -1, at the end.

Return Value

Type: EnvDTE.CodeAttribute
A CodeAttribute object.

Remarks

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

The following example demonstrates how to use the AddAttribute method.

To test this property:

1. Open the target project and select the code event element by placing the cursor on the event object.

2. Run the add-in.

public static void AddAttribute(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    codeEvent.AddAttribute("Obsolete", "\"NewAttribute\", true", 1);
    string str = "";
    foreach (CodeElement ce in codeEvent.Attributes)
        str += "\n" + ce.FullName;
    MessageBox.Show("\nAddAttribute method: " +
                    str, "Testing CodeEvent");
}

.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

CodeEvent 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#)