This documentation is archived and is not being maintained.

Events Interface

Allows access to all events in the extensibility model. Events may also be exposed from specific objects within the extensibility model.

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

public interface Events

The Events type exposes the following members.

Public propertyBuildEventsGets the BuildEvents object, which provides events for solution builds.
Public propertyCommandBarEventsGets an object providing events fired when the supplied CommandBarControl object is clicked.
Public propertyCommandEventsGets the CommandEvents for the specified command.
Public propertyDebuggerEventsGets the object that provides events from the debugger.
Public propertyDocumentEventsGets the DocumentEvents that provides events for the document.
Public propertyDTEEventsGets the DTEEvents that provides events for the development environment.
Public propertyFindEventsGets the FindEvents for the Find operation.
Public propertyMiscFilesEventsGets the ProjectItemsEvents for the solution.
Public propertyOutputWindowEventsGets the OutputWindowEvents for the window events.
Public propertySelectionEventsGets the SelectionEvents for the selection.
Public propertySolutionEventsGets the SolutionEvents object for the solution.
Public propertySolutionItemsEventsGets the ProjectItemsEvents object for the solution.
Public propertyTaskListEventsGets the TaskListEvents for the development environment.
Public propertyTextEditorEventsGets the TextEditorEvents object for the IDE.
Public propertyWindowEventsGets the WindowEvents object that provides events for windows in the development environment.

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

The automation model contains a root Events object from which automation clients written in any language can reference automation events, such as the SolutionEvents.

Various IDE tools, project types, editors, and so forth may add additional events to the Events object that are specific to them. For example, Visual C++ adds the VCProjectItemsEvents property.

Public Module Module1
   Dim WithEvents bldevents As BuildEvents
   Dim applicationObject As EnvDTE.DTE

   Sub EventsExample()
      Dim addInInstance As EnvDTE.AddIn

      applicationObject = CType(Application, EnvDTE.DTE)
      bldevents = CType(applicationObject.Events.BuildEvents, EnvDTE.BuildEvents)
   End Sub

   Private Sub bldevents_OnBuildDone(ByVal Scope As EnvDTE.vsBuildScope, ByVal Action As EnvDTE.vsBuildAction) Handles bldevents.OnBuildDone
      MsgBox("Build complete")
   End Sub
End Module