DocData Class
When overridden in a derived class, represents a document in memory.
This API is not CLS-compliant.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
Microsoft.VisualStudio.Modeling.Shell.DocData
Microsoft.VisualStudio.Modeling.Shell.ModelingDocData
Microsoft.VisualStudio.Modeling.Shell.SubordinateDocData
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 DocData _
Inherits MarshalByRefObject _
Implements IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, _
IPersistFileFormat, IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, _
IVsFileBackup, IServiceProvider
[CLSCompliantAttribute(false)]
public abstract class DocData : MarshalByRefObject,
IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, IPersistFileFormat,
IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, IVsFileBackup,
IServiceProvider
[CLSCompliantAttribute(false)]
public ref class DocData abstract : public MarshalByRefObject,
IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, IPersistFileFormat,
IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, IVsFileBackup,
IServiceProvider
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type DocData =
class
inherit MarshalByRefObject
interface IVsPersistDocData2
interface IVsPersistDocData
interface IVsFileChangeEvents
interface IVsDocDataFileChangeControl
interface IPersistFileFormat
interface IPersist
interface IDisposable
interface IVsSaveOptionsDlg
interface IVsUserData
interface IVsFileBackup
interface IServiceProvider
end
public abstract class DocData extends MarshalByRefObject implements IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, IPersistFileFormat, IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, IVsFileBackup, IServiceProvider
The DocData type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
DocData | Initializes a new instance of the DocData class. |
Top
Properties
Name | Description | |
---|---|---|
![]() |
Cookie | Gets the cookie that identifies the document in the Running Documents table. |
![]() |
DocViews | Gets the collection of document views that are open for the document. |
![]() |
Encoding | Gets or sets the encoding that persists the document. |
![]() |
FileName | Gets the file name of the document. |
![]() |
FormatList | Gets a list of formats. |
![]() |
Hierarchy | Gets the project hierarchy to which the document belongs. |
![]() |
IsBackupFileObsolete | |
![]() |
IsLoaded | Gets the document and verifies whether it is loaded. |
![]() |
ItemId | Gets the Item ID that is assigned to the document. |
![]() |
ServiceProvider | Gets the service provider from the shell. |
![]() |
UndoManager | Gets the UndoManager interface for the document. |
![]() |
UndoManagerIsShared | Gets the document and verifies whether more than one document is sharing the same UndoManager interface. |
![]() |
VSUndoManager | Gets the UndoManager interface. |
Top
Methods
Name | Description | |
---|---|---|
![]() |
BackupFile | Make a single file backup of this document. Returns whether the document is expected to re-load without data loss. |
![]() |
CanSave | Verifies whether the user can cancel the save operation. |
![]() |
Close | Closes the document. |
![]() |
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.) |
![]() |
DirectoryChanged | Not currently implemented. |
![]() |
Dispose | Releases the unmanaged resources used by the DocData and optionally releases the managed resources. |
![]() |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() |
FilesChanged | Notifies clients that one or more documents changed. |
![]() |
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. |
![]() |
GetClassID | Gets the GUID of the editor factory that created the document. |
![]() |
GetCurFile | Gets the file name of the document. |
![]() |
GetData | Gets the document data from a buffer. |
![]() |
GetFormatList | Gets the list of supported document formats. |
![]() |
GetGuidEditorType | Gets the GUID of the editor factory that created the IVsPersistDocData object. |
![]() |
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.) |
![]() |
GetService | Return the requested service. |
![]() |
GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() |
HandleLoadDocDataException | Manages any exceptions that were thrown when the document was loading. |
![]() |
HandleSaveDocDataException | Manages any exceptions that were thrown when the document was saving. |
![]() |
IgnoreFileChanges | Determines whether changes to the document should be ignored. |
![]() |
InitializeLifetimeService | Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() |
InitNew | Initializes the document. |
![]() |
IsDirty | Verifies whether the document has changed since the most recent save operation. |
![]() |
IsDocDataDirty | Verifies whether the document has changed since the most recent save operation. |
![]() |
IsDocDataReadOnly | Verifies whether the document is read-only. |
![]() |
IsDocDataReloadable | Verifies whether the document can be reloaded. |
![]() |
Load(String, Boolean) | Loads the document into memory. |
![]() |
Load(String, UInt32, Int32) | Loads the document into memory. |
![]() |
LoadDocData(String) | Loads the document by using its file name. |
![]() |
LoadDocData(String, Boolean) | Loads the document by using its file name. |
![]() |
MarkDocumentChangedForBackup | Mark that the document has changed and thus a new backup should be created |
![]() |
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 | Alerts listeners that the document was closed. |
![]() |
OnDocumentClosing | Alerts listeners that the document will be closed. |
![]() |
OnDocumentLoaded | Alerts listeners that the document is loaded. |
![]() |
OnDocumentLoading | Alerts listeners that the document will be loaded. |
![]() |
OnDocumentReadOnlyChanged | Alerts listeners that the read-only state of the document has changed. |
![]() |
OnDocumentReloaded | Alerts listeners that the document has been reloaded. |
![]() |
OnDocumentReloading | Alerts listeners that the document will be reloaded. |
![]() |
OnDocumentSaved | Alerts listeners that the document has been saved. |
![]() |
OnDocumentSaving | Alerts listeners that the document will be saved. |
![]() |
OnFileNameChanged | Alerts listeners that the file name of the document has changed. |
![]() |
OnHierarchyChanged | Alerts listeners that the Item ID that is assigned to the document has changed. |
![]() |
OnRegisterDocData | Assigns the document to a cookie and project hierarchy. |
![]() |
OpenView | Opens a specific view for the document. |
![]() |
QueryEditFile() | Alerts listeners that a document is about to be edited. Listeners can vote against the edit. |
![]() |
QueryEditFile(String, tagVSQueryEditFlags) | Alerts listeners that a document is about to be edited. Listeners can vote against the edit. |
![]() |
QuerySaveFile() | Alerts listeners that a file is about to be saved. Listeners can |
![]() |
QuerySaveFile(String, tagVSQuerySaveFlags) | Alerts listeners that a file is about to be saved. |
![]() |
ReloadDocData | Reloads the document. |
![]() |
ReloadDocDataWorker | Reloads the document. |
![]() |
RenameDocData | Renames a document and resets its position in the hierarchy. |
![]() |
ResumeFileChangeNotification | Resumes the distribution of document-change notifications for the document. |
![]() |
Save(String) | Saves the document. |
![]() |
Save(String, Int32, UInt32) | Saves the document. |
![]() |
SaveCompleted | Alerts listeners that the document has been saved. |
![]() |
SaveDocData | Saves the document to a specific location. |
![]() |
SaveDocDataToFile | Saves the document to a specific location. |
![]() |
SaveSubordinateFile | Save the specified document that is subordinate to this document, for example a diagram file. |
![]() |
SetData | Sets the document to a buffer. |
![]() |
SetDocDataDirty | Sets the document's IsDirty flag. |
![]() |
SetDocDataReadOnly | Sets the document's read-only flag. |
![]() |
SetFileName | Initializes or changes the file name for the document. |
![]() |
SetHierarchyInfo | Initializes or changes the project hierarchy for the document. |
![]() |
SetUntitledDocPath | Currently not implemented. |
![]() |
ShowSaveOptionsDlg | Shows a dialog box from which the user can specify additional options for save formats. |
![]() |
SuspendFileChangeNotification | Suspends the distribution of document-change notifications for the document. |
![]() |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
Name | Description | |
---|---|---|
![]() |
DocumentClosed | Occurs after the document is closed. |
![]() |
DocumentClosing | Occurs before the document is closed. |
![]() |
DocumentLoaded | Occurs after the document has been loaded in the modeling window. |
![]() |
DocumentLoading | Occurs before the document is loaded in the modeling window. |
![]() |
DocumentReadOnlyChanged | Occurs when the read-only flag for the document changes. |
![]() |
DocumentReloaded | Occurs after the document is reloaded. |
![]() |
DocumentReloading | Occurs before the document is reloaded. |
![]() |
DocumentSaved | Occurs after the document is saved. |
![]() |
DocumentSaving | Occurs before the document is saved. |
![]() |
FileNameChanged | Occurs when the document's file name changes. |
![]() |
HierarchyChanged | Occurs when the document's hierarchy or Item ID changes. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() |
IVsFileBackup.BackupFile | Make a single file backup of this document. |
![]() ![]() |
IDisposable.Dispose | Releases all resources used by the current instance of the DocData class. |
![]() ![]() |
IPersistFileFormat.GetClassID | Gets the class ID of the editor factory that created the document. |
![]() ![]() |
IVsFileBackup.IsBackupFileObsolete | Get whether the backup file is up to date. |
Top
Remarks
This class also listens to change events for external documents and can prompt the user to reload the document.
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.