Export (0) Print
Expand All

CodeModel.AddClass Method

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

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

CodeClass AddClass(
	string Name,
	Object Location,
	Object Position,
	Object Bases,
	Object ImplementedInterfaces,
	vsCMAccess Access
)

Parameters

Name
Type: System.String

Required. The name of the class.

Location
Type: System.Object

Required. The path and file name for the new class 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 AddClass fails.

Position
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 AddClass 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 that the element should be placed at the end.

Bases
Type: System.Object

Required. Default = 0. A SafeArray of fully qualified type names or CodeClass objects from which the new class inherits its implementations.

ImplementedInterfaces
Type: System.Object

Required. Default = 0. A SafeArray of fully qualified type names or CodeInterface objects, each representing an interface that the new class promises to implement.

Access
Type: EnvDTE.vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeClass
A CodeClass object.

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

NoteNote

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

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

        // Initialize the base classes array and the implemented 
        // interfaces array.
        object[] bases = {ConvertFullName(cm, "System.Object")};
        object[] interfaces = {
            ConvertFullName(cm, "System.IDisposable"),
            ConvertFullName(cm, "System.IComparable")
        };

        // Create a new class.
        cm.AddClass("TestClass", projItem.Name, -1, bases, 
            interfaces, vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

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(".", "::");
    else
        return fullName;
}

Show:
© 2014 Microsoft