CodeModel2.AddInterface Method (String, Object, Object, Object, vsCMAccess)


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

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

CodeInterface AddInterface(
	string Name,
	object Location,
	object Position,
	object Bases,
	vsCMAccess Access = vsCMAccess.vsCMAccessDefault


Type: System.String

Required. The name of the interface to add.

Type: System.Object

Required. The path and file name for the new interface definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddInterface fails.

Type: System.Object

Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

If the value is a Long data type, then AddInterface indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Type: System.Object

Optional. Default value is Nothing or null. A variant that holds a SafeArray of fully qualified type names or CodeInterface objects from which the new interface derives.

Type: EnvDTE.vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeInterface

A CodeInterface object.

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.


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.

public void AddInterfaceExample(DTE2 dte)
    // Before running this example, open a code document from
    // a project.
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

        // Initialize the base interfaces array.
        object[] bases = {
        ConvertFullName(cm, "System.IDisposable"), 
        ConvertFullName(cm, "System.IComparable")

        // Create a new class.
        cm.AddInterface("TestInterface", projItem.Name, -1, bases, 
    catch (Exception ex)

string ConvertFullName(CodeModel cm, string fullName)
    // Convert a .NET type name into a C++ type name.
    if ((cm.Language == CodeModelLanguageConstants.vsCMLanguageVC) || 
        (cm.Language == CodeModelLanguageConstants.vsCMLanguageMC))
        return fullName.Replace(".", "::");
        return fullName;
Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft