VCCodeAttribute Interface

 

Provides access to an item attribute.

Namespace:   Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

[GuidAttribute("FAB696AD-E470-4AB2-BC96-6C74C8F8196A")]
public interface VCCodeAttribute

NameDescription
System_CAPS_pubpropertyChildren

Gets a collection of child code elements of the specified attribute.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel object for the project.

System_CAPS_pubpropertyCollection

Gets the collection containing the code element supporting this attribute.

System_CAPS_pubpropertyDisplayName

Gets the full name of the attribute.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyEndPoint

Gets the edit point that is the location of the end of the code item.

System_CAPS_pubpropertyEndPointOf[vsCMPart, vsCMWhere]

Returns the end point of the parent object.

System_CAPS_pubpropertyExtender[String]

Gets the requested Extender object if it is available for this object.

System_CAPS_pubpropertyExtenderCATID

Gets the Extender category ID (CATID) for the object.

System_CAPS_pubpropertyExtenderNames

Gets a list of available Extenders for the object.

System_CAPS_pubpropertyFile

Gets the file in which the parent object is declared.

System_CAPS_pubpropertyFullName

Gets the full path and name of the object's file.

System_CAPS_pubpropertyIndex

Gets the position of an attribute in the attribute block.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

System_CAPS_pubpropertyIsCaseSensitive

Gets whether a code element is case-sensitive.

System_CAPS_pubpropertyIsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

System_CAPS_pubpropertyIsInjected

Determines if a code element has been injected by an attribute or macro expansion.

System_CAPS_pubpropertyIsReadOnly

Gets whether the file containing the parent object is read-only.

System_CAPS_pubpropertyIsZombie

Gets whether the parent object exists.

System_CAPS_pubpropertyKind

Gets an enumeration indicating the type of object.

System_CAPS_pubpropertyLanguage

Gets the programming language used to author the code.

System_CAPS_pubpropertyLocation[vsCMWhere]

Returns the location of the parent object declaration.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyParameters

Gets a collection of parameters for this item.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyPicture

Gets a picture automation object to be used as an icon in the user interface.

System_CAPS_pubpropertyProject

Gets the Project associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem associated with the given object.

System_CAPS_pubpropertyStartPoint

Gets a TextPoint object that defines the beginning of the code item.

System_CAPS_pubpropertyStartPointOf[vsCMPart, vsCMWhere]

Returns the start point of the parent object.

System_CAPS_pubpropertyValue

Gets or sets the data for the object.

NameDescription
System_CAPS_pubmethodAddParameter(String, String, Object)

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

System_CAPS_pubmethodDelete()

Removes the attribute.

System_CAPS_pubmethodGetEndPoint(vsCMPart)

Returns a TextPoint object that marks the end of the code element definition.

System_CAPS_pubmethodGetStartPoint(vsCMPart)

Returns a TextPoint object that defines the beginning of the code element definition.

System_CAPS_pubmethodIsSelf(Object)

Determines if the specified code element is the same as the parent code element.

System_CAPS_pubmethodRemoveParameter(Object)

Removes a parameter from the argument list.

The VCCodeAttribute object represents either a CLR or COM metadata attribute associated with a code element. You can add new parameters to the attribute with the AddParameter method and get and set the value of a code attribute with the VCCodeAttribute object.

System_CAPS_noteNote

A large part of the functionality of this object is provided by the Visual Studio VCCodeAttribute object. For more information, see CodeAttribute object.

This example displays the names of all attributes applied to the ATLProjectLib library. It is assumed that the ATLProjectLib library exists.

Sub GetAttributes()
    Dim vcCM As VCCodeModel
    Dim vcLibrary As VCCodeIDLLibrary
    Dim vcAttribute As VCCodeAttribute
    Dim i As Integer
    vcCM = DTE.Solution.Item(1).CodeModel
    vcLibrary = vcCM.IDLLibraries.Find("ATLProjectLib")
    For i = 1 To vcLibrary.Attributes.Count
        vcAttribute = vcLibrary.Attributes.Item(i)
        MsgBox(vcAttribute.DisplayName)
    Next
End Sub

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

Return to top
Show: