CodeClass2.AddAttribute(String, String, Object) Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Creates a new attribute code construct and inserts the class 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 of parameters for a parameterized property, separated by commas.

Position

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 Position 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

[Visual Basic]

Sub AddAttributeExample(ByVal dte As DTE2)  
    ' Before running this example, open a code document from a project  
    ' and place the insertion point inside a class definition.  
    Try  
        ' Retrieve the CodeClass at the insertion point.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim cls As CodeClass = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementClass), CodeClass)  

        ' Add an attribute to the class.  
        cls.AddAttribute("TestAttribute", "TestValue")  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  
End Sub  

[C#]

 public void AddAttributeExample(DTE2 dte)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point inside a class definition.  
    try  
    {  
        // Retrieve the CodeClass at the insertion point.  
        TextSelection sel =   
            (TextSelection)dte.ActiveDocument.Selection;  
        CodeClass cls =   
            (CodeClass)sel.ActivePoint.get_CodeElement(  
             vsCMElement.vsCMElementClass);  

        // Add an attribute to the class.  
        cls.AddAttribute("TestAttribute", "TestValue", -1);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

If the attribute already exists, the AddAttribute method 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).