SubordinateDocData Class

  • Artigo

DocData object that represents a subordinate file in memory (represented as a child project item in the Solution Explorer).

This API is not CLS-compliant. 

Inheritance Hierarchy

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

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

Syntax

'Declaração
<CLSCompliantAttribute(False)> _
Public Class SubordinateDocData _
    Inherits DocData

[CLSCompliantAttribute(false)]
public class SubordinateDocData : DocData

[CLSCompliantAttribute(false)]
public ref class SubordinateDocData : public DocData

[<CLSCompliantAttribute(false)>]
type SubordinateDocData =  
    class
        inherit DocData
    end

public class SubordinateDocData extends DocData

The SubordinateDocData type exposes the following members.

Constructors

  Name Description
Public method SubordinateDocData Creates a SubordinateDocData instance.

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 FileName Gets the file name of the document. (Inherited from DocData.)
Protected property FormatList (Overrides DocData.FormatList.)
Public property Hierarchy Gets the project hierarchy to which the document belongs. (Inherited from DocData.)
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 ParentDocData Retrieves the parent DocData for this subordinate document.
Protected property ServiceProvider Gets the service provider from the shell. (Inherited from DocData.)
Public property UndoManager Gets the UndoManager interface for the document. (Inherited from DocData.)
Protected property UndoManagerIsShared Gets the document and verifies whether more than one document is sharing the same UndoManager interface. (Inherited from DocData.)
Public property VSUndoManager Gets the UndoManager interface. (Inherited from DocData.)

Top

Methods

  Name Description
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.)
Public method Close Closes the document. (Inherited from DocData.)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method DirectoryChanged Not currently implemented. (Inherited from DocData.)
Protected method Dispose Releases the unmanaged resources used by the DocData and optionally releases the managed resources. (Inherited from DocData.)
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. (Inherited from 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.)
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 Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetService Return the requested service. (Inherited from DocData.)
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 IgnoreFileChanges Determines whether changes to the document should be ignored. (Inherited from DocData.)
Public method InitializeLifetimeService 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 By default, the subordinate document is considered dirty if the parent is dirty. (Overrides DocData.IsDocDataDirty(Int32%).)
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 Load(String, Boolean) Subordinate files are assumed to have some "parent" DocData object that handles actual serialization, so Load operation is a no-op. (Overrides DocData.Load(String, Boolean).)
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 the document by using its file name. (Inherited from DocData.)
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 Alerts listeners that the document was closed. (Inherited from DocData.)
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 Alerts listeners that the Item ID that is assigned to the document has changed. (Inherited from DocData.)
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. (Inherited from DocData.)
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.)
Protected method ResumeFileChangeNotification Resumes the distribution of document-change notifications for the document. (Inherited from DocData.)
Protected method Save(String) Subordinate files are assumed to have some "parent" DocData object that usually handles actual serialization Save operation is a no-op except in the case of SaveAs. (Overrides DocData.Save(String).)
Public method Save(String, Int32, UInt32) Saves the document. (Inherited from DocData.)
Protected method SaveAs Save as the doc data to a file
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.)
Public method SetUntitledDocPath Currently not implemented. (Inherited from DocData.)
Public method ShowSaveOptionsDlg Shows a dialog box from which the user can specify additional options for save formats. (Inherited from DocData.)
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

Subordinate files are assumed to have some "parent" DocData object that handles actual serialization. This class exists so that the subordinate file can be registered in the VS Running Documents Table and tracked by the VS shell.

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