IVsRunningDocumentTable Interface

Manages the set of currently open documents in the environment.

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

public interface IVsRunningDocumentTable

The IVsRunningDocumentTable type exposes the following members.

Public methodAdviseRunningDocTableEventsEnables the client to receive notifications of changes to the Running Document Table (RDT).
Public methodFindAndLockDocumentLocates a document in the RDT using the document file name, then obtains a read or edit lock on that document.
Public methodGetDocumentInfoReturns information about a document registered in the RDT, given the cookie.
Public methodGetRunningDocumentsEnumEnumerates through all documents in the RDT.
Public methodLockDocumentObtains a read or edit lock on a document when it is opened.
Public methodModifyDocumentFlagsModifies the RDT document flags for a registered document.
Public methodNotifyDocumentChangedNotifies the client when changes are made to the document.
Public methodNotifyOnAfterSaveFires after a document in the RDT has been saved.
Public methodNotifyOnBeforeSaveFires before a document in the RDT is saved.
Public methodRegisterAndLockDocumentCreates an entry in the running document table when a document is created or opened.
Public methodRegisterDocumentLockHolderRegisters a document lock holder in the running document table.
Public methodRenameDocumentRenames and/or changes the ownership of a document.
Public methodSaveDocumentsSaves the documents.
Public methodUnadviseRunningDocTableEventsDisables the client from receiving notifications of changes to the RDT.
Public methodUnlockDocumentReleases a read or edit lock on the open document.
Public methodUnregisterDocumentLockHolderUnregisters a document lock holder in the running document table.

Notes to Implementers

Implemented by the environment.

Notes to Callers

Called by VSPackages that open and track documents in their projects. Obtain this interface by calling QueryService on a site provider with the service ID SVsRunningDocumentTable and the interface GUID of the IVsRunningDocumentTable interface.

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