VCCodeModel.AddClass Method

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

Namespace:  Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

'Declaration
Function AddClass ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    ImplementedInterfaces As Object, _
    Access As vsCMAccess _
) As CodeClass
CodeClass AddClass(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    Object ImplementedInterfaces,
    vsCMAccess Access
)
CodeClass^ AddClass(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    Object^ ImplementedInterfaces, 
    vsCMAccess Access
)
abstract AddClass : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Bases:Object * 
        ImplementedInterfaces:Object * 
        Access:vsCMAccess -> CodeClass
function AddClass(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    ImplementedInterfaces : Object, 
    Access : vsCMAccess
) : CodeClass

Parameters

  • Name
    Type: String

    Required. The name of the class.

  • Location
    Type: 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: 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 the element should be placed at the end.

  • Bases
    Type: Object

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

  • ImplementedInterfaces
    Type: 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.

Return Value

Type: EnvDTE.CodeClass
A CodeClass object.

Remarks

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

.NET Framework Security

See Also

Reference

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel Namespace

Other Resources

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