Share via


CodeElement.Name Property

Sets or gets the name of the object.

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

Syntax

'Declaration
Default Property Name As String
string this { get; set; }
property String^ default {
    String^ get ();
    void set (String^ value);
}
abstract Name : string with get, set
function get Name () : String 
function set Name (value : String)

Property Value

Type: System.String
A string representing the name of the CodeElement object.

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

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

.NET Framework Security

See Also

Reference

CodeElement Interface

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