DXCore plug-in events overall list
May 6th, 2011
Standard DXCore plug-ins include a full set of events supported by DXCore. These events are available right on the plug-ins design surface in the Property Browser. Just choose an event from the list, double click it or press the Enter key and then write an event handler code. The majority of events have sophisticated System.EventArgs descendants that let you handle an event very easily.
The StandardPlugIn class and the DXCoreEvents control share the same ancestry, so they have identical events. These events cover all interaction between user and Visual Studio IDE. They are organized into several categories. Here’s the categorized list of DXCore events:
- Build
| BuildBegin | Occurs before the solution builds, before a batch build begins, or just before a project begins to build. |
| BuildDone | Occurs after a solution build completes. |
| ProjectBuildBegin | Occurs when a project configuration build begins. |
| ProjectBuildDone | Occurs after a project configuration build completes. |
- Commands
| CommandExecuted | Occurs when a Visual Studio command has been executed. |
| CommandExecuting | Occurs when a Visual Studio command is about to execute. |
- Debugger
| DebuggerContextChanged | Occurs whenever the current process, program, thread, or stack is changed. |
| DebuggerEnterBreakMode | Occurs when the debugger enters break mode. This event is fired regardless of how break mode is established. |
| DebuggerEnterDesignMode | Occurs when the debugger leaves run mode or debug mode. This event is fired whenever design mode is established after debugging. |
| DebuggerEnterRunMode | Occurs when entering run mode. This event may not fire when stepping. It is typically best used when you are updating the user interface. |
| DebuggerExceptionNotHandled | Occurs when an exception has been thrown that is not handled while debugging. Thrown before DebuggerEnterBreakMode. |
| DebuggerExceptionThrown | Occurs when an exception has been thrown while debugging. Thrown before DebuggerEnterBreakMode. |
- Designer
| DesignerActivated | Occurs when a designer is activated. |
| DesignerDeactivated | Occurs when a designer is deactivated. |
- Document
| DocumentActivated | Occurs when a document is activated. |
| DocumentClosing | Occurs when a document is closing. |
| DocumentDeactivated | Occurs when a document is deactivated. |
| DocumentExtensionChanged | Occurs when the file extension of a newly activated document is different from the file extension of the previously active document. |
| DocumentLanguageChanged | Occurs when a document with a different source language is activated. |
| DocumentOpened | Occurs when a document is opened. |
| DocumentOpening | Occurs when a document is opening. |
| DocumentRenamed | Occurs when a document is renamed. |
| DocumentSaved | Occurs when a document is saved. |
| TextDocumentActivated | Occurs when a text document is activated. |
| TextDocumentDeactivated | Occurs when a text document is deactivated. |
- DTE
| BeginShutdown | Occurs just before Visual Studio shuts down. |
| MacrosRuntimeReset | Occurs when the macro runtime execution engine resets, clearing all global variable data and losing all event connections. |
| ModeChanged | Occurs when the IDE mode changes (e.g., from Design mode to Debug mode). |
| StartupComplete | Occurs after the host application completes its startup routines, provided that both DXCore and your Add-in load at environment startup. |
- DXCore
| AfterParse | Occurs after the DXCore parses a file. |
| AfterPreprocessMacro | Occurs after the DXCore parses a file. |
| BeforeParse | Occurs before DXCore is about to parse a file. |
| FeatureInvoked | Occurs when a feature that displays an action hint is invoked. This event will fire even if the action hint is disabled. |
| GetAvailableShortcuts | Occurs when a hinting or discoverability plug-in requests a list of available shortcuts for the current context. If you would like your plug-in to participate in this discoverability, handle this event and add the Actions that are available. |
| OptionsChanged | Occurs when DXCore options have changed. |
| PopupMemberMenu | Occurs when a member popup menu appears. Handlers may add custom menu items to participate on this special menu. |
- Editor
| CaretMoved | Occurs when the line number or column changes in the active file. Also occurs when a file is activated. |
| DecorateEditor | Occurs when the editor is being decorated. |
| DecorateLanguageElement | Occurs when language elements are being decorated, called once for each language element in the text view. |
| DocumentSetText | Occurs when the TextDocument.Set method is called, indicating code has been programmatically added, replaced, or deleted in the editor. |
| EditorCharacterCancelled | Occurs when a character being typed in the editor has been cancelled by another plug-in. |
| EditorCharacterTyped | Occurs when a character is typed in the editor. |
| EditorCharacterTyping | Occurs when a character is being typed in the editor. |
| EditorContextMenuShowing | Occurs when the context menu is about to be displayed in the editor. |
| EditorFontChanged | Occurs when the user changes the editor font. |
| EditorIdle | Occurs when the editor initially becomes idle, and is subsequently called at repeated intervals until the editor returns to an active state. |
| EditorMappingChanged | Occurs when the Visual Studio remaps the lines visible in the editor. This happens when a region is expanded or collapsed, word wrapping is enabled or a file is opened in the editor. |
| EditorMouseDoubleClick | Occurs when the mouse double-clicks in the editor. |
| EditorMouseDown | Occurs when the mouse is down in the editor. |
| EditorMouseEnter | Occurs when the mouse enters the editor. |
| EditorMouseHover | Occurs when the mouse is hovering in the editor. |
| EditorMouseLeave | Occurs when the mouse leaves the editor. |
| EditorMouseMove | Occurs when the mouse is moved in the editor. This event only fires if the editor has focus. It will not fire if the VS menu system is active (e.g., the editor context menu is up or a VS 2005 smart tag is active). |
| EditorMouseUp | Occurs when the mouse is up in the editor. |
| EditorMouseWheel | Occurs when the mouse wheel is moved in the editor. |
| EditorPaint | Occurs when the editor is painting. |
| EditorPaintBackground | Occurs when the editor is painting, called before the EditorPaint event, used for low-priority screen adornments that can be overlapped by higher priority adornments. |
| EditorPaintComment | Occurs when the editor is painting, called once for each comment in the text view. |
| EditorPaintForeground | Occurs when the editor is painting, called after the EditorPaint event, used for high-priority screen adornments that should not be obscured by other adornments. |
| EditorPaintLanguageElement | Occurs when the editor is painting, called once for each language element in the text view. |
| EditorPaintString | Occurs when the editor is painting, called once for each string in the text view. |
| EditorPaintXmlDocComment | Occurs when the editor is painting, called once for each XML Doc comment in the text view. |
| EditorScrolled | Occurs when the editor is scrolled. |
| EditorSetCursor | Occurs when the editor cursor is changed. |
| EditorValidateClipRegion | Occurs before Visual Studio paints a TextView. If your plug-in paints entirely over an area of the view, you can handle this event to block out the area that will be painted. This will prevent Visual Studio from painting in areas you reserve. |
| EditorValidate LanguageElementClipRegion | Occurs before Visual Studio paints a TextView, called once for each LanguageElement in view. If your plug-in paints entirely over an area of the view that corresponds to a LanguageElement, you can handle this event to block out the area that will be painted. This will prevent Visual Studio from painting in areas you reserve. |
| IntellisenseActivated | Occurs when the Intellisense is activated in the editor. |
| IntellisenseDeactivated | Occurs when the Intellisense is deactivated in the editor. |
| LanguageElementActivated | Occurs when the editor caret moves into a different language element. |
| LineChangesCommitted | Occurs when line changes are committed (e.g., Enter key is pressed or the cursor moves away from the line that was modified). |
| SelectionChanged | Occurs when the selection changes in the active file. Also occurs when a file is activated. |
| SmartTagHiding | Occurs when smart tag is about to be hidden. |
| SmartTagMenuHiding | Occurs when smart tag menu is about to be hidden. |
| SmartTagShowing | Occurs when smart tag is about to be shown. |
| TextChanged | Occurs when any text is changed in the editor. |
| TextViewActivated | Occurs when focus is set to a text view. |
| TextViewDeactivated | Occurs when focus is removed from a text view. |
| TipWindowActivated | Occurs when the tip window is activated in the editor. |
| TipWindowDeactivated | Occurs when the tip window is deactivated in the editor. |
- Find
| FindDone | Occurs after a Find-in-files with a results list operation completes. |
- IDE
| KeyPressed | Occurs when a key is pressed in the IDE. |
| VisualStudioActivated | Occurs immediately after Visual Studio .NET becomes active. |
| VisualStudioDeactivated | Occurs immediately after Visual Studio .NET becomes inactive. |
- Markers
| MarkerCollected | Occurs when a marker is collected. |
| MarkerDropped | Occurs when a marker is dropped. |
- Misc
| LinkedIdentifierActivated | Occurs when a linked identifier is activated. |
| LinkedIdentifierChanged | Occurs when a linked identifier has been changed. |
| LinkedIdentifierDeactivated | Occurs when a linked identifier is deactivated. |
- Miscellaneous Files
| MiscFileAdded | Occurs immediately after you open a file that is not contained inside of any open projects. |
| MiscFileRemoved | Occurs immediately after you remove a file that is not contained inside of any open projects. |
| MiscFileRenamed | Occurs immediately after you rename a file that is not contained inside of any open projects. |
- Options
| LanguageOptionsChanged | Occurs immediately after the Visual Studio options for a language have changed. |
- Project
| ImportAdded | Occurs when an import is added to a project. |
| ImportRemoved | Occurs when an import is removed from a project. |
| ReferenceAdded | Occurs when a reference is added to a project. |
| ReferenceChanged | Occurs when a project reference is changed. |
| ReferenceRemoved | Occurs when a reference is removed from a project. |
- Project Items
| ProjectItemAdded | Occurs immediately after you add an item to a project. |
| ProjectItemRemoved | Occurs immediately after you remove an item from a project. |
| ProjectItemRenamed | Occurs immediately after you rename an item in a project. |
- Project Selection
| ProjectSelectionChange | Occurs when a selection in the Solution Explorer changes. This event is also fired when project files are renamed. |
- Solution
| AfterClosingSolution | Occurs immediately after closing a solution. |
| BeforeClosingSolution | Occurs immediately before closing a solution. |
| ProjectAdded | Occurs immediately after adding a project to the solution. |
| ProjectRemoved | Occurs immediately after removing a project from the solution. |
| ProjectRenamed | Occurs immediately after renaming a project in the solution. |
| QueryCloseSolution | Occurs before the BeforeClosingSolution event. |
| SolutionConfigurationChanged | Occurs after changing the solution configuration. |
| SolutionOpened | Occurs immediately after opening a solution or project. |
| SolutionRenamed | Occurs after renaming a solution. |
- Solution Items
| SolutionItemAdded | Occurs immediately after you add a solution item to the solution. |
| SolutionItemRemoved | Occurs immediately after you remove a solution item from the solution. |
| SolutionItemRenamed | Occurs immediately after you rename a solution item in the solution. |
- System
| ClipboardChanged | Occurs when data is cut or copied to the clipboard. |
- Tiles
| TileDoubleClick | Occurs when the tile is double-clicked. |
| TileMouseDown | Occurs when the mouse is down in the tile. |
| TileMouseEnter | Occurs when the mouse enters the tile. |
| TileMouseLeave | Occurs when the mouse leaves the tile. |
| TileSetCursor | Occurs when the tile changes the mouse cursor. |
- Tile Visuals
| TileVisualDoubleClick | Occurs when the tile visual is double-clicked. |
| TileVisualMouseDown | Occurs when the mouse is down in the tile visual. |
| TileVisualMouseEnter | Occurs when the mouse enters the tile visual. |
| TileVisualMouseHover | Occurs when the mouse hovers over the tile visual. |
| TileVisualMouseLeave | Occurs when the mouse leaves the tile visual. |
| TileVisualMouseMove | Occurs when the mouse moves inside the tile visual. |
| TileVisualMouseUp | Occurs when the mouse is up in the tile visual. |
- Undo & Redo
| RedoExecuted | Occurs after redo is executed. |
| RedoExecuting | Occurs immediately before redo is about to execute. |
| UndoExecuted | Occurs after undo is executed. |
| UndoExecuting | Occurs immediately before undo is about to execute. |
- Window
| WindowActivated | Occurs when a window or document receives focus. |
| WindowClosing | Occurs when a window or document closes. |
| WindowCreated | Occurs when a window is created or a document is opened. |
| WindowMoved | Occurs when a window is moved. |
There’s also a secret class inside DXCore, which allows you to handle an additional set of low-level events. It is called EventNexus. Besides standard events, it contains the following:
|
Event Name |
Description |
| ActiveLanguageChanged | Occurs when DXCore language is changed. Note that it is hidden from Intellisense. |
| AfterAddSolutionDirectories | Occurs immediately after solution directories are added. Note that it is hidden from Intellisense. |
| AfterAddSolutionFiles | Occurs immediately after solution files are added. Note that it is hidden from Intellisense. |
| AfterCheckRefactoringAvailability | Occurs when availability of refactoring operations is checked. Note that it is hidden from Intellisense. |
| AfterFontAndColorPrefsChanged | Occurs after the Visual Studio options for fonts and colors have changed. Note that it is hidden from Intellisense. |
| AfterRemoveSolutionDirectories | Occurs immediately after solution directories are removed. Note that it is hidden from Intellisense. |
| AfterRemoveSolutionFiles | Occurs immediately after solution files are removed. Note that it is hidden from Intellisense. |
| AfterRenameSolutionDirectories | Occurs immediately after solution directories are renamed. Note that it is hidden from Intellisense. |
| AfterRenameSolutionFiles | Occurs immediately after solution files are renamed. Note that it is hidden from Intellisense. |
| AfterSolutionClosing | Occurs after solution is closed. |
| AfterTemplateExpand | Occurs after a CodeRush template is expanded. |
| AfterTextExpansion | Occurs after text expansion is performed. |
| AllTextFieldsCommitted | Occurs when the last text field has been committed and the associated target has been activated. |
| BeforeAutoDeclare | Occurs before the Auto Declare feature is invoked. Note that it is hidden from Intellisense. |
| BeforeCheckRefactoringAvailability | Occurs before the check of refactoring operations availability. Note that it is hidden from Intellisense. |
| BeforeProjectElementRemove | Occurs after a project element is removed. Note that it is hidden from Intellisense. |
| BeforeSolutionClosing | Occurs before a solution is going to be closed. |
| BeforeTemplateExpand | Occurs before the CodeRush template is going to be expanded. |
| BeforeTextExpansion | Occurs before a text expansion is performed. |
| ClipboardChanged | Occurs when Clipboard is changed. |
| CodeIssueChecked | Occurs when CodeRush Code Issues are checked. Note that it is hidden from Intellisense. |
| CodeRushStateChanged | Occurs when CodeRush state is changed (e.g. loaded/unloaded). Note that it is hidden from Intellisense. |
| DecorateCodeIssue | Occurs when visual items are added to the code issue. |
| DXCoreLoaded | Occurs when the DXCore has finished loading. |
| DXCoreUnloading | Occurs when the DXCore begins unloading. |
| EditorZoomLevelChanged | Occurs when editor zoom level is changed. |
| FileChecked | Occurs when a file has been checked for code issues. Note that it is hidden from Intellisense. |
| FinalTextChangeCommit | Occurs when a fine text change is committed. |
| FontAndColorPrefsChanged | Occurs immediately after the Visual Studio options for a font and color have changed. Attention! This event occurs for earch changed font and color category. Note that it is hidden from Intellisense. |
| KeyDown | Occurs when the key is down. |
| KeyUp | Occurs when the key is up. |
| LineChanged | Occurs when the text line is changed. |
| LinkedIdentifierCommitted | Occurs when a linked identifier is committed. |
| LinkedIdentifierDispose | Occurs when a linked identifier is disposed. |
| LinkedIdentifierItemActivated | Occurs when a linked identifier item is activated. |
| LinkedIdentifierItemDeactivated | Occurs when a linked identifier item is deactivated. |
| LockKeyStateChanged | Occurs when the state of one of the four keys (Num Lock, Caps Lock, Scroll Lock, Function Lock) is changed. |
| MenuActivated | Occurs when Visual Studio menu is activated. |
| MenuDeactivated | Occurs when Visual Studio menu is deactivated. |
| MenuHidden | Occurs when Visual Studio menu is hidden. |
| MenuItemFocused | Occurs when Visual Studio menu item is focused. Note that it is hidden from Intellisense. |
| MenuShown | Occurs when Visual Studio menu is shown. |
| ModalDialogActivated | Occurs when a modal dialog is activated. Note that it is hidden from Intellisense. |
| ModalDialogDeActivated | Occurs when a modal dialog is deactivated. Note that it is hidden from Intellisense. |
| ModeChanged | Occurs when the DTE mode is changed. |
| ModifierKeyStateChanged | Occurs when the state of one of the three keys (Shift, Ctrl, Alt) is changed. |
| OutputWindowPaneAdded | Occurs when a pane is added to the Output window. |
| OutputWindowPaneClearing | Occurs when a pane inside the Output window is clearing. |
| OutputWindowPaneUpdated | Occurs when a pane inside the Output window is updated. |
| ParserResumed | Occurs when the parser is no longer suspended. |
| ParserSuspended | Occurs when parse operations are suspended. |
| PopupMemberMenu | Occurs when the Member Popup menu is shown. |
| PostTextChanged | Occurs after all TextChanged events fire to plug-ins. Used by the EditPoint service to adjust EditPoint positions. |
| ProjectConfigurationChanged | Occurs when project configuration is changed. |
| ProjectItemLoaded | Occurs when the project item is loaded. Note that it is hidden from Intellisense. |
| ProjectItemParsed | Occurs when the project item is parsed. Note that it is hidden from Intellisense. |
| ProjectParsed | Occurs when the project is loaded. |
| RedoActionCancelled | Occurs when a redo action has been cancelled. |
| RedoActionExecuted | Occurs after a redo action has been executed. |
| RedoActionExecuting | Occurs immediately before a redo action is about to execute. |
| RefactoringActivated | Occurs when the refactoring operation is activated. |
| RefactoringDeactivated | Occurs when the refactoring operation is deactivated. |
| RegionsCollapsed | Occurs when the region is collapsed. |
| RegionsExpanded | Occurs when the region is expanded. |
| SetNewOptionPage | Occurs when the Options Dialog switches to another options page. |
| SolutionBuildDone | Occurs after a solution build is done. |
| SolutionBuildStarting | Occurs when a solution build is starting. |
| SolutionParsed | Occurs when a solution is parsed. |
| SolutionWideAnalysisDone | Occurs when a solution wide analysis is done. Note that it is hidden from Intellisense. |
| SolutionWideAnalysisStarted | Occurs when a solution wide analysis is started. Note that it is hidden from Intellisense. |
| SolutionWideAnalysisStopped | Occurs when a solution wide analysis is stopped. Note that it is hidden from Intellisense. |
| TemplateUndoContextClosing | Occurs immediately before the undo context for a template expansion is closed. |
| TemplateUndoContextOpened | Occurs immediately after the undo context for a template expansion is opened. |
| TextBufferAdded | Occurs when a new text buffer is opened in Visual Studio and the DXCore creates an ITextBuffer for it. |
| TextBufferChangeCancelled | Occurs when a text change has been cancelled in an ITextBuffer. |
| TextBufferChanged | Occurs when text has been changed in an ITextBuffer. |
| TextBufferChangesCommitted | Occurs when changes are committed in an ITextBuffer. |
| TextBufferChanging | Occurs when text is about to be changed in an ITextBuffer. |
| TextBufferRemoved | Occurs when a new text buffer is opened in Visual Studio and the DXCore creates an ITextBuffer for it. |
| TextBufferRenamed | Occurs when an ITextBuffer has been renamed. |
| TextDocumentReloaded | Occurs when a text document is reloaded. |
| TextExpansionsFinished | Occurs when a text expansion is finished. |
| TextExpansionsStarted | Occurs when a text expansion is started. |
| TextFieldActivated | Occurs when a text field is activated. |
| TextFieldChanged | Occurs when a text field is changed. |
| TextFieldCommitted | Occurs when changes made to a text field are committed. |
| TextFieldDeactivated | Occurs when a text field is deactivated. |
| TextFieldDeleted | Occurs when a text field is deleted. |
| TextViewCreated | Occurs when a text view is created. |
| UndoActionCancelled | Occurs when an undo action has been cancelled. |
| UndoActionExecuted | Occurs after an undo action has been executed. |
| UndoActionExecuting | Occurs immediately before an undo action is about to execute. |