CodeEnum.AddAttribute Method

  • Article

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

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.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

    Required. The name of the new attribute.

  • Value
    Type: System.String

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

  • 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 that 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 may be incorrect for the attribute or the language behind the code model.

Note

The values of code model elements, such as classes, structures, functions, attributes, delegates, cannot be relied upon to remain the same at all times. 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

CodeEnum Interface

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