CodeClass2.AddBase Method

Adds an item to the list of inherited objects.

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

Syntax

'Declaration
Function AddBase ( _
    Base As Object, _
    Position As Object _
) As CodeElement

CodeElement AddBase(
    Object Base,
    Object Position
)

CodeElement^ AddBase(
    Object^ Base, 
    Object^ Position
)

abstract AddBase : 
        Base:Object * 
        Position:Object -> CodeElement

function AddBase(
    Base : Object, 
    Position : Object
) : CodeElement

Parameters

• Base
  Type: Object

  Required. The class from which to derive implementation, either a CodeClass or a fully qualified type name. Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages use the period-separated format.

• Position
  Type: Object

  Optional. Default = 0. The code element after which to add the new base.

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

  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.

Return Value

Type: EnvDTE.CodeElement
A CodeElement object.

Remarks

The AddBase method returns a CodeElement object rather than a CodeType to accommodate Visual C++. The Kind of the returned object is vsCMElementVCBase for the implementation of Visual C++.

Examples

[Visual Basic]

Sub AddBaseExample(ByVal dte As DTE2)
    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)
        Dim cm As CodeModel = _
            cls.ProjectItem.ContainingProject.CodeModel

        ' Create a fully qualified base name.
        Dim baseName As String = ConvertFullName(cm, _
            "System.Collections.CollectionBase")
        ' Add a base to the class.
        cls.AddBase(baseName)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

Function ConvertFullName(ByVal cm As CodeModel, _
    ByVal fullName As String) As String
    ' Convert a .NET type name into a C++ type name.
    If (cm.Language = CodeModelLanguageConstants.vsCMLanguageVC) Or _
        (cm.Language = CodeModelLanguageConstants.vsCMLanguageMC) Then
        Return fullName.Replace(".", "::")
    Else
        Return fullName
    End If
End Function

[C#]

public void AddBaseExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        CodeModel cm = cls.ProjectItem.ContainingProject.CodeModel;

        // Create a fully qualified base name.
        string baseName = ConvertFullName(cm, 
            "System.Collections.CollectionBase");

        // Add a base to the class.
        cls.AddBase(baseName, -1);
    }
    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;
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CodeClass2 Interface

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