SubordinateDocData Class

 

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

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

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

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

NameDescription
System_CAPS_pubmethodSubordinateDocData(IServiceProvider^, DocData^)

Creates a SubordinateDocData instance.

NameDescription
System_CAPS_pubpropertyCookie

Gets the cookie that identifies the document in the Running Documents table.(Inherited from DocData.)

System_CAPS_pubpropertyDocViews

Gets the collection of document views that are open for the document.(Inherited from DocData.)

System_CAPS_pubpropertyEncoding

Gets or sets the encoding that persists the document.(Inherited from DocData.)

System_CAPS_pubpropertyFileName

Gets the file name of the document.(Inherited from DocData.)

System_CAPS_protpropertyFormatList

(Overrides DocData::FormatList.)

System_CAPS_pubpropertyHierarchy

Gets the project hierarchy to which the document belongs.(Inherited from DocData.)

System_CAPS_protpropertyIsBackupFileObsolete

(Inherited from DocData.)

System_CAPS_pubpropertyIsLoaded

Gets the document and verifies whether it is loaded.(Inherited from DocData.)

System_CAPS_pubpropertyItemId

Gets the Item ID that is assigned to the document.(Inherited from DocData.)

System_CAPS_pubpropertyParentDocData

Retrieves the parent DocData for this subordinate document.

System_CAPS_protpropertyServiceProvider

Gets the service provider from the shell.(Inherited from DocData.)

System_CAPS_pubpropertyUndoManager

Gets the UndoManager interface for the document.(Inherited from DocData.)

System_CAPS_protpropertyUndoManagerIsShared

Gets the document and verifies whether more than one document is sharing the same UndoManager interface. (Inherited from DocData.)

System_CAPS_pubpropertyVSUndoManager

Gets the UndoManager interface.(Inherited from DocData.)

NameDescription
System_CAPS_protmethodBackupFile(String^)

Make a single file backup of this document. Returns whether the document is expected to re-load without data loss. (Inherited from DocData.)

System_CAPS_protmethodCanSave(Boolean)

Verifies whether the user can cancel the save operation.(Inherited from DocData.)

System_CAPS_pubmethodClose()

Closes the document.(Inherited from DocData.)

System_CAPS_pubmethodCreateObjRef(Type^)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDirectoryChanged(String^)

