CodeElement.Name Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Sets or gets the name of the object.

public:
 property System::String ^ default { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ default { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(0)]
public string this { [System.Runtime.InteropServices.DispId(0)] get; [System.Runtime.InteropServices.DispId(0)] set; }

[<System.Runtime.InteropServices.DispId(0)>]
[<get: System.Runtime.InteropServices.DispId(0)>]
[<set: System.Runtime.InteropServices.DispId(0)>]
member this.Name : string with get, set

Default Public Property Name As String

Property Value

String

A string representing the name of the CodeElement object.

Attributes

DispIdAttribute

Examples

Public Sub CodeClassExample(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  
        Dim objTextSel As TextSelection  
        Dim objCodeCls As CodeClass  
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)  
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)  
        ' Get a collection of elements contained by the CodeClass object.  
        Dim members As String = "Member Elements of " + objCodeCls.Name + ": " + vbCrLf  
        Dim elem As CodeElement  
        For Each elem In objCodeCls.Members  
            members = members + (elem.Name + vbCrLf)  
        Next elem  
        MessageBox.Show(members)  
    Catch ex As Exception  
        MessageBox.Show(ex.Message)  
    End Try  
End Sub  

public void CodeClassExample(DTE2 dte)  
{   
   // Before running this example, open a code document from a  
   // project and place the insertion point inside a class definition  
   try  
   {  
      TextSelection objTextSel;  
      CodeClass objCodeCls;  
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;  
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementClass);  
      // Get a collection of elements contained by the CodeClass object.  
      string members = "Member Elements of " + objCodeCls.Name + ": \n";  
      foreach (CodeElement elem in objCodeCls.Members)  
      {  
         members = members + (elem.Name + "\n");  
      }  
      MessageBox.Show(members);  
   }  
   catch (Exception ex)  
   {   
      MessageBox.Show(ex.Message);  
   }  
}  

Remarks

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