VCCodeProperty Interface

 

An object representing a property code element (declared with the __property keyword).

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

[GuidAttribute("E42CEE53-0CE5-4859-ADA3-E7B28EC5F9E4")]
public interface VCCodeProperty

NameDescription
System_CAPS_pubpropertyAccess

Defines the access attributes of this item.

System_CAPS_pubpropertyAttributes

Gets a collection of all attributes for the object.

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel object for the project.

System_CAPS_pubpropertyCollection

Returns the collection containing the object supporting this property or contained within this code construct.

System_CAPS_pubpropertyComment

Gets or sets the comment associated with the code element.

System_CAPS_pubpropertyDeclarationText

Gets or sets the declaration of the object.

System_CAPS_pubpropertyDisplayName

Gets or sets the name used in the user interface for this output group.

System_CAPS_pubpropertyDocComment

Gets or sets the document comment for the current code model element.

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

System_CAPS_pubpropertyExtender[String]

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

System_CAPS_pubpropertyExtenderCATID

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

System_CAPS_pubpropertyExtenderNames

Returns a list of available Extenders for the object.

System_CAPS_pubpropertyFile

Gets the file where this object is defined.

System_CAPS_pubpropertyFullName

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

System_CAPS_pubpropertyFunctions

Gets a collection of functions for the parent object.

System_CAPS_pubpropertyGetter

Gets or sets an object defining the code to return a property.

System_CAPS_pubpropertyInfoLocation

Describes the capabilities of the code model.

System_CAPS_pubpropertyIsCaseSensitive

Determines if 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

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

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the file containing the object is read-only.

System_CAPS_pubpropertyIsShared

Sets or gets whether the IsShared flag is set on a property.

System_CAPS_pubpropertyIsTrivial

Gets or sets a value indicating whether the property is trivial.

System_CAPS_pubpropertyIsVirtual

Sets or gets whether the property is virtual.

System_CAPS_pubpropertyIsZombie

Determines if the object exists.

System_CAPS_pubpropertyKind

Returns 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 object declaration.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the namespace.

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 object associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyPrototype[Int32]

Returns a string holding the stub definition of this object.

System_CAPS_pubpropertySetter

Gets or sets an object defining the code to set a property.

System_CAPS_pubpropertyStartPoint

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

System_CAPS_pubpropertyStartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the object.

System_CAPS_pubpropertyType

Gets or sets an object representing the programmatic type.

System_CAPS_pubpropertyTypeString

Gets or sets the type of object using a string representation of the type.

NameDescription
System_CAPS_pubmethodAddAttribute(String, String, Object)

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

System_CAPS_pubmethodGetEndPoint(vsCMPart)

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

System_CAPS_pubmethodGetStartPoint(vsCMPart)

Gets 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 another code element.

The VCCodeProperty object represents a property code element in a source file and allows access to information about that specific code element.

System_CAPS_noteNote

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

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

This example retrieves all properties of the first class and displays their names in a message box.

Sub GetProperties()
    Dim vcCM As VCCodeModel
    Dim vcClass As VCCodeClass
    Dim vcProperty as VCCodeProperty
    vcCM = DTE.Solution.Item(1).CodeModel
    vcClass = vcCM.Classes.Item(1)
    For Each vcProperty in vcClass.Properties
        MsgBox(vcProperty.DisplayName)
    Next
End Sub
Return to top
Show: