Skip to content

saving-a-custom-document.md

Latest commit

 

History

History
42 lines (29 loc) · 3.18 KB

saving-a-custom-document.md

File metadata and controls

42 lines (29 loc) · 3.18 KB
Raw
title Saving a Custom Document
description Learn about the process that occurs for a custom document for a project type that you add to the Visual Studio IDE.
ms.date 11/04/2016
ms.topic how-to
helpviewer_keywords
persistence, saving custom documents
projects [Visual Studio SDK], saving custom documents
editors [Visual Studio SDK], saving custom documents
author tinaschrepfer
ms.author tinali
ms.subservice extensibility-integration

Saving a Custom Document

The environment handles the Save, Save As, and Save All commands. When a user clicks Save, Save As, or Save All on the File menu or closes the solution, resulting in a Save All, the following process occurs.

Customer Editor Save

Save, Save As, and Save All command handling for a custom editor

This process is detailed in the following steps:

  1. For the Save and Save As commands, the environment uses the xref:Microsoft.VisualStudio.Shell.Interop.SVsShellMonitorSelection service to determine the active document window and thus what items should be saved. Once the active document window is known, the environment finds the hierarchy pointer and item identifier (itemID) for the document in the running document table. For more information, see Running Document Table.

    For the Save All command, the environment uses the information in the running document table to compile the list of all items to save.

  2. When the solution receives an xref:Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget.QueryStatus%2A call, it iterates through the set of selected items (that is, the multiple selections exposed by the xref:Microsoft.VisualStudio.Shell.Interop.SVsShellMonitorSelection service).

  3. On each item in the selection, the solution uses the hierarchy pointer to call the xref:Microsoft.VisualStudio.Shell.Interop.IVsPersistHierarchyItem2.IsItemDirty%2A method to determine whether the Save menu command should be enabled. If one or more items are dirty, then the Save command is enabled. If the hierarchy uses a standard editor, then the hierarchy delegates querying for dirty status to the editor by calling the xref:Microsoft.VisualStudio.Shell.Interop.IVsPersistDocData2.IsDocDataDirty%2A method.

  4. On each selected item that is dirty, the solution uses the hierarchy pointer to call the xref:Microsoft.VisualStudio.Shell.Interop.IVsPersistHierarchyItem2.SaveItem%2A method on the appropriate hierarchies.

    In the case of a custom editor, the communication between the document data object and the project is private. Thus, any special persistence concerns are handled between these two objects.

    [!NOTE] If you implement your own persistence, be sure to call the xref:Microsoft.VisualStudio.Shell.Interop.IVsQueryEditQuerySave2.QuerySaveFiles%2A method to save time. This method checks to make sure that it is safe to save the file (for example, the file is not read-only).

Related content