Determining Which Editor Opens a File in a Project

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

When a user opens a file in a project, the environment goes through a polling process, eventually opening the appropriate editor or designer for that file. The initial procedure employed by the environment is the same for both standard and custom editors. The environment uses a variety of criteria when polling which editor to use to open a file and the VSPackage must coordinate with the environment during this process.

For example, when a user selects the Open command from the File menu, and then chooses filename.rtf (or any other file with a .rtf extension), the environment calls the IsDocumentInProject implementation for each project, eventually cycling through all project instances in the solution. Projects return a set of flags that identify claims on a document by priority. Using the highest priority, the environment calls the appropriate OpenItem method. For further information on the polling process, Adding Project and Project Item Templates.

The Miscellaneous Files project claims all files that are not claimed by other projects. This way, custom editors can open documents before standard editors open them. If a Miscellaneous Files project claims a file, the environment calls the OpenStandardEditor method to open the file with a standard editor. The environment checks its internal list of registered editors for one that handles .rtf files. This list is located in the registry at the following key:

[HKEY_LOCAL_MACHINE\Software\Microsoft\VisualStudio\<version>\Editors\{<editor factory guid>}\Extensions]

The environment also checks the class identifiers in the HKEY_CLASSES_ROOT\CLSID key for any objects that have a sub-key DocObject. If the file extension is found there, an embedded version of the application, such as Microsoft Word, is created in-place in Visual Studio. These document objects must be compound files that implement the IPersistStorage interface, or the object must implement the IPersistFileFormat interface.

If there is no editor factory for .rtf files in the registry, then the environment looks in the HKEY_CLASSES_ROOT \.rtf key and opens the editor specified there. If the file extension is not found in HKEY_CLASSES_ROOT, then the environment uses the Visual Studio core text editor to open the file if it is a text file.

If the core text editor fails, which occurs if the file is not a text file, then the environment uses its binary editor for the file.

If the environment does find an editor for the .rtf extension in its registry, it loads the VSPackage that implements this editor factory. The environment calls the SetSite method on the new VSPackage. The VSPackage calls QueryService for SID_SVsRegistorEditor, using the RegisterEditor method to register the editor factory with the environment.

The environment now re-checks its internal list of registered editors to find the newly registered editor factory for .rtf files. The environment calls your implementation of the CreateEditorInstance method, passing in the file name and view type to create.

See Also

IPersistFileFormat
IPersistStorage
SetSite
IsDocumentInProject
OpenItem
OpenStandardEditor