ModelingDocData Class

  • Article

Represents a document in the Store.

This API is not CLS-compliant. 

Inheritance Hierarchy

Object
  MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.DocData
      Microsoft.VisualStudio.Modeling.Shell.ModelingDocData

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class ModelingDocData _
    Inherits DocData _
    Implements IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

[CLSCompliantAttribute(false)]
public abstract class ModelingDocData : DocData, 
    IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

[CLSCompliantAttribute(false)]
public ref class ModelingDocData abstract : public DocData, 
    IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type ModelingDocData =  
    class 
        inherit DocData 
        interface IVsTextBufferProvider 
        interface IServiceProvider 
        interface IVsHasRelatedSaveItems 
    end

public abstract class ModelingDocData extends DocData implements IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

The ModelingDocData type exposes the following members.

Constructors

  Name Description
Protected method ModelingDocData Initializes a new instance of the ModelingDocData class.

Top

Properties

  Name Description
Public property Cookie Gets the cookie that identifies the document in the Running Documents table. (Inherited from DocData.)
Public property DocViews Gets the collection of document views that are open for the document. (Inherited from DocData.)
Public property Encoding Gets or sets the encoding that persists the document. (Inherited from DocData.)
Public property ErrorListProvider Gets the error list provider for the document.
Public property FileName Gets the file name of the document. (Inherited from DocData.)
Protected property FormatList Gets a list of formats. (Inherited from DocData.)
Public property HasErrorListItems Gets the error list and verifies whether errors and warnings for the document appear in the Error List window.
Public property Hierarchy Gets the project hierarchy to which the document belongs. (Inherited from DocData.)
Protected property InLoad Gets the document and verifies whether it is being loaded into the modeling window.
Protected property InReload Gets the document and verifies whether it is being reloaded into the modeling window.
Protected property IsBackupFileObsolete (Inherited from DocData.)
Public property IsLoaded Gets the document and verifies whether it is loaded. (Inherited from DocData.)
Public property ItemId Gets the Item ID that is assigned to the document. (Inherited from DocData.)
Public property ModelingDocStore Gets the modeling designer store that is assigned to the document.
Protected property PartitionMapper
Protected property RelatedDocList
Public property RootElement Gets the root element in the document.
Protected property SerializedModel
Protected property ServiceProvider Gets the service provider from the shell. (Inherited from DocData.)
Public property Store Gets the modeling designer store to which this document is assigned.
Public property UndoManager Gets the UndoManager class, which you can use to undo and redo operations in the modeling designer store. (Overrides DocData.UndoManager.)
Protected property UndoManagerIsShared Gets the UndoManager class and verifies whether it is shared among documents. (Overrides DocData.UndoManagerIsShared.)
Public property VSUndoManager Gets the UndoManager interface. (Inherited from DocData.)

Top

Methods

  Name Description
