CodeElement Interface

Represents a code element or construct in a source file.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
<GuidAttribute("0CFBC2B6-0D4E-11D3-8997-00C04F688DDE")> _
Public Interface CodeElement
[GuidAttribute("0CFBC2B6-0D4E-11D3-8997-00C04F688DDE")]
public interface CodeElement
[GuidAttribute(L"0CFBC2B6-0D4E-11D3-8997-00C04F688DDE")]
public interface class CodeElement
[<GuidAttribute("0CFBC2B6-0D4E-11D3-8997-00C04F688DDE")>]
type CodeElement =  interface end
public interface CodeElement

The CodeElement type exposes the following members.

Properties

  Name Description
Public property Children Returns a collection of objects contained within this CodeElement.
Public property Collection Gets the CodeElements collection containing the CodeElement that supports this property.
Public property DTE Gets the top-level extensibility object.
Public property EndPoint Gets the text point that is the location of the end of the code item.
Public property Extender Gets the requested Extender if it is available for this CodeElement object.
Public property ExtenderCATID Gets the Extender category ID (CATID) for the object.
Public property ExtenderNames Gets a list of available Extenders for the object.
Public property FullName Gets a fully-qualified name of the specified code element.
Public property InfoLocation Gets the capabilities of the code model.
Public property IsCodeType Indicates whether or not a CodeType object can be obtained from the CodeElement object.
Public property Kind Gets an enumeration that defines the type of object.
Public property Language Gets the programming language that is used to author the code.
Public property Name Sets or gets the name of the object.
Public property ProjectItem Gets the ProjectItem object associated with the CodeElement object.
Public property StartPoint Gets a TextPoint object that defines the beginning of the code item.

Top

Methods

  Name Description
Public method GetEndPoint Returns a TextPoint object that marks the end of the code element definition.
Public method GetStartPoint Returns a TextPoint object that marks the beginning of the code element definition.

Top

Remarks

A code element can be any fragment of code, but generally, there is a CodeElement object for each definition or declarative syntax in a language. This means that for most top-level definitions or declarations in a file, or for any syntactic form in a class definition, and so forth, there is a corresponding CodeElement object.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

See Also

Reference

EnvDTE Namespace

CodeElements

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)