We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

IVsRunningDocTableEvents3 Interface

Implements methods that fire in response to changes to documents in the Running Document Table (RDT).

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

public interface IVsRunningDocTableEvents3 : IVsRunningDocTableEvents2

The IVsRunningDocTableEvents3 type exposes the following members.

Public methodOnAfterAttributeChangeCalled after an attribute of a document in the Running Document Table (RDT) changes.
Public methodOnAfterAttributeChangeExCalled after a document attribute is changed. This is an advanced version of the OnAfterAttributeChange method.
Public methodOnAfterDocumentWindowHideCalled after a document window is hidden.
Public methodOnAfterFirstDocumentLockCalled after application of the first lock of the specified type to a document in the Running Document Table (RDT).
Public methodOnAfterSaveCalled after a document in the Running Document Table (RDT) is saved.
Public methodOnBeforeDocumentWindowShowCalled before displaying a document window.
Public methodOnBeforeLastDocumentUnlockCalled before releasing the last lock of the specified type on the specified document in the Running Document Table (RDT).
Public methodOnBeforeSaveCalled before saving a document.

The IVsRunningDocTableEvents3 interface is specified in a call to the AdviseRunningDocTableEvents method in the IVsRunningDocumentTable interface.

The interface's methods use a cookie representing the client requesting the notification. The cookie is used in the call to the UnadviseRunningDocTableEvents method when the package no longer wants to listen to RDT events.

To receive notice before the application of the first lock on a document (giving you a chance to load the document), implement the IVsRunningDocTableEvents4 interface.

Notes to Implementers

The package implements the interface to receive events relating to the current state of documents in the RDT. Note that this interface derives from the IVsRunningDocTableEvents2 interface and must implement all of that interface's methods as well.

The cookie parameter passed to all of the methods in this interface represents the document affected by an event. This cookie is the same value returned from FindAndLockDocument or RegisterAndLockDocument methods in the IVsRunningDocumentTable interface.

Notes to Callers

The environment calls this interface on the occurrence of specific events. In particular, the environment calls this interface before saving a document.