DTE DTE DTE DTE DTE DTE Interface

Definition

The top-level object in the Visual Studio automation object model. The documentation for the _DTE type is the most complete.

public interface class DTE : EnvDTE::_DTE
public interface class DTE : EnvDTE::_DTE
__interface DTE : EnvDTE::_DTE
[System.Runtime.InteropServices.CoClass(typeof(EnvDTE.DTEClass))]
[System.Runtime.InteropServices.Guid("04A72314-32E9-48E2-9B87-A63603454F3E")]
public interface DTE : EnvDTE._DTE
type DTE = interface
    interface _DTE
Public Interface DTE
Implements _DTE
Derived
Attributes
Implements

Examples

Sub DTEExample()  
    Dim objTextDoc As TextDocument  
    Dim objEP As EditPoint  
  
    ' Create a new text document.  
    DTE.ItemOperations.NewFile("General\Text File")  
    ' Get a handle to the new document.  
    Set objTextDoc = DTE.ActiveDocument.Object("TextDocument")  
    Set objEP = objTextDoc.StartPoint.CreateEditPoint  
    ' Create an EditPoint and add some text.  
    objEP.Insert "A test sentence."  
End Sub  

Remarks

For details about referencing the EnvDTE namespace and the DTE object, see FAQ: Converting Add-ins to VSPackage Extensions.

Properties

ActiveDocument ActiveDocument ActiveDocument ActiveDocument ActiveDocument ActiveDocument

Gets the active document.

(Inherited from _DTE)

ActiveSolutionProjects ActiveSolutionProjects ActiveSolutionProjects ActiveSolutionProjects ActiveSolutionProjects ActiveSolutionProjects

Gets an array of currently selected projects.

(Inherited from _DTE)

ActiveWindow ActiveWindow ActiveWindow ActiveWindow ActiveWindow ActiveWindow

Returns the currently active window, or the top-most window if no others are active.

(Inherited from _DTE)

AddIns AddIns AddIns AddIns AddIns AddIns

Gets the AddIns collection, which contains all currently available add-ins.

(Inherited from _DTE)

Application Application Application Application Application Application

Microsoft Internal Use Only.

(Inherited from _DTE)

CommandBars CommandBars CommandBars CommandBars CommandBars CommandBars

Gets a reference to the development environment's command bars.

(Inherited from _DTE)

CommandLineArguments CommandLineArguments CommandLineArguments CommandLineArguments CommandLineArguments CommandLineArguments

Gets a string representing the command line arguments.

(Inherited from _DTE)

Commands Commands Commands Commands Commands Commands

Returns the Commands collection.

(Inherited from _DTE)

ContextAttributes ContextAttributes ContextAttributes ContextAttributes ContextAttributes ContextAttributes

Gets a ContextAttributes collection which allows automation clients to add new attributes to the current selected items in the Dynamic Help window and provide contextual help for the additional attributes.

(Inherited from _DTE)

Debugger Debugger Debugger Debugger Debugger Debugger

Gets the debugger objects.

(Inherited from _DTE)

DisplayMode DisplayMode DisplayMode DisplayMode DisplayMode DisplayMode

Gets the display mode, either MDI or Tabbed Documents.

(Inherited from _DTE)

Documents Documents Documents Documents Documents Documents

Gets the collection of open documents in the development environment.

(Inherited from _DTE)

DTE DTE DTE DTE DTE DTE

Gets the top-level extensibility object.

(Inherited from _DTE)

Edition Edition Edition Edition Edition Edition

Gets a description of the edition of the environment.

(Inherited from _DTE)

Events Events Events Events Events Events

Gets a reference to the Events object.

(Inherited from _DTE)

FileName FileName FileName FileName FileName FileName

Microsoft Internal Use Only.

(Inherited from _DTE)

Find Find Find Find Find Find

Gets the Find object that represents global text find operations.

(Inherited from _DTE)

FullName FullName FullName FullName FullName FullName

Gets the full path and name of the object's file.

(Inherited from _DTE)

Globals Globals Globals Globals Globals Globals

Gets the Globals object that contains values that may be saved in the solution (.sln) file, the project file, or in the user's profile data.

(Inherited from _DTE)

IsOpenFile[String, String] IsOpenFile[String, String] IsOpenFile[String, String] IsOpenFile[String, String] IsOpenFile[String, String] IsOpenFile[String, String]

Microsoft Internal Use Only.

(Inherited from _DTE)

ItemOperations ItemOperations ItemOperations ItemOperations ItemOperations ItemOperations

Gets the ItemOperations object.

(Inherited from _DTE)

