DTE2 Interface

The top-level object in the Visual Studio automation object model.

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

Syntax

'Declaration
<GuidAttribute("2EE1E9FA-0AFE-4348-A89F-ED9CB45C99CF")> _
Public Interface DTE2 _
    Inherits _DTE

[GuidAttribute("2EE1E9FA-0AFE-4348-A89F-ED9CB45C99CF")]
public interface DTE2 : _DTE

[GuidAttribute(L"2EE1E9FA-0AFE-4348-A89F-ED9CB45C99CF")]
public interface class DTE2 : _DTE

[<GuidAttribute("2EE1E9FA-0AFE-4348-A89F-ED9CB45C99CF")>]
type DTE2 =  
    interface 
        interface _DTE 
    end

public interface DTE2 extends _DTE

The DTE2 type exposes the following members.

Properties

	Name	Description
	ActiveDocument	Gets the active document.
	ActiveSolutionProjects	Gets an array of currently selected projects.
	ActiveWindow	Gets the currently active window, or the top-most window if no others are active.
	AddIns	Gets the AddIns collection, which contains all currently available Add-ins.
	Application	Infrastructure. Microsoft Internal Use Only.
	CommandBars	Gets a reference to the development environment's CommandBars object.
	CommandLineArguments	Gets a string representing the command line arguments.
	Commands	Gets the Commands collection.
	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.
	Debugger	Gets the debugger objects.
	DisplayMode	Gets or sets the display mode, either MDI or Tabbed Documents.
	Documents	Gets the collection of open documents in the development environment.
	DTE	Gets the top-level extensibility object.
	Edition	Gets a description of the edition of the environment.
	Events	Gets a reference to the Events object.
	FileName	Infrastructure. Microsoft Internal Use Only.
	Find	Gets the Find object that represents global text find operations.
	FullName	Gets the full path and name of the object's file.
	Globals	Gets the Globals object that contains Add-in values that may be saved in the solution (.sln) file, the project file, or in the user's profile data.
	IsOpenFile	Infrastructure. Microsoft Internal Use Only.
	ItemOperations	Gets the ItemOperations object.
	LocaleID	Gets the ID of the locale in which the development environment is running.
	Macros	Gets the Macros object.
	MacrosIDE	Gets the root of the Macros IDE's automation model.
	MainWindow	Gets a Window object representing the main development environment window.
	Mode	Gets the mode of the development environment, either debug or design.
	Name	Gets the name of the DTE.
	ObjectExtenders	Gets the ObjectExtenders object.
	Properties	Gets a Properties collection representing all available categories and subcategories contained in the Options dialog box on the Tools menu.
	RegistryRoot	Gets a string with the path to the root of the Visual Studio registry settings.
	SelectedItems	Gets a collection containing the items currently selected in the environment.
	Solution	Gets the Solution object that represents all open projects in the current instance of the environment and allows access to the build objects.
	SourceControl	Gets a SourceControl object that allows you to manipulate the source code control state of the file behind the object.
	StatusBar	Gets the StatusBar object, representing the status bar on the main development environment window.
	SuppressUI	Gets or sets a value indicating whether user interface (UI) should be displayed during the execution of automation code.
	ToolWindows	Gets a ToolWindows object used as a shortcut for finding tool windows.
	UndoContext	Gets the global UndoContext object.
	UserControl	Gets a value indicating whether the environment was started by a user or by automation.
	Version	Gets the host application's version number.
	WindowConfigurations	Gets the WindowConfigurations collection, representing all available window configurations.
	Windows	Gets a Windows collection containing the windows that display in the object.

Top

Methods

	Name	Description
	ExecuteCommand	Executes the specified command.
	GetObject	Gets an interface or object that is late-bound to the DTE object and can be accessed by name at run time.
	GetThemeColor	Gets a color used to draw the user interface within Visual Studio.
	LaunchWizard	Runs a wizard with the supplied parameters.
	OpenFile	Infrastructure. Microsoft Internal Use Only.
	Quit	Closes the Visual Studio environment.
	SatelliteDllPath	Returns the computed path to the satellite DLL when given the installation directory for an Add-in or wizard and the file name of the DLL containing localized resources.

Top

Remarks

The DTE object is provided to you by the OnConnection method that you implement when you create an Add-in. The DTE object is the Application object in Visual Basic.

To access project-specific properties such as VBProjects or CSharpProjects, use the syntax DTE.GetObject("VBProjects").

For details about referencing the EnvDTE namespace and the DTE object, see Referencing Automation Assemblies and the DTE2 Object.

Examples

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

See Also

Reference

EnvDTE80 Namespace

Other Resources

Referencing Automation Assemblies and the DTE2 Object