IVsRunningDocTableEvents Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Implements methods that fire in response to changes to documents in the Running Document Table (RDT).
public interface class IVsRunningDocTableEventspublic interface class IVsRunningDocTableEvents__interface IVsRunningDocTableEvents[System.Runtime.InteropServices.Guid("BEA6BB4F-A905-49CA-A216-202DF370E07E")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsRunningDocTableEvents[System.Runtime.InteropServices.Guid("BEA6BB4F-A905-49CA-A216-202DF370E07E")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsRunningDocTableEvents[<System.Runtime.InteropServices.Guid("BEA6BB4F-A905-49CA-A216-202DF370E07E")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsRunningDocTableEvents = interface[<System.Runtime.InteropServices.Guid("BEA6BB4F-A905-49CA-A216-202DF370E07E")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsRunningDocTableEvents = interfacePublic Interface IVsRunningDocTableEvents- Derived
- Attributes
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(UInt32, String, IVsHierarchy, UInt32, IntPtr, UInt32) or RegisterAndLockDocument(UInt32, String, IVsHierarchy, UInt32, IntPtr, UInt32) methods in the IVsRunningDocumentTable interface.
Notes to Callers
The environment calls this interface when specific events have occurred.
Methods
| OnAfterAttributeChange(UInt32, UInt32) |
Called after a change in an attribute of a document in the Running Document Table (RDT). |
| OnAfterDocumentWindowHide(UInt32, IVsWindowFrame) |
Called after a document window is placed in the Hide state. |
| OnAfterFirstDocumentLock(UInt32, UInt32, UInt32, UInt32) |
Called after application of the first lock of the specified type to the specified document in the Running Document Table (RDT). |
| OnAfterSave(UInt32) |
Called after saving a document in the Running Document Table (RDT). |
| OnBeforeDocumentWindowShow(UInt32, Int32, IVsWindowFrame) |
Called before displaying a document window. |
| OnBeforeLastDocumentUnlock(UInt32, UInt32, UInt32, UInt32) |
Called before releasing the last lock of the specified type on the specified document in the Running Document Table (RDT). |