CodeClass.DTE Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the top-level extensibility object.

public:
 property EnvDTE::DTE ^ DTE { EnvDTE::DTE ^ get(); };

public:
 property EnvDTE::DTE ^ DTE { EnvDTE::DTE ^ get(); };

[System.Runtime.InteropServices.DispId(1)]
public EnvDTE.DTE DTE { [System.Runtime.InteropServices.DispId(1)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(1)>]
[<get: System.Runtime.InteropServices.DispId(1)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.DTE : EnvDTE.DTE

Public ReadOnly Property DTE As DTE

Property Value

DTE

A DTE object.

Attributes

DispIdAttribute TypeLibFuncAttribute

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)  
        ' Add comments to CodeClass objCodeClass - notice change in code document.  
        objCodeCls.Comment = "Comments for the CodeClass object."  
        ' Access top-level object through the CodeClass object  
        ' and return the file name of that top-level object.  
        MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName)  
        ' Get the language used to code the CodeClass object - returns a GUID.  
        MessageBox.Show(objCodeCls.Language)  
        ' 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);  
      // Add comments to CodeClass objCodeClass - notice change in code document.  
      objCodeCls.Comment = "Comments for the CodeClass object.";  
      // Access top-level object through the CodeClass object  
      // and return the file name of that top-level object.  
      MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName);  
      // Get the language used to code the CodeClass object - returns a GUID.  
      MessageBox.Show(objCodeCls.Language);  
      // 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

In Visual Studio, the DTE is the root of the automation model, which other object models often call "Application".

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