DTE Interface
TOC
Collapse the table of content
Expand the table of content

DTE Interface

 

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

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

[GuidAttribute("04A72314-32E9-48E2-9B87-A63603454F3E")]
public interface DTE : _DTE

NameDescription
System_CAPS_pubpropertyActiveDocument

Gets the active document.(Inherited from _DTE.)

System_CAPS_pubpropertyActiveSolutionProjects

Gets an array of currently selected projects.(Inherited from _DTE.)

System_CAPS_pubpropertyActiveWindow

Returns the currently active window, or the top-most window if no others are active. (Inherited from _DTE.)

System_CAPS_pubpropertyAddIns

Gets the AddIns collection, which contains all currently available add-ins.(Inherited from _DTE.)

System_CAPS_pubpropertyApplication

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from _DTE.)

System_CAPS_pubpropertyCommandBars

Gets a reference to the development environment's command bars.(Inherited from _DTE.)

System_CAPS_pubpropertyCommandLineArguments

Gets a string representing the command line arguments.(Inherited from _DTE.)

System_CAPS_pubpropertyCommands

Returns the Commands collection.(Inherited from _DTE.)

System_CAPS_pubpropertyContextAttributes

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

System_CAPS_pubpropertyDebugger

Gets the debugger objects.(Inherited from _DTE.)

System_CAPS_pubpropertyDisplayMode

Gets the display mode, either MDI or Tabbed Documents.(Inherited from _DTE.)

System_CAPS_pubpropertyDocuments

Gets the collection of open documents in the development environment.(Inherited from _DTE.)

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.(Inherited from _DTE.)

System_CAPS_pubpropertyEdition

Gets a description of the edition of the environment.(Inherited from _DTE.)

System_CAPS_pubpropertyEvents

Gets a reference to the Events object.(Inherited from _DTE.)

System_CAPS_pubpropertyFileName

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from _DTE.)

System_CAPS_pubpropertyFind

Gets the Find object that represents global text find operations.(Inherited from _DTE.)

System_CAPS_pubpropertyFullName

Gets the full path and name of the object's file.(Inherited from _DTE.)

System_CAPS_pubpropertyGlobals

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

System_CAPS_pubpropertyIsOpenFile[String, String]

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from _DTE.)

System_CAPS_pubpropertyItemOperations

Gets the ItemOperations object.(Inherited from _DTE.)

System_CAPS_pubpropertyLocaleID

Gets the ID of the locale in which the development environment is running.(Inherited from _DTE.)

System_CAPS_pubpropertyMacros

Gets the Macros object.(Inherited from _DTE.)

System_CAPS_pubpropertyMacrosIDE

Gets the root of the Macros IDE's automation model.(Inherited from _DTE.)

System_CAPS_pubpropertyMainWindow

Gets a Window object representing the main development environment window.(Inherited from _DTE.)

System_CAPS_pubpropertyMode

Gets the mode of the development environment, either debug or design.(Inherited from _DTE.)

System_CAPS_pubpropertyName

Sets or gets the name of the _DTE object.(Inherited from _DTE.)

System_CAPS_pubpropertyObjectExtenders

Gets the ObjectExtenders object.(Inherited from _DTE.)

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

System_CAPS_pubpropertyRegistryRoot

Gets a string with the path to the root of the Visual Studio registry settings.(Inherited from _DTE.)

System_CAPS_pubpropertySelectedItems

Gets a collection containing the items currently selected in the environment.(Inherited from _DTE.)

System_CAPS_pubpropertySolution

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

System_CAPS_pubpropertySourceControl

Gets a SourceControl object that allows you to manipulate the source code control state of the file behind the object.(Inherited from _DTE.)

System_CAPS_pubpropertyStatusBar

Gets the StatusBar object, representing the status bar on the main development environment window.(Inherited from _DTE.)

System_CAPS_pubpropertySuppressUI

Gets or sets whether UI should be displayed during the execution of automation code.(Inherited from _DTE.)

System_CAPS_pubpropertyUndoContext

Gets the global UndoContext object.(Inherited from _DTE.)

System_CAPS_pubpropertyUserControl

Sets or gets a value indicating whether the environment was launched by a user or by automation.(Inherited from _DTE.)

System_CAPS_pubpropertyVersion

Gets the host application's version number.(Inherited from _DTE.)

System_CAPS_pubpropertyWindowConfigurations

Gets the WindowConfigurations collection, representing all available window configurations.(Inherited from _DTE.)

System_CAPS_pubpropertyWindows

Gets a Windows collection containing the windows that display in the object.(Inherited from _DTE.)

NameDescription
System_CAPS_pubmethodExecuteCommand(String, String)

Executes the specified command.(Inherited from _DTE.)

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

System_CAPS_pubmethodLaunchWizard(String, Object[])

Runs a wizard with the supplied parameters.(Inherited from _DTE.)

System_CAPS_pubmethodOpenFile(String, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.(Inherited from _DTE.)

System_CAPS_pubmethodQuit()

Closes the environment.(Inherited from _DTE.)

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

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

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
Return to top
Show:
© 2016 Microsoft