CodeAttributeArgument Interface

  • Article

Represents a single argument (name/value pair) in a code attribute.

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

Syntax

'Declaration
<GuidAttribute("80F4779B-835D-4873-8356-2F34A759A514")> _
Public Interface CodeAttributeArgument

[GuidAttribute("80F4779B-835D-4873-8356-2F34A759A514")]
public interface CodeAttributeArgument

[GuidAttribute(L"80F4779B-835D-4873-8356-2F34A759A514")]
public interface class CodeAttributeArgument

[<GuidAttribute("80F4779B-835D-4873-8356-2F34A759A514")>]
type CodeAttributeArgument =  interface end

public interface CodeAttributeArgument

The CodeAttributeArgument type exposes the following members.

Properties

  Name Description
Public property Children Gets the collection of child attributes for the specified code attribute argument.
Public property Collection Gets the collection containing the object that supports this property.
Public property DTE Gets the top-level extensibility object, in this case the DTE2 object.
Public property EndPoint Gets a TextPoint object defining the end of the code attribute argument.
Public property Extender Returns the Extender for the code attribute argument.
Public property ExtenderCATID Gets the category ID (CATID) for the Extender of the code attribute argument.
Public property ExtenderNames Gets the names of the Extenders for the code attribute arguments.
Public property FullName Gets the fully qualified name of the code attribute argument's definition.
Public property InfoLocation Gets a constant indicating the location of the code attribute argument.
Public property IsCodeType Gets a value indicating whether a CodeType object can be obtained from this code attribute argument.
Public property Kind Gets an enumeration value that defines the type of code element.
Public property Language Gets the programming language that is used to author the code.
Public property Name Gets or sets a string representing the name of the object.
Public property ProjectItem Gets the associated ProjectItem object.
Public property StartPoint Gets a TextPoint object defining the start of the code attribute argument.
Public property Value Sets or gets the value of an attribute argument.

Top

Methods

  Name Description
Public method Delete Removes a single argument from a code attribute.
Public method GetEndPoint Returns a TextPoint object that marks the end of the attribute argument.
Public method GetStartPoint Gets a TextPoint object that marks the start of the attribute argument.

Top

Remarks

All arguments for a code attribute are contained in the Collection property.

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

' Macro code.
Sub codeArgExample()
    Dim sel As TextSelection = _
    CType(DTE.ActiveDocument.Selection, TextSelection)
    Dim cls As CodeClass2 = CType(sel.ActivePoint. _
    CodeElement(vsCMElement.vsCMElementClass), CodeClass2)
    Dim attr As CodeAttribute2
    Dim attrArg As CodeAttributeArgument
    Dim msg As String

    ' Loop through all of the attributes in the class.
    For Each attr In cls.Attributes
        ' Loop through all of the arguments for the attribute.
        For Each attrArg In attr.Arguments
            msg += attrArg.Value & " "
        Next
    Next
    ' List the arguments for the attribute.
    MsgBox("Attribute parameters for " & attr.Name _
    & ": " & msg)
End Sub

See Also

Reference

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