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)

Syntax

'Declaration
<GuidAttribute("E42CEE53-0CE5-4859-ADA3-E7B28EC5F9E4")> _
Public Interface VCCodeProperty
[GuidAttribute("E42CEE53-0CE5-4859-ADA3-E7B28EC5F9E4")]
public interface VCCodeProperty
[GuidAttribute(L"E42CEE53-0CE5-4859-ADA3-E7B28EC5F9E4")]
public interface class VCCodeProperty
[<GuidAttribute("E42CEE53-0CE5-4859-ADA3-E7B28EC5F9E4")>]
type VCCodeProperty =  interface end
public interface VCCodeProperty

The VCCodeProperty type exposes the following members.

Properties

  Name Description
Public property Access Defines the access attributes of this item.
Public property Attributes Gets a collection of all attributes for the object.
Public property Children Gets a collection of objects contained within this code construct.
Public property CodeModel Gets the VCCodeModel object for the project.
Public property Collection Returns the collection containing the object supporting this property or contained within this code construct.
Public property Comment Gets or sets the comment associated with the code element.
Public property DeclarationText Gets or sets the declaration of the object.
Public property DisplayName Gets or sets the name used in the user interface for this output group.
Public property DocComment Gets or sets the document comment for the current code model element.
Public property DTE Gets the top-level extensibility object.
Public property EndPoint Gets the edit point that is the location of the end of the code item.
Public property EndPointOf Returns the end point of the object.
Public property Extender Returns the requested Extender object if it is available for this object.
Public property ExtenderCATID Returns the Extender category ID (CATID) for the object.
Public property ExtenderNames Returns a list of available Extenders for the object.
Public property File Gets the file where this object is defined.
Public property FullName Gets the full path and name of the object's file.
Public property Functions Gets a collection of functions for the parent object.
Public property Getter Gets or sets an object defining the code to return a property.
Public property InfoLocation Describes the capabilities of the code model.
Public property IsCaseSensitive Determines if a code element is case-sensitive.
Public property IsCodeType Gets a value indicating whether a CodeType object can be obtained from this object.
Public property IsInjected Gets if a code element has been injected by an attribute or macro expansion.
Public property IsReadOnly Gets a value indicating whether the file containing the object is read-only.
Public property IsShared Sets or gets whether the IsShared flag is set on a property.
Public property IsTrivial Gets or sets a value indicating whether the property is trivial.
Public property IsVirtual Sets or gets whether the property is virtual.
Public property IsZombie Determines if the object exists.
Public property Kind Returns an enumeration indicating the type of object.
Public property Language Gets the programming language used to author the code.
Public property Location Returns the location of the object declaration.
Public property Name Gets or sets the name of the object.
Public property Namespace Gets an object defining the namespace.
Public property Parameters Gets a collection of parameters for this item.
Public property Parent Gets the immediate parent object of a given object.
Public property Picture Gets a picture automation object to be used as an icon in the user interface.
Public property Project Gets the Project object associated with the object.
Public property ProjectItem Gets the ProjectItem object associated with the given object.
Public property Prototype Returns a string holding the stub definition of this object.
Public property Setter Gets or sets an object defining the code to set a property.
Public property StartPoint Gets a TextPoint object that defines the beginning of the code item.
Public property StartPointOf Gets the start point of the object.
Public property Type Gets or sets an object representing the programmatic type.
Public property TypeString Gets or sets the type of object using a string representation of the type.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method GetEndPoint Gets a TextPoint object that marks the end of the code element definition.
Public method GetStartPoint Gets a TextPoint object that defines the beginning of the code element definition.
Public method IsSelf Determines if the specified code element is the same as another code element.

Top

Remarks

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

Note

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.

Examples

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

See Also

Reference

Microsoft.VisualStudio.VCCodeModel Namespace