DesignerDocDataService Class

Definition

Important

This API is not CLS-compliant.

Provides a way to create and retrieve buffers for various files in the project.

public ref class DesignerDocDataService : IDisposable, Microsoft::VisualStudio::Shell::Interop::IVsHasRelatedSaveItems, Microsoft::VisualStudio::Shell::Interop::IVsRunningDocTableEvents2
[System.CLSCompliant(false)]
public class DesignerDocDataService : IDisposable, Microsoft.VisualStudio.Shell.Interop.IVsHasRelatedSaveItems, Microsoft.VisualStudio.Shell.Interop.IVsRunningDocTableEvents2
type DesignerDocDataService = class
    interface IDisposable
    interface IVsRunningDocTableEvents
    interface IVsRunningDocTableEvents2
    interface IVsHasRelatedSaveItems
Public Class DesignerDocDataService
Implements IDisposable, IVsHasRelatedSaveItems, IVsRunningDocTableEvents2
Inheritance
DesignerDocDataService
Attributes
Implements

Constructors

DesignerDocDataService(IServiceProvider, IVsHierarchy, UInt32, DocData)

Initializes a new instance of DesignerDocDataService.

DesignerDocDataService(IServiceProvider, IVsHierarchy, UInt32, Object)

Initializes a new instance of DesignerDocDataService for the specified node and document data.

Properties

PrimaryDocData

Gets the document data object for the primaryDocData that was passed into either of this service's overloaded constructors DesignerDocDataService(IServiceProvider, IVsHierarchy, UInt32, DocData) or DesignerDocDataService(IServiceProvider, IVsHierarchy, UInt32, Object).

PrimaryName

Gets the fully-qualified file name of the primary doc data object.

UseWeakEditLock

Determines whether the DesignerDocDataService instance holds a weak or strong edit lock on the child documents. The default value is false (strong edit lock). Normal designers in document windows should use strong edit lock. Advanced invisible designers should use weak locks, so that when the child document is opened in a visible editor, the control of the edit lock is yielded to the visible editor. The user is then prompted to save the document when the visible editor is closed.

Methods

CheckoutFiles()

Ensures that all relevant buffers are checked out.

Dispose()

Disposes the service.

Flush()

Performs a forced flush of all pending changes to the designer.

GetChildDocData(String, FileAccess, String)

Gets a DocData with the given name.

GetChildFileName(String)

Returns the absolute path of a child file from its name.

GetFileDocData(String, FileAccess, String)

Gets a DocData with the given name.

GetFileDocData(String, FileAccess, String, Boolean)

Gets a DocData with the given name.

GetSiblingDocData(String, FileAccess, String)

Gets a DocData with the given name.

GetSiblingFileName(String)

Gets the absolute path of the sibling file name from the file name.

HasChild(String)

Determines whether or not there is a child DocData with a given name.

HasFile(String)

Determines whether or not there is a DocData with a given fileName.

HasSibling(String)

Determines whether or not there is a sibling DocData with the specified name.

SaveDocData(DocData)

Performs a save on the given doc data.

Explicit Interface Implementations

IVsHasRelatedSaveItems.GetRelatedSaveTreeItems(VSSAVETREEITEM, UInt32, VSSAVETREEITEM[], UInt32)

Coordinates save operations across the documents maintained by this service.

IVsRunningDocTableEvents.OnAfterAttributeChange(UInt32, UInt32)

Called after an attribute has changed on a document in the Running Document Table.

IVsRunningDocTableEvents.OnAfterDocumentWindowHide(UInt32, IVsWindowFrame)

Called after a document window is hidden.

IVsRunningDocTableEvents.OnAfterFirstDocumentLock(UInt32, UInt32, UInt32, UInt32)

Called after the first lock of the specified type is applied to the specified document in the Running Document Table (RDT).

IVsRunningDocTableEvents.OnAfterSave(UInt32)

Called after a document in the Running Document Table (RDT) is saved.

IVsRunningDocTableEvents.OnBeforeDocumentWindowShow(UInt32, Int32, IVsWindowFrame)

Called before a document window is displayed.

IVsRunningDocTableEvents.OnBeforeLastDocumentUnlock(UInt32, UInt32, UInt32, UInt32)

Called before the last lock of the specified type is released on the specified document in the Running Document Table (RDT).

IVsRunningDocTableEvents2.OnAfterAttributeChange(UInt32, UInt32)

Called after an attribute has changed on a document in the Running Document Table.

IVsRunningDocTableEvents2.OnAfterAttributeChangeEx(UInt32, UInt32, IVsHierarchy, UInt32, String, IVsHierarchy, UInt32, String)

Called after an attribute has changed on a document in the Running Document Table.

IVsRunningDocTableEvents2.OnAfterDocumentWindowHide(UInt32, IVsWindowFrame)

Called after a document window is hidden.

IVsRunningDocTableEvents2.OnAfterFirstDocumentLock(UInt32, UInt32, UInt32, UInt32)

Called after the first lock of the specified type is applied to the specified document in the Running Document Table (RDT).

IVsRunningDocTableEvents2.OnAfterSave(UInt32)

Called after a document in the Running Document Table (RDT) is saved.

IVsRunningDocTableEvents2.OnBeforeDocumentWindowShow(UInt32, Int32, IVsWindowFrame)

Called before a document window is displayed.

IVsRunningDocTableEvents2.OnBeforeLastDocumentUnlock(UInt32, UInt32, UInt32, UInt32)

Called before the last lock of the specified type is released on the specified document in the Running Document Table (RDT).

Applies to