Compartilhar via


VCCodeElement Interface

Definition

An object providing access to any code element within a source file.

public interface class VCCodeElement
public interface class VCCodeElement
__interface VCCodeElement
[System.Runtime.InteropServices.Guid("46AB500A-F64B-4BA3-B5F4-102E7FEC2412")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeElement
[<System.Runtime.InteropServices.Guid("46AB500A-F64B-4BA3-B5F4-102E7FEC2412")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeElement = interface
Public Interface VCCodeElement
Attributes

Examples

This example assigns a newly added class to a VCCodeElement object.

Sub GetVCCodeElement()  
    Dim vcCM As VCCodeModel  
    Dim vcCodeElement As VCCodeElement  
    vcCM = DTE.Solution.Item(1).CodeModel  
    vcCodeElement = vcCM.AddClass("MyClass", "MyClass.h")  
End Sub  

Remarks

The VCCodeElement object provides code model functionality to existing Visual C++ integrated development environment (IDE) solutions at the code element level. Primarily, this object is used to find and modify any code element (class declaration, identifier, function definition, and so on) accessible within a source file.

Note

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

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

Properties

Attributes

Gets a collection of all of the attributes for the parent object.

Children

Gets a collection of objects contained within this code construct.

CodeModel

Gets the VCCodeModel object for the project.

Collection

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

DisplayName

Gets the display name of the VCCodeElement object.

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

Extender[String]

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

ExtenderCATID

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

ExtenderNames

Gets a list of available Extenders for the object.

File

Gets the file associated with this VCCodeElement object.

FullName

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

InfoLocation

Describes the capabilities of the code model.

IsCaseSensitive

Gets a value indicating whether a code element is case-sensitive.

IsCodeType

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

IsInjected

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

IsReadOnly

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

IsZombie

Gets a value indicating whether the VCCodeElement object exists.

Kind

Gets an enumeration indicating the type of object.

Language

Gets the programming language used to author the code.

Location[vsCMWhere]

Gets the location of the parent object declaration.

Name

Gets or sets the name of the object.

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.

References

Not currently implemented.

StartPoint

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

StartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the parent object.

Methods

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