CodeClass2.RemoveMember(Object) Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Removes a member of the class.

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

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

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

[System.Runtime.InteropServices.DispId(42)]
public void RemoveMember (object Element);

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

Public Sub RemoveMember (Element As Object)

Parameters

Element

Object

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

Implements

RemoveMember(Object)

Attributes

DispIdAttribute

Examples

[Visual Basic]

Sub RemoveMemberExample(ByVal dte As DTE2)  
    ' Before running this example, open a code document from a project  
    ' and place the insertion point inside a class method.  
    Try  
        ' Retrieve the CodeFunction at the insertion point.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim fun As CodeFunction = CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementFunction), CodeFunction)  
        Dim cls As CodeClass = CType(fun.Parent, CodeClass)  

        If MsgBox("Remove " & fun.Name & " from " & cls.Name & "?", _  
            MsgBoxStyle.YesNo) = MsgBoxResult.Yes Then  
            cls.RemoveMember(fun)  
        End If  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  
End Sub  

[C#]

public void RemoveMemberExample(DTE2 dte)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point inside a class method.  
    try  
    {  
        // Retrieve the CodeFunction at the insertion point.  
        TextSelection sel =   
            (TextSelection)dte.ActiveDocument.Selection;  
        CodeFunction fun =   
            (CodeFunction)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementFunction);  
        CodeClass cls = (CodeClass)fun.Parent;  

        if (MessageBox.Show("Remove " + fun.Name + " from " +   
            cls.Name + "?", "", MessageBoxButtons.YesNo) ==   
            DialogResult.Yes)  
            cls.RemoveMember(fun);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

The removed element 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).