ModelingDocData Class
Represents a document in the Store.
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)
System::MarshalByRefObject
Microsoft.VisualStudio.Modeling.Shell::DocData
Microsoft.VisualStudio.Modeling.Shell::ModelingDocData
| Name | Description | |
|---|---|---|
![]() | ModelingDocData(IServiceProvider^, Guid) | Initializes a new instance of the ModelingDocData class. |
| 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.) |
| Name | Description | |
|---|---|---|
![]() | AddErrorListItem(ModelingErrorListItem^) | Adds an error or warning message that you can use with the document. |
![]() | BackupFile(String^) | Make a single file backup of this document. Returns whether the document is expected to re-load without data loss. (Inherited from DocData.) |
![]() | CanSave(Boolean) | 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(Store^) | Creates a document for the modeling designer store. |
![]() | CreateObject(ILocalRegistry^, Guid, Guid) | Creates an object |
![]() | CreateObjRef(Type^) | (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(IServiceProvider^) | Create a subordinate doc data instance |
![]() | DirectoryChanged(String^) | Not currently implemented.(Inherited from DocData.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the ModelingDocData and optionally releases the managed resources.(Overrides DocData::Dispose(Boolean).) |
![]() | Equals(Object^) | (Inherited from Object.) |
![]() | FilesChanged(UInt32, array<String^>^, array<UInt32>^) | Notifies clients that one or more documents changed.(Inherited from DocData.) |
![]() | Finalize() | (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(Guid) | Gets the GUID of the editor factory that created the document.(Inherited from DocData.) |
![]() | GetCurFile(String^, UInt32) | Gets the file name of the document.(Inherited from DocData.) |
![]() | GetData(Guid, Object^) | Gets the document data from a buffer.(Inherited from DocData.) |
![]() | GetDomainModels() | Gets a collection of types to be loaded into the store. |
![]() | GetFormatList(String^) | Gets the list of supported document formats.(Inherited from DocData.) |
![]() | GetGuidEditorType(Guid) | Gets the GUID of the editor factory that created the IVsPersistDocData object.(Inherited from DocData.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetLifetimeService() | (Inherited from MarshalByRefObject.) |
![]() | GetRelatedSaveTreeItems(VSSAVETREEITEM, UInt32, array<VSSAVETREEITEM>^, UInt32) | 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(Type^) | Serve up local services to the Store and users of the Stores service provider(Overrides DocData::GetService(Type^).) |
![]() | GetTextBuffer(IVsTextLines^) | Loads the serialized model into a new buffer. |
![]() | GetType() | (Inherited from Object.) |
![]() | HandleLoadDocDataException(String^, Exception^, Boolean) | Manages any exceptions that were thrown when the document was loading.(Inherited from DocData.) |
![]() | HandleSaveDocDataException(String^, Exception^) | 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(Int32) | 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() | (Inherited from MarshalByRefObject.) |
![]() | InitNew(UInt32) | Initializes the document.(Inherited from DocData.) |
![]() | IsDirty(Int32) | Verifies whether the document has changed since the most recent save operation.(Inherited from DocData.) |
![]() | IsDocDataDirty(Int32) | Verifies whether the document has changed since the most recent save operation.(Inherited from DocData.) |
![]() | IsDocDataReadOnly(Int32) | Verifies whether the document is read-only.(Inherited from DocData.) |
![]() | IsDocDataReloadable(Int32) | 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(Int32) | Not implemented. |
![]() | MarkDocumentChangedForBackup() | Mark that the document has changed and thus a new backup should be created(Inherited from DocData.) |
![]() | MemberwiseClone() | (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
![]() | OnDocumentClosed(EventArgs^) | Called when the document is closed. Default behavior clears the error list content.(Overrides DocData::OnDocumentClosed(EventArgs^).) |
![]() | OnDocumentClosing(EventArgs^) | Alerts listeners that the document will be closed.(Inherited from DocData.) |
![]() | OnDocumentLoaded(EventArgs^) | Alerts listeners that the document is loaded.(Inherited from DocData.) |
![]() | OnDocumentLoading(EventArgs^) | Alerts listeners that the document will be loaded.(Inherited from DocData.) |
![]() | OnDocumentReadOnlyChanged(EventArgs^) | Alerts listeners that the read-only state of the document has changed.(Inherited from DocData.) |
![]() | OnDocumentReloaded(EventArgs^) | Alerts listeners that the document has been reloaded.(Inherited from DocData.) |
![]() | OnDocumentReloading(EventArgs^) | Alerts listeners that the document will be reloaded.(Inherited from DocData.) |
![]() | OnDocumentSaved(EventArgs^) | Alerts listeners that the document has been saved.(Inherited from DocData.) |
![]() | OnDocumentSaving(EventArgs^) | Alerts listeners that the document will be saved.(Inherited from DocData.) |
![]() | OnFileNameChanged(EventArgs^) | Alerts listeners that the file name of the document has changed.(Inherited from DocData.) |
![]() | OnHierarchyChanged(EventArgs^) | Called when a document is added or renamed.(Overrides DocData::OnHierarchyChanged(EventArgs^).) |
![]() | OnRegisterDocData(UInt32, IVsHierarchy^, UInt32) | Assigns the document to a cookie and project hierarchy.(Inherited from DocData.) |
![]() | OpenView(Guid, Object^) | 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(UInt32) | Reloads the document.(Inherited from DocData.) |
![]() | ReloadDocDataWorker(UInt32) | Reloads the document.(Inherited from DocData.) |
![]() | RenameDocData(UInt32, IVsHierarchy^, UInt32, String^) | 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(String^) | 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(String^) | Alerts listeners that the document has been saved.(Inherited from DocData.) |
![]() | SaveDocData(VSSAVEFLAGS, String^, Int32) | Saves the document to a specific location.(Inherited from DocData.) |
![]() | SaveDocDataToFile(VSSAVEFLAGS, String^, Int32, IVsUIShell^) | Saves the document to a specific location.(Inherited from DocData.) |
![]() | SaveSubordinateFile(DocData^, String^) | Save the specified document that is subordinate to this document, for example a diagram file.(Inherited from DocData.) |
![]() | SetData(Guid, Object^) | Sets the document to a buffer.(Inherited from DocData.) |
![]() | SetDocDataDirty(Int32) | |
![]() | SetDocDataReadOnly(Int32) | Sets the document's read-only flag.(Inherited from DocData.) |
![]() | SetFileName(String^) | Initializes or changes the file name for the document.(Inherited from DocData.) |
![]() | SetHierarchyInfo(IVsHierarchy^, UInt32) | Initializes or changes the project hierarchy for the document.(Inherited from DocData.) |
![]() | SetRootElement(ModelElement^) | Sets the root element. |
![]() | SetTextBuffer(IVsTextLines^) | Not implemented. |
![]() | SetUntitledDocPath(String^) | Currently not implemented.(Inherited from DocData.) |
![]() | ShowErrorListItems() | Shows all error and warning messages in the Error List window. |
![]() | ShowSaveOptionsDlg(UInt32, IntPtr, IntPtr) | Shows a dialog box from which the user can specify additional options for save formats.(Inherited from DocData.) |
![]() | SupportsLogicalView(Guid) | Verifies whether the document supports the specified view. |
![]() | SuspendErrorListRefresh() | Prevents the Error List window from refreshing. |
![]() | SuspendFileChangeNotification(String^) | Suspends the distribution of document-change notifications for the document.(Inherited from DocData.) |
![]() | ToString() | (Inherited from Object.) |
| 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.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IPersistFileFormat::GetClassID(Guid) | Gets the class ID of the editor factory that created the document. (Inherited from DocData.) |
![]() ![]() | IVsFileBackup::BackupFile(String^) | Make a single file backup of this document.(Inherited from DocData.) |
![]() ![]() | IVsFileBackup::IsBackupFileObsolete(Int32) | Get whether the backup file is up to date.(Inherited from DocData.) |
![]() ![]() | IDisposable::Dispose() |
The document in memory is backed by an in-memory store.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.






