CodeClass2.RemoveMember Method

  • Article

Removes a member of the class.

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

Syntax

'Declaration
Sub RemoveMember ( _
    Element As Object _
)

void RemoveMember(
    Object Element
)

void RemoveMember(
    Object^ Element
)

abstract RemoveMember : 
        Element:Object -> unit 

function RemoveMember(
    Element : Object
)

Parameters

Implements

CodeClass.RemoveMember(Object)

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

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

.NET Framework Security

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