Public method AddErrorListItem Adds an error or warning message that you can use with the document.
Protected method BackupFile Make a single file backup of this document. Returns whether the document is expected to re-load without data loss. (Inherited from DocData.)
Protected method CanSave Verifies whether the user can cancel the save operation. (Inherited from DocData.)
Protected method CleanupStores Clears the modeling designer stores before a document is reloaded into memory.
Public method ClearErrorListItems Clears the error and warning messages from the Error List window.
Public method Close Closes the document. (Inherited from DocData.)
Protected method CreateModelingDocStore Creates a document for the modeling designer store.
Protected method CreateObject Creates an object
Public method CreateObjRef Security Critical. Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Protected method CreatePartitionMapper Factory method to create the partition mapper responsible for mapping elements to the correct partitions of the store owned by this ModelingDocData when ElementGroupPrototypes are reconstituted.
Protected method CreateStore Creates a modeling store.
Protected method CreateSubordinateDocData Create a subordinate doc data instance
Public method DirectoryChanged Not currently implemented. (Inherited from DocData.)
Protected method Dispose Releases the unmanaged resources used by the ModelingDocData and optionally releases the managed resources. (Overrides DocData.Dispose(Boolean).)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method FilesChanged Notifies clients that one or more documents changed. (Inherited from DocData.)
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 FlushUndoManager Clears the UndoManager class for the store. (Overrides DocData.FlushUndoManager().)
Public method GetAllElementsForValidation Get all elements for validation. The base implementation returns all elements in the store of this DocData.
Public method GetClassID Gets the GUID of the editor factory that created the document. (Inherited from DocData.)
Public method GetCurFile Gets the file name of the document. (Inherited from DocData.)
Public method GetData Gets the document data from a buffer. (Inherited from DocData.)
Protected method GetDomainModels Gets a collection of types to be loaded into the store.
Public method GetFormatList Gets the list of supported document formats. (Inherited from DocData.)
Public method GetGuidEditorType Gets the GUID of the editor factory that created the IVsPersistDocData object. (Inherited from DocData.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetRelatedSaveTreeItems Standard implementation of IVsHasRelatedSaveItems. If another DocData was registered using the IRelatedDocList interface with this instance, it will potentially be returned as a RelatedSaveTreeItem.
Public method GetService Serve up local services to the Store and users of the Stores service provider (Overrides DocData.GetService(Type).)
Public method GetTextBuffer Loads the serialized model into a new buffer.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method HandleLoadDocDataException Manages any exceptions that were thrown when the document was loading. (Inherited from DocData.)
Protected method HandleSaveDocDataException Manages any exceptions that were thrown when the document was saving. (Inherited from DocData.)
Public method HideErrorListItems Hides all error and warning messages that are in the Error List window.
Public method IgnoreFileChanges Determines whether changes to the document should be ignored. (Inherited from DocData.)
Public method Initialize() Initializes the ModelingDocData class.
Public method Initialize(Store) Initializes the modeling designer store for the document.
Public method InitializeLifetimeService Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method InitNew Initializes the document. (Inherited from DocData.)
Public method IsDirty Verifies whether the document has changed since the most recent save operation. (Inherited from DocData.)
Public method IsDocDataDirty Verifies whether the document has changed since the most recent save operation. (Inherited from DocData.)
Public method IsDocDataReadOnly Verifies whether the document is read-only. (Inherited from DocData.)
Public method IsDocDataReloadable Verifies whether the document can be reloaded. (Inherited from DocData.)
Protected method IsFlushUndoStackRequiredOnLoad Override this method to specify if the undo stack is to be flushed after loading (opening, or creating) the docdata.
Protected method Load(String, Boolean) Loads the document into memory. (Inherited from DocData.)
Public method Load(String, UInt32, Int32) Loads the document into memory. (Inherited from DocData.)
Public method LoadDocData(String) Loads the document by using its file name. (Inherited from DocData.)
Protected method LoadDocData(String, Boolean) Loads a document that has a specific file name. (Overrides DocData.LoadDocData(String, Boolean).)
Public method LockTextBuffer Not implemented.
Public method MarkDocumentChangedForBackup Mark that the document has changed and thus a new backup should be created (Inherited from DocData.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnDocumentClosed Called when the document is closed. Default behavior clears the error list content. (Overrides DocData.OnDocumentClosed(EventArgs).)
Protected method OnDocumentClosing Alerts listeners that the document will be closed. (Inherited from DocData.)
Protected method OnDocumentLoaded Alerts listeners that the document is loaded. (Inherited from DocData.)
Protected method OnDocumentLoading Alerts listeners that the document will be loaded. (Inherited from DocData.)
Protected method OnDocumentReadOnlyChanged Alerts listeners that the read-only state of the document has changed. (Inherited from DocData.)
Protected method OnDocumentReloaded Alerts listeners that the document has been reloaded. (Inherited from DocData.)
Protected method OnDocumentReloading Alerts listeners that the document will be reloaded. (Inherited from DocData.)
Protected method OnDocumentSaved Alerts listeners that the document has been saved. (Inherited from DocData.)
Protected method OnDocumentSaving Alerts listeners that the document will be saved. (Inherited from DocData.)
Protected method OnFileNameChanged Alerts listeners that the file name of the document has changed. (Inherited from DocData.)
Protected method OnHierarchyChanged Called when a document is added or renamed. (Overrides DocData.OnHierarchyChanged(EventArgs).)
Public method OnRegisterDocData Assigns the document to a cookie and project hierarchy. (Inherited from DocData.)
Public method OpenView Opens a specific view for the document. (Overrides DocData.OpenView(Guid, Object).)
Public method QueryEditFile() Alerts listeners that a document is about to be edited. Listeners can vote against the edit. (Inherited from DocData.)
Public method QueryEditFile(String, tagVSQueryEditFlags) Alerts listeners that a document is about to be edited. Listeners can vote against the edit. (Inherited from DocData.)
Public method QuerySaveFile() Alerts listeners that a file is about to be saved. Listeners can (Inherited from DocData.)
Public method QuerySaveFile(String, tagVSQuerySaveFlags) Alerts listeners that a file is about to be saved. (Inherited from DocData.)
Public method ReloadDocData Reloads the document. (Inherited from DocData.)
Protected method ReloadDocDataWorker Reloads the document. (Inherited from DocData.)
Public method RenameDocData Renames a document and resets its position in the hierarchy. (Inherited from DocData.)
Public method ResumeErrorListRefresh Refreshes the Error List window every time that an error or warning message is added for the document.
Protected method ResumeFileChangeNotification Resumes the distribution of document-change notifications for the document. (Inherited from DocData.)
Protected method Save(String) Saves the document. (Inherited from DocData.)
Public method Save(String, Int32, UInt32) Saves the document. (Inherited from DocData.)
Public method SaveCompleted Alerts listeners that the document has been saved. (Inherited from DocData.)
Public method SaveDocData Saves the document to a specific location. (Inherited from DocData.)
Protected method SaveDocDataToFile Saves the document to a specific location. (Inherited from DocData.)
Protected method SaveSubordinateFile Save the specified document that is subordinate to this document, for example a diagram file. (Inherited from DocData.)
Public method SetData Sets the document to a buffer. (Inherited from DocData.)
Public method SetDocDataDirty Sets the document's IsDirty flag. (Inherited from DocData.)
Public method SetDocDataReadOnly Sets the document's read-only flag. (Inherited from DocData.)
Protected method SetFileName Initializes or changes the file name for the document. (Inherited from DocData.)
Protected method SetHierarchyInfo Initializes or changes the project hierarchy for the document. (Inherited from DocData.)
Protected method SetRootElement Sets the root element.
Public method SetTextBuffer Not implemented.
Public method SetUntitledDocPath Currently not implemented. (Inherited from DocData.)
Public method ShowErrorListItems Shows all error and warning messages in the Error List window.
Public method ShowSaveOptionsDlg Shows a dialog box from which the user can specify additional options for save formats. (Inherited from DocData.)
Public method SupportsLogicalView Verifies whether the document supports the specified view.
Public method SuspendErrorListRefresh Prevents the Error List window from refreshing.
Protected method SuspendFileChangeNotification Suspends the distribution of document-change notifications for the document. (Inherited from DocData.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event DocumentClosed Occurs after the document is closed. (Inherited from DocData.)
Public event DocumentClosing Occurs before the document is closed. (Inherited from DocData.)
Public event DocumentLoaded Occurs after the document has been loaded in the modeling window. (Inherited from DocData.)
Public event DocumentLoading Occurs before the document is loaded in the modeling window. (Inherited from DocData.)
Public event DocumentReadOnlyChanged Occurs when the read-only flag for the document changes. (Inherited from DocData.)
Public event DocumentReloaded Occurs after the document is reloaded. (Inherited from DocData.)
Public event DocumentReloading Occurs before the document is reloaded. (Inherited from DocData.)
Public event DocumentSaved Occurs after the document is saved. (Inherited from DocData.)
Public event DocumentSaving Occurs before the document is saved. (Inherited from DocData.)
Public event FileNameChanged Occurs when the document's file name changes. (Inherited from DocData.)
Public event HierarchyChanged Occurs when the document's hierarchy or Item ID changes. (Inherited from DocData.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsFileBackup.BackupFile Make a single file backup of this document. (Inherited from DocData.)
Explicit interface implemetationPrivate method IDisposable.Dispose Releases all resources used by the current instance of the DocData class. (Inherited from DocData.)
Explicit interface implemetationPrivate method IPersistFileFormat.GetClassID Gets the class ID of the editor factory that created the document. (Inherited from DocData.)
Explicit interface implemetationPrivate method IVsFileBackup.IsBackupFileObsolete Get whether the backup file is up to date. (Inherited from DocData.)

Top

Remarks

The document in memory is backed by an in-memory store.

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.Modeling.Shell Namespace