LocaleID LocaleID LocaleID LocaleID LocaleID LocaleID

Gets the ID of the locale in which the development environment is running.

(Inherited from _DTE)

Macros Macros Macros Macros Macros Macros

Gets the Macros object.

(Inherited from _DTE)

MacrosIDE MacrosIDE MacrosIDE MacrosIDE MacrosIDE MacrosIDE

Gets the root of the Macros IDE's automation model.

(Inherited from _DTE)

MainWindow MainWindow MainWindow MainWindow MainWindow MainWindow

Gets a Window object representing the main development environment window.

(Inherited from _DTE)

Mode Mode Mode Mode Mode Mode

Gets the mode of the development environment, either debug or design.

(Inherited from _DTE)

Name Name Name Name Name Name

Sets or gets the name of the _DTE object.

(Inherited from _DTE)

ObjectExtenders ObjectExtenders ObjectExtenders ObjectExtenders ObjectExtenders ObjectExtenders

Gets the ObjectExtenders object.

(Inherited from _DTE)

Properties[String, String] Properties[String, String] Properties[String, String] Properties[String, String] Properties[String, String] Properties[String, String]

Returns a Properties collection representing all available categories and subcategories contained in the Options dialog box on the Tools menu.

(Inherited from _DTE)

RegistryRoot RegistryRoot RegistryRoot RegistryRoot RegistryRoot RegistryRoot

Gets a string with the path to the root of the Visual Studio registry settings.

(Inherited from _DTE)

SelectedItems SelectedItems SelectedItems SelectedItems SelectedItems SelectedItems

Gets a collection containing the items currently selected in the environment.

(Inherited from _DTE)

Solution Solution Solution Solution Solution Solution

Gets the Solution object that represents all open projects in the current instance of the environment and allows access to the build objects.

(Inherited from _DTE)

SourceControl SourceControl SourceControl SourceControl SourceControl SourceControl

Gets a SourceControl object that allows you to manipulate the source code control state of the file behind the object.

(Inherited from _DTE)

StatusBar StatusBar StatusBar StatusBar StatusBar StatusBar

Gets the StatusBar object, representing the status bar on the main development environment window.

(Inherited from _DTE)

SuppressUI SuppressUI SuppressUI SuppressUI SuppressUI SuppressUI

Gets or sets whether UI should be displayed during the execution of automation code.

(Inherited from _DTE)

UndoContext UndoContext UndoContext UndoContext UndoContext UndoContext

Gets the global UndoContext object.

(Inherited from _DTE)

UserControl UserControl UserControl UserControl UserControl UserControl

Sets or gets a value indicating whether the environment was launched by a user or by automation.

(Inherited from _DTE)

Version Version Version Version Version Version

Gets the host application's version number.

(Inherited from _DTE)

WindowConfigurations WindowConfigurations WindowConfigurations WindowConfigurations WindowConfigurations WindowConfigurations

Gets the WindowConfigurations collection, representing all available window configurations.

(Inherited from _DTE)

Windows Windows Windows Windows Windows Windows

Gets a Windows collection containing the windows that display in the object.

(Inherited from _DTE)

Methods

ExecuteCommand(String, String) ExecuteCommand(String, String) ExecuteCommand(String, String) ExecuteCommand(String, String) ExecuteCommand(String, String) ExecuteCommand(String, String)

Executes the specified command.

(Inherited from _DTE)

GetObject(String) GetObject(String) GetObject(String) GetObject(String) GetObject(String) GetObject(String)

Gets an interface or object that is late-bound to the DTE object and can be accessed by name at run time.

(Inherited from _DTE)

LaunchWizard(String, Object[]) LaunchWizard(String, Object[]) LaunchWizard(String, Object[]) LaunchWizard(String, Object[]) LaunchWizard(String, Object[]) LaunchWizard(String, Object[])

Runs a wizard with the supplied parameters.

(Inherited from _DTE)

OpenFile(String, String) OpenFile(String, String) OpenFile(String, String) OpenFile(String, String) OpenFile(String, String) OpenFile(String, String)

Microsoft Internal Use Only.

(Inherited from _DTE)

Quit() Quit() Quit() Quit() Quit() Quit()

Closes the environment.

(Inherited from _DTE)

SatelliteDllPath(String, String) SatelliteDllPath(String, String) SatelliteDllPath(String, String) SatelliteDllPath(String, String) SatelliteDllPath(String, String) SatelliteDllPath(String, String)

Returns the computed path to the satellite DLL when given the installation directory and the file name of the DLL containing localized resources.

(Inherited from _DTE)

Applies to