DTE2 Interface

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class DTE2 : EnvDTE::_DTE

public interface class DTE2 : EnvDTE::_DTE

__interface DTE2 : EnvDTE::_DTE

[System.Runtime.InteropServices.Guid("2EE1E9FA-0AFE-4348-A89F-ED9CB45C99CF")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface DTE2 : EnvDTE._DTE

[<System.Runtime.InteropServices.Guid("2EE1E9FA-0AFE-4348-A89F-ED9CB45C99CF")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type DTE2 = interface
    interface _DTE

Public Interface DTE2
Implements _DTE

Attributes: GuidAttribute TypeLibTypeAttribute

Implements: _DTE DTE

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

Remarks

You can get the DTE automation object by calling GetService in the Initialize method.

DTE2 dte = (DTE2)GetService(typeof(DTE));

Properties

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	Obsolete. Obsolete. Gets the AddIns collection, which contains all currently available add-ins.
Application	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	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 values that may be saved in the solution (.sln) file, the project file, or in the user's profile data.
IsOpenFile[String, String]	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 macro IDE 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[String, String]	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.

Methods

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

Applies to

Compartilhar via