ModelingDocData Class

Represents a document in the Store.

This API is not CLS-compliant. 

Inheritance Hierarchy

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

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.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
	ModelingDocData	Initializes a new instance of the ModelingDocData class.

Top

Properties

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

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IVsFileBackup.BackupFile	Make a single file backup of this document. (Inherited from DocData.)
	IDisposable.Dispose	Releases all resources used by the current instance of the DocData class. (Inherited from DocData.)
	IPersistFileFormat.GetClassID	Gets the class ID of the editor factory that created the document. (Inherited from DocData.)
	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