CodeClass2.RemoveBase(Object) Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Removes an object from the list of bases.

public:
 void RemoveBase(System::Object ^ Element);

public:
 void RemoveBase(Platform::Object ^ Element);

void RemoveBase(winrt::Windows::Foundation::IInspectable const & Element);

[System.Runtime.InteropServices.DispId(41)]
public void RemoveBase (object Element);

[<System.Runtime.InteropServices.DispId(41)>]
abstract member RemoveBase : obj -> unit

Public Sub RemoveBase (Element As Object)

Parameters

Element

Object

Required. A CodeElement or the name of one in the collection.

Implements

RemoveBase(Object)

Attributes

DispIdAttribute

Examples

[Visual Basic]

Sub RemoveBaseExample(ByVal dte As DTE2)  
    ' NOTE: This example requires a reference to the   
    '       System.Collections namespace.  

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

        If MsgBox("Remove all bases from " & cls.Name & "?", _  
            MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then  
            ' Remove every base except System.Object.  
            Dim bases As New ArrayList()  
            Dim base As CodeElement  
            For Each base In cls.Bases  
                If base.FullName <> ConvertFullName( _  
                    cls.ProjectItem.ContainingProject.CodeModel, _  
                    "System.Object") Then  
                    bases.Add(base)  
                End If  
            Next  

            For Each base In bases  
                cls.RemoveBase(base)  
            Next  
        End If  
    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 RemoveBaseExample(DTE2 dte)  
{  
    // NOTE: This example requires a reference to the   
    //       System.Collections namespace.  

    // 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);  

        if (MessageBox.Show("Remove all bases from " + cls.Name + "?",   
            "", MessageBoxButtons.YesNo) == DialogResult.Yes)  
        {  
            // Remove every base except System.Object.  
            ArrayList bases = new ArrayList();  

            foreach (CodeElement baseElement in cls.Bases)  
            {  
                if (baseElement.FullName != ConvertFullName(  
                    cls.ProjectItem.ContainingProject.CodeModel,   
                    "System.Object"))  
                    bases.Add(baseElement);  
            }  

            foreach (CodeElement baseElement in bases)  
                cls.RemoveBase(baseElement);  
        }  
    }  
    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;  
}  

Remarks

The element removed can be either a CodeElement object that is in the collection or the name of a unique element in the collection.

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