IVsRunningDocTableEvents3 Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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 IVsRunningDocTableEvents3 : Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents2

public interface class IVsRunningDocTableEvents3 : Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents2

__interface IVsRunningDocTableEvents3 : Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents2

[System.Runtime.InteropServices.Guid("376ED667-F576-458F-B991-2CFD3EBC7B08")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsRunningDocTableEvents3 : Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents2

[System.Runtime.InteropServices.Guid("376ED667-F576-458F-B991-2CFD3EBC7B08")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsRunningDocTableEvents3 : Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents2

[<System.Runtime.InteropServices.Guid("376ED667-F576-458F-B991-2CFD3EBC7B08")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsRunningDocTableEvents3 = interface
    interface IVsRunningDocTableEvents2

[<System.Runtime.InteropServices.Guid("376ED667-F576-458F-B991-2CFD3EBC7B08")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsRunningDocTableEvents3 = interface
    interface IVsRunningDocTableEvents2
    interface IVsRunningDocTableEvents

Public Interface IVsRunningDocTableEvents3
Implements IVsRunningDocTableEvents2

Attributes: GuidAttribute InterfaceTypeAttribute

Implements: IVsRunningDocTableEvents IVsRunningDocTableEvents2

Remarks

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(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 on the occurrence of specific events. In particular, the environment calls this interface before saving a document.

Methods

OnAfterAttributeChange(UInt32, UInt32)	Called after an attribute of a document in the Running Document Table (RDT) changes.
OnAfterAttributeChangeEx(UInt32, UInt32, IVsHierarchy, UInt32, String, IVsHierarchy, UInt32, String)	Called after a document attribute is changed. This is an advanced version of the OnAfterAttributeChange(UInt32, UInt32) method.
OnAfterDocumentWindowHide(UInt32, IVsWindowFrame)	Called after a document window is hidden.
OnAfterFirstDocumentLock(UInt32, UInt32, UInt32, UInt32)	Called after application of the first lock of the specified type to a document in the Running Document Table (RDT).
OnAfterSave(UInt32)	Called after a document in the Running Document Table (RDT) is saved.
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).
OnBeforeSave(UInt32)	Called before saving a document.

Applies to

Partilhar via