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)
Syntax
'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("A928AA21-EA77-47AC-8A07-355206C94BDD")> _
Public Interface IVsRunningDocumentTable
[InterfaceTypeAttribute()]
[GuidAttribute("A928AA21-EA77-47AC-8A07-355206C94BDD")]
public interface IVsRunningDocumentTable
[InterfaceTypeAttribute()]
[GuidAttribute(L"A928AA21-EA77-47AC-8A07-355206C94BDD")]
public interface class IVsRunningDocumentTable
[<InterfaceTypeAttribute()>]
[<GuidAttribute("A928AA21-EA77-47AC-8A07-355206C94BDD")>]
type IVsRunningDocumentTable = interface end
public interface IVsRunningDocumentTable
The IVsRunningDocumentTable type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AdviseRunningDocTableEvents | Enables the client to receive notifications of changes to the Running Document Table (RDT). |
|
FindAndLockDocument | Locates a document in the RDT using the document file name, then obtains a read or edit lock on that document. |
|
GetDocumentInfo | Returns information about a document registered in the RDT, given the cookie. |
|
GetRunningDocumentsEnum | Enumerates through all documents in the RDT. |
|
LockDocument | Obtains a read or edit lock on a document when it is opened. |
|
ModifyDocumentFlags | Modifies the RDT document flags for a registered document. |
|
NotifyDocumentChanged | Notifies the client when changes are made to the document. |
|
NotifyOnAfterSave | Fires after a document in the RDT has been saved. |
|
NotifyOnBeforeSave | Fires before a document in the RDT is saved. |
|
RegisterAndLockDocument | Creates an entry in the running document table when a document is created or opened. |
|
RegisterDocumentLockHolder | Registers a document lock holder in the running document table. |
|
RenameDocument | Renames and/or changes the ownership of a document. |
|
SaveDocuments | Saves the documents. |
|
UnadviseRunningDocTableEvents | Disables the client from receiving notifications of changes to the RDT. |
|
UnlockDocument | Releases a read or edit lock on the open document. |
|
UnregisterDocumentLockHolder | Unregisters a document lock holder in the running document table. |
Top
Remarks
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.