BaseDocData Members

  • Article

Include Protected Members
Include Inherited Members

The base class for all the document data.

The BaseDocData type exposes the following members.

Constructors

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

Top

Methods

  Name Description
Protected method AdviseFileChange Subscribes or unsubscribes for notification on file changes, as specified.
Public method BackupFile Persists the data to a single file.
Public method Dispose Overloaded. Disposes of managed and unmanaged resources.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetNewAndUnsaved Returns whether the property on the node item is new and unsaved.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsBackupFileObsolete Sets or clears the backup dirty flag.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method NotifyDocChanged Sends a notification that the document has changed through the running document table.
Protected method OnClose Raises the Closing event and then deletes the file if it was a new, temporary file.
Protected method OnClosing Raises the Closing event, which indicates the document is being closed.
Protected method OnDirectoryChanged Does nothing.
Protected method OnFileChanged Raises the FileChanged event, which indicates that the file has changed.
Protected method OnFilesChanged Raises the FileChanged event for each open file changed.
Protected method OnGetClassID Called to obtain the class ID.
Protected method OnGetCurFile Called to get current file information.
Protected method OnGetFormatList Called to get the format list.
Protected method OnGetGuidEditorType Called to get the editor type GUID.
Protected method OnHandleRegisterDocData Handles the IVsPersistDocData.OnReigsterDocData call, so derived classes can override it.
Protected method OnIgnoreFileChanges Called by the shell to notify whether a file change must be ignored.
Protected method OnInitNew Called on new document initialization.
Protected method OnIsDirty Called to get whether document data is dirty.
Protected method OnIsDocDataDirty Called to get whether document data is dirty.
Protected method OnIsDocDataReloadable Called to get whether document data is reloadable.
Protected method OnLoad Called when loading a file.
Protected method OnLoadDocData Called when loading document data.
Protected method OnLoaded Raises the Loaded event, which indicates the file has been loaded.
Protected method OnLoadHelper Helps the load action.
Protected method OnReloadDocData Called on reloading the document data.
Protected method OnRenameDocData Renames the document data.
Protected method OnSave Called when the document is saving.
Protected method OnSaveCompleted Called when save is completed.
Protected method OnSaved Raises the Saved event, which indicates the file has been saved.
Protected method OnSaveDocData Called when the file is to be saved.
Protected method OnSaveFinished Raises the SaveFinished event, which indicates the save process has completed.
Protected method OnSaveHelper Helps during the save action.
Protected method OnSetUntitledDocPath Called to set the untitled document path.
Public method SetNewAndUnsaved Sets the property on the node item that specifies whether it is unsaved and new.
Public method ToString Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

  Name Description
Protected property Cookie Gets the cookie we were registered with.
Public property Dirty Gets or sets whether this data is dirty.
Protected property DocExtension Gets the document extension.
Protected property DocGuid Gets the document GUID.
Public property FileName Gets or sets the name of the file.
Public property FileReloading Gets or sets whether the file is loading.
Protected property IsDocSaved Gets or sets the flag indicating the document has been saved.
Public property OwningHierarchy Gets the hierarchy that owns this document.
Public property OwningItemId Gets the item id of this document.
Public property UntitledPath Gets or sets the path for new, untitled documents.

Top

Events

  Name Description
Public event Closing Represents the document closing.
Public event FileChanged Represents the file having changed.
Public event Loaded Represents the document having loaded.
Public event Saved Represents the document having been saved.
Public event SaveFinished Represents the save action having finished.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsPersistDocData.Close
Explicit interface implemetationPrivate method IVsFileChangeEvents.DirectoryChanged
Explicit interface implemetationPrivate method IVsFileChangeEvents.FilesChanged
Explicit interface implemetationPrivate method IPersist.GetClassID
Explicit interface implemetationPrivate method IPersistFileFormat.GetClassID
Explicit interface implemetationPrivate method IPersistFileFormat.GetCurFile
Explicit interface implemetationPrivate method IPersistFileFormat.GetFormatList
Explicit interface implemetationPrivate method IVsPersistDocData.GetGuidEditorType
Explicit interface implemetationPrivate method IVsDocDataFileChangeControl.IgnoreFileChanges
Explicit interface implemetationPrivate method IPersistFileFormat.InitNew
Explicit interface implemetationPrivate method IPersistFileFormat.IsDirty
Explicit interface implemetationPrivate method IVsPersistDocData.IsDocDataDirty
Explicit interface implemetationPrivate method IVsPersistDocData.IsDocDataReloadable
Explicit interface implemetationPrivate method IPersistFileFormat.Load
Explicit interface implemetationPrivate method IVsPersistDocData.LoadDocData
Explicit interface implemetationPrivate method IVsPersistDocData.OnRegisterDocData
Explicit interface implemetationPrivate method IVsPersistDocData.ReloadDocData
Explicit interface implemetationPrivate method IVsPersistDocData.RenameDocData
Explicit interface implemetationPrivate method IPersistFileFormat.Save
Explicit interface implemetationPrivate method IPersistFileFormat.SaveCompleted
Explicit interface implemetationPrivate method IVsPersistDocData.SaveDocData
Explicit interface implemetationPrivate method IVsPersistDocData.SetUntitledDocPath

Top

See Also

Reference

BaseDocData Class

Microsoft.VisualStudio.Data.Schema.Project.Common.UI Namespace