CodeModel2.AddAttribute Method

  • Article

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, _
    Location As Object, _
    Value As String, _
    Position As Object _
) As CodeAttribute

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

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

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

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

Parameters

  • Name
    Type: System.String

    Required. The name of the new attribute.

  • Location
    Type: System.Object

    Required. The path and file name for the new attribute. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddAttribute fails.

  • Value
    Type: System.String

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

  • Position
    Type: System.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 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.

Return Value

Type: EnvDTE.CodeAttribute
A CodeAttribute object.

Remarks

If the attribute already exists, AddAttribute adds another. This might 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).

.NET Framework Security

See Also

Reference

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