Share via


VCCodeProperty Interface

Definition

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

public interface class VCCodeProperty
public interface class VCCodeProperty
__interface VCCodeProperty
[System.Runtime.InteropServices.Guid("F4293135-38CD-4E7A-BEF3-AB4707FABF79")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeProperty
[<System.Runtime.InteropServices.Guid("F4293135-38CD-4E7A-BEF3-AB4707FABF79")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeProperty = interface
Public Interface VCCodeProperty
Attributes

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  

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.

Properties

Access

Defines the access attributes of this item.

Attributes

Gets a collection of all attributes for the object.

Children

Gets a collection of objects contained within this code construct.

CodeModel

Gets the VCCodeModel object for the project.

Collection

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

Comment

Gets or sets the comment associated with the code element.

DeclarationText

Gets or sets the declaration of the object.

DisplayName

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

DocComment

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

DTE

Gets the top-level extensibility object.

EndPoint

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

EndPointOf[vsCMPart, vsCMWhere]

Returns the end point of the object.

Extender[String]

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

ExtenderCATID

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

ExtenderNames

Returns a list of available Extenders for the object.

File

Gets the file where this object is defined.

FullName

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

Functions

Gets a collection of functions for the parent object.

Getter

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

InfoLocation

Describes the capabilities of the code model.

IsCaseSensitive

Determines if a code element is case-sensitive.

IsCodeType

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

IsInjected

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

IsReadOnly

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

IsShared

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

IsTrivial

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

IsVirtual

Sets or gets whether the property is virtual.

IsZombie

Determines if the object exists.

Kind

Returns an enumeration indicating the type of object.

Language

Gets the programming language used to author the code.

Location[vsCMWhere]

Returns the location of the object declaration.

Name

Gets or sets the name of the object.

Namespace

Gets an object defining the namespace.

Parameters

Gets a collection of parameters for this item.

Parent

Gets the immediate parent object of a given object.

Picture

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

Project

Gets the Project object associated with the object.

ProjectItem

Gets the ProjectItem object associated with the given object.

Prototype[Int32]

Returns a string holding the stub definition of this object.

Setter

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

StartPoint

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

StartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the object.

Type

Gets or sets an object representing the programmatic type.

TypeString

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

Methods

AddAttribute(String, String, Object)

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

GetEndPoint(vsCMPart)

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

GetStartPoint(vsCMPart)

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

IsSelf(Object)

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

Applies to