CodeModel Interface

Allows access to programmatic constructs in a source code file.

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

Syntax

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

The CodeModel type exposes the following members.

Properties

  Name Description
Public property CodeElements Gets a collection of CodeElements.
Public property DTE Gets the top-level extensibility object.
Public property IsCaseSensitive Gets whether the current language is case-sensitive.
Public property Language Gets the programming language used to author the code.
Public property Parent Gets the immediate parent object of a CodeModel object.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method AddClass Creates a new class code construct and inserts the code in the correct location.
Public method AddDelegate Creates a new delegate code construct and inserts the code in the correct location.
Public method AddEnum Creates a new enumeration code construct and inserts the code in the correct location.
Public method AddFunction Creates a new function code construct and inserts the code in the correct location.
Public method AddInterface Creates a new interface code construct and inserts the code in the correct location.
Public method AddNamespace Creates a new namespace code construct and inserts the code in the correct location.
Public method AddStruct Creates a new structure code construct and inserts the code in the correct location.
Public method AddVariable Creates a new variable code construct and inserts the code in the correct location.
Public method CodeTypeFromFullName Returns a code element based on a fully qualified name.
Public method CreateCodeTypeRef Returns a CodeTypeRef object based on the data type indicator passed.
Public method IsValidID Returns whether a specified name is a valid programmatic identifier for the current language.
Public method Remove Removes the specified code element from the source file.

Top

Remarks

The CodeModel object provides code model functionality to languages at the project level, but some members of this object are not supported in every language in Visual Studio.

The primary functions of the CodeModel object are to enable users to find any code element accessible within a project given a fully qualified name, and to determine the programming language in which the project is written.

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

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#)