CodeClass2.Attributes Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets a collection of all of the attributes for the code class.

public:
 property EnvDTE::CodeElements ^ Attributes { EnvDTE::CodeElements ^ get(); };

[System.Runtime.InteropServices.DispId(36)]
public EnvDTE.CodeElements Attributes { [System.Runtime.InteropServices.DispId(36)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(36)>]
[<get: System.Runtime.InteropServices.DispId(36)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Attributes : EnvDTE.CodeElements

Public ReadOnly Property Attributes As CodeElements

Property Value

CodeElements

A CodeElements collection.

Implements

Attributes

Attributes

DispIdAttribute TypeLibFuncAttribute

Examples

[Visual Basic]

Sub AttributesExample(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 CodeClass2 = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementClass), CodeClass2)  

        ' Enumerate the CodeClass's attributes.  
        Dim attrs As String = ""  
        Dim attr As CodeAttribute2  
        For Each attr In cls.Attributes  
            attrs &= attr.Name & "(" & attr.Value & ")" & vbCrLf  
        Next  
        MsgBox(cls.Name & " has the following attributes:" & _  
            vbCrLf & vbCrLf & attrs)  
    Catch ex As System.Exception  
        MsgBox(ex.Message)  
    End Try  
End Sub  

[C#]

public void AttributesExample(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;  
        CodeClass2 cls =   
            (CodeClass2)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementClass);  

        // Enumerate the CodeClass's attributes.  
        string attrs = "";  
        foreach (CodeAttribute2 attr in cls.Attributes)  
        {  
            attrs += attr.Name + "(" + attr.Value + ")" + "\r\n";  
        }  

        MessageBox.Show(cls.Name + " has the following attributes:" +   
            "\r\n\r\n" + attrs);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

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).