This topic has not yet been rated - Rate this topic

IVsRunningDocTableEvents Interface

Visual Studio 2005

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)

Syntax

C++

Copy

[GuidAttribute("BEA6BB4F-A905-49CA-A216-202DF370E07E")] 
[InterfaceTypeAttribute(1)] 
public interface IVsRunningDocTableEvents

Copy

/** @attribute GuidAttribute("BEA6BB4F-A905-49CA-A216-202DF370E07E") */ 
/** @attribute InterfaceTypeAttribute(1) */ 
public interface IVsRunningDocTableEvents

JScript

Copy

GuidAttribute("BEA6BB4F-A905-49CA-A216-202DF370E07E") 
InterfaceTypeAttribute(1) 
public interface IVsRunningDocTableEvents

Remarks

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:

To get more information about document renaming, implement the IVsRunningDocTableEvents2 interface.
To get more information before a document is saved, implement the IVsRunningDocTableEvents3 interface.
To receive notification before the first lock on a document is applied (giving you a chance to load the document), implement the IVsRunningDocTableEvents4 interface.

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.

Reference

IVsRunningDocTableEvents Members
Microsoft.VisualStudio.Shell.Interop Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