Not currently implemented.(Inherited from DocData.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the DocData and optionally releases the managed resources.(Inherited from DocData.)

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodFilesChanged(UInt32, array<String^>^, array<UInt32>^)

Notifies clients that one or more documents changed.(Inherited from DocData.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodFlushUndoManager()

Clears the UndoManager.(Inherited from DocData.)

System_CAPS_pubmethodGetClassID(Guid)

Gets the GUID of the editor factory that created the document.(Inherited from DocData.)

System_CAPS_pubmethodGetCurFile(String^, UInt32)

Gets the file name of the document.(Inherited from DocData.)

System_CAPS_pubmethodGetData(Guid, Object^)

Gets the document data from a buffer.(Inherited from DocData.)

System_CAPS_pubmethodGetFormatList(String^)

Gets the list of supported document formats.(Inherited from DocData.)

System_CAPS_pubmethodGetGuidEditorType(Guid)

Gets the GUID of the editor factory that created the IVsPersistDocData object.(Inherited from DocData.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetService(Type^)

Return the requested service.(Inherited from DocData.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodHandleLoadDocDataException(String^, Exception^, Boolean)

Manages any exceptions that were thrown when the document was loading.(Inherited from DocData.)

System_CAPS_protmethodHandleSaveDocDataException(String^, Exception^)

Manages any exceptions that were thrown when the document was saving.(Inherited from DocData.)

System_CAPS_pubmethodIgnoreFileChanges(Int32)

Determines whether changes to the document should be ignored.(Inherited from DocData.)

System_CAPS_pubmethodInitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodInitNew(UInt32)

Initializes the document.(Inherited from DocData.)

System_CAPS_pubmethodIsDirty(Int32)

Verifies whether the document has changed since the most recent save operation.(Inherited from DocData.)

System_CAPS_pubmethodIsDocDataDirty(Int32)

By default, the subordinate document is considered dirty if the parent is dirty.(Overrides DocData::IsDocDataDirty(Int32).)

System_CAPS_pubmethodIsDocDataReadOnly(Int32)

Verifies whether the document is read-only.(Inherited from DocData.)

System_CAPS_pubmethodIsDocDataReloadable(Int32)

Verifies whether the document can be reloaded.(Inherited from DocData.)

System_CAPS_protmethodLoad(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).)

System_CAPS_pubmethodLoad(String^, UInt32, Int32)

Loads the document into memory.(Inherited from DocData.)

System_CAPS_pubmethodLoadDocData(String^)

Loads the document by using its file name.(Inherited from DocData.)

System_CAPS_protmethodLoadDocData(String^, Boolean)

Loads the document by using its file name.(Inherited from DocData.)

System_CAPS_pubmethodMarkDocumentChangedForBackup()

Mark that the document has changed and thus a new backup should be created(Inherited from DocData.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnDocumentClosed(EventArgs^)

Alerts listeners that the document was closed.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentClosing(EventArgs^)

Alerts listeners that the document will be closed.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentLoaded(EventArgs^)

Alerts listeners that the document is loaded.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentLoading(EventArgs^)

Alerts listeners that the document will be loaded.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentReadOnlyChanged(EventArgs^)

Alerts listeners that the read-only state of the document has changed.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentReloaded(EventArgs^)

Alerts listeners that the document has been reloaded.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentReloading(EventArgs^)

Alerts listeners that the document will be reloaded.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentSaved(EventArgs^)

Alerts listeners that the document has been saved.(Inherited from DocData.)

System_CAPS_protmethodOnDocumentSaving(EventArgs^)

Alerts listeners that the document will be saved.(Inherited from DocData.)

System_CAPS_protmethodOnFileNameChanged(EventArgs^)

Alerts listeners that the file name of the document has changed.(Inherited from DocData.)

System_CAPS_protmethodOnHierarchyChanged(EventArgs^)

Alerts listeners that the Item ID that is assigned to the document has changed.(Inherited from DocData.)

System_CAPS_pubmethodOnRegisterDocData(UInt32, IVsHierarchy^, UInt32)

Assigns the document to a cookie and project hierarchy.(Inherited from DocData.)

System_CAPS_pubmethodOpenView(Guid, Object^)

Opens a specific view for the document.(Inherited from DocData.)

System_CAPS_pubmethodQueryEditFile()

Alerts listeners that a document is about to be edited. Listeners can vote against the edit.(Inherited from DocData.)

System_CAPS_pubmethodQueryEditFile(String^, tagVSQueryEditFlags)

Alerts listeners that a document is about to be edited. Listeners can vote against the edit.(Inherited from DocData.)

System_CAPS_pubmethodQuerySaveFile()

Alerts listeners that a file is about to be saved. Listeners can (Inherited from DocData.)

System_CAPS_pubmethodQuerySaveFile(String^, tagVSQuerySaveFlags)

Alerts listeners that a file is about to be saved.(Inherited from DocData.)

System_CAPS_pubmethodReloadDocData(UInt32)

Reloads the document.(Inherited from DocData.)

System_CAPS_protmethodReloadDocDataWorker(UInt32)

Reloads the document.(Inherited from DocData.)

System_CAPS_pubmethodRenameDocData(UInt32, IVsHierarchy^, UInt32, String^)

Renames a document and resets its position in the hierarchy.(Inherited from DocData.)

System_CAPS_protmethodResumeFileChangeNotification(String^)

Resumes the distribution of document-change notifications for the document.(Inherited from DocData.)

System_CAPS_protmethodSave(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^).)

System_CAPS_pubmethodSave(String^, Int32, UInt32)

Saves the document.(Inherited from DocData.)

System_CAPS_protmethodSaveAs(String^)

Save as the doc data to a file

System_CAPS_pubmethodSaveCompleted(String^)

Alerts listeners that the document has been saved.(Inherited from DocData.)

System_CAPS_pubmethodSaveDocData(VSSAVEFLAGS, String^, Int32)

Saves the document to a specific location.(Inherited from DocData.)

System_CAPS_protmethodSaveDocDataToFile(VSSAVEFLAGS, String^, Int32, IVsUIShell^)

Saves the document to a specific location.(Inherited from DocData.)

System_CAPS_protmethodSaveSubordinateFile(DocData^, String^)

Save the specified document that is subordinate to this document, for example a diagram file.(Inherited from DocData.)

System_CAPS_pubmethodSetData(Guid, Object^)

Sets the document to a buffer.(Inherited from DocData.)

System_CAPS_pubmethodSetDocDataDirty(Int32)

Sets the document's IsDirty flag.(Inherited from DocData.)

System_CAPS_pubmethodSetDocDataReadOnly(Int32)

Sets the document's read-only flag.(Inherited from DocData.)

System_CAPS_protmethodSetFileName(String^)

Initializes or changes the file name for the document.(Inherited from DocData.)

System_CAPS_protmethodSetHierarchyInfo(IVsHierarchy^, UInt32)

Initializes or changes the project hierarchy for the document.(Inherited from DocData.)

System_CAPS_pubmethodSetUntitledDocPath(String^)

Currently not implemented.(Inherited from DocData.)

System_CAPS_pubmethodShowSaveOptionsDlg(UInt32, IntPtr, IntPtr)

Shows a dialog box from which the user can specify additional options for save formats.(Inherited from DocData.)

System_CAPS_protmethodSuspendFileChangeNotification(String^)

Suspends the distribution of document-change notifications for the document.(Inherited from DocData.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDocumentClosed

Occurs after the document is closed.(Inherited from DocData.)

System_CAPS_pubeventDocumentClosing

Occurs before the document is closed.(Inherited from DocData.)

System_CAPS_pubeventDocumentLoaded

Occurs after the document has been loaded in the modeling window.(Inherited from DocData.)

System_CAPS_pubeventDocumentLoading

Occurs before the document is loaded in the modeling window.(Inherited from DocData.)

System_CAPS_pubeventDocumentReadOnlyChanged

Occurs when the read-only flag for the document changes.(Inherited from DocData.)

System_CAPS_pubeventDocumentReloaded

Occurs after the document is reloaded.(Inherited from DocData.)

System_CAPS_pubeventDocumentReloading

Occurs before the document is reloaded.(Inherited from DocData.)

System_CAPS_pubeventDocumentSaved

Occurs after the document is saved.(Inherited from DocData.)

System_CAPS_pubeventDocumentSaving

Occurs before the document is saved.(Inherited from DocData.)

System_CAPS_pubeventFileNameChanged

Occurs when the document's file name changes.(Inherited from DocData.)

System_CAPS_pubeventHierarchyChanged

Occurs when the document's hierarchy or Item ID changes.(Inherited from DocData.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIPersistFileFormat::GetClassID(Guid)

Gets the class ID of the editor factory that created the document. (Inherited from DocData.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsFileBackup::BackupFile(String^)

Make a single file backup of this document.(Inherited from DocData.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsFileBackup::IsBackupFileObsolete(Int32)

Get whether the backup file is up to date.(Inherited from DocData.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable::Dispose()

Releases all resources used by the current instance of the DocData class.(Inherited from DocData.)

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: