Share via


DesignerDocDataService Class

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

This API is not CLS-compliant. 

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Shell.Design.Serialization.DesignerDocDataService

Namespace:  Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DesignerDocDataService _
    Implements IDisposable, IVsRunningDocTableEvents, IVsRunningDocTableEvents2, IVsHasRelatedSaveItems
[CLSCompliantAttribute(false)]
public class DesignerDocDataService : IDisposable, 
    IVsRunningDocTableEvents, IVsRunningDocTableEvents2, IVsHasRelatedSaveItems
[CLSCompliantAttribute(false)]
public ref class DesignerDocDataService : IDisposable, 
    IVsRunningDocTableEvents, IVsRunningDocTableEvents2, IVsHasRelatedSaveItems
[<CLSCompliantAttribute(false)>]
type DesignerDocDataService =  
    class 
        interface IDisposable 
        interface IVsRunningDocTableEvents 
        interface IVsRunningDocTableEvents2 
        interface IVsHasRelatedSaveItems 
    end
public class DesignerDocDataService implements IDisposable, IVsRunningDocTableEvents, IVsRunningDocTableEvents2, IVsHasRelatedSaveItems

The DesignerDocDataService type exposes the following members.

Constructors

  Name Description
Public method DesignerDocDataService(IServiceProvider, IVsHierarchy, UInt32, DocData) Initializes a new instance of DesignerDocDataService.
Public method DesignerDocDataService(IServiceProvider, IVsHierarchy, UInt32, Object) Initializes a new instance of DesignerDocDataService for the specified node and document data.

Top

Properties

  Name Description
Public property PrimaryDocData Gets the document data object for the primaryDocData that was passed into either of this service's overloaded constructors DesignerDocDataService or DesignerDocDataService.
Protected property PrimaryName Gets the fully-qualified file name of the primary doc data object.
Public property 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.

Top

Methods

  Name Description
Public method CheckoutFiles Ensures that all relevant buffers are checked out.
Public method Dispose Disposes the service.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Flush Performs a forced flush of all pending changes to the designer.
Public method GetChildDocData Gets a DocData with the given name.
Protected method GetChildFileName Returns the absolute path of a child file from its name.
Public method GetFileDocData(String, FileAccess, String) Gets a DocData with the given name.
Public method GetFileDocData(String, FileAccess, String, Boolean) Gets a DocData with the given name.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetSiblingDocData Gets a DocData with the given name.
Protected method GetSiblingFileName Gets the absolute path of the sibling file name from the file name.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HasChild Determines whether or not there is a child DocData with a given name.
Public method HasFile Determines whether or not there is a DocData with a given fileName.
Public method HasSibling Determines whether or not there is a sibling DocData with the specified name.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SaveDocData Performs a save on the given doc data.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsHasRelatedSaveItems.GetRelatedSaveTreeItems Coordinates save operations across the documents maintained by this service.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents.OnAfterAttributeChange Called after an attribute has changed on a document in the Running Document Table.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents.OnAfterDocumentWindowHide Called after a document window is hidden.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents.OnAfterFirstDocumentLock Called after the first lock of the specified type is applied to the specified document in the Running Document Table (RDT).
Explicit interface implemetationPrivate method IVsRunningDocTableEvents.OnAfterSave Called after a document in the Running Document Table (RDT) is saved.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents.OnBeforeDocumentWindowShow Called before a document window is displayed.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents.OnBeforeLastDocumentUnlock Called before the last lock of the specified type is released on the specified document in the Running Document Table (RDT).
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnAfterAttributeChange Called after an attribute has changed on a document in the Running Document Table.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnAfterAttributeChangeEx Called after an attribute has changed on a document in the Running Document Table.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnAfterDocumentWindowHide Called after a document window is hidden.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnAfterFirstDocumentLock Called after the first lock of the specified type is applied to the specified document in the Running Document Table (RDT).
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnAfterSave Called after a document in the Running Document Table (RDT) is saved.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnBeforeDocumentWindowShow Called before a document window is displayed.
Explicit interface implemetationPrivate method IVsRunningDocTableEvents2.OnBeforeLastDocumentUnlock Called before the last lock of the specified type is released on the specified document in the Running Document Table (RDT).

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Shell.Design.Serialization Namespace