IVsRunningDocTableEvents 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 IVsRunningDocTableEvents

The IVsRunningDocTableEvents type exposes the following members.

Public methodOnAfterAttributeChangeCalled after a change in an attribute of a document in the Running Document Table (RDT).
Public methodOnAfterDocumentWindowHideCalled after a document window is placed in the Hide state.
Public methodOnAfterFirstDocumentLockCalled after application of the first lock of the specified type to the specified document in the Running Document Table (RDT).
Public methodOnAfterSaveCalled after saving a document in the Running Document Table (RDT).
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).

Specify this interface in a call to the AdviseRunningDocTableEvents method of the IVsRunningDocumentTable interface.

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

Other Interfaces

You may want to implement additional interfaces to get more event information:

Notes to Implementers

Packages implement this interface to receive events relating to the state of documents in the RDT. 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 that returned from the FindAndLockDocument or RegisterAndLockDocument methods in the IVsRunningDocumentTable interface.

Notes to Callers

The environment calls this interface when specific events have occurred.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft