Project Model Core Components
The following tables expand on the project model. The tables present brief descriptions of the interfaces and services identified in the model, and the interfaces and services associated with specific objects. Additionally, the tables detail other interfaces that are optional in project creation and maintenance depending on the requirements of your specific project type.
For more information, see Supporting Symbol-Browsing Tools.
Package object
Interface |
Comments |
|---|---|
Initializes a VSPackage in the IDE and makes its services available to the IDE. |
Project Factory object
Interface |
Comments |
|---|---|
Manages creating new projects and opening existing projects. |
Project objects
Interfaces |
Comments |
|---|---|
Manages the addition and removal of project items, opens editors, and maintains mapping between each document moniker and the VSITEMID. Inherits from IVsProject and IVsProject2. |
|
Manages navigation and display properties and provides events. |
|
Enables command execution similar to that of IOleCommandTarget for commands such as Cut and Rename that apply only when the focus is in Solution Explorer. |
|
Serves as the primary command target interface for a project hierarchy. It is the standard interface for querying objects for their command status or state and running commands. Available when you are not focused in the Project window. |
|
Coordinates the persistence of the project state. Typically, the project state is stored as a project file but can be adapted to storage systems that are not file-based. |
|
Enables the project to manage all aspects of persistence for its project items, either as files on disk or objects in other storage systems. The IVsPeristHierarchyItem2 interface is used for items that do not implement the IVsPersistDocData2 interface. |
|
Coordinates interactions with source code control. |
|
Enables projects to manage configuration information. |
|
Manages project configuration objects, such as Debug/Release configurations. Build, deploy, and debug operations are coordinated through project configuration objects. |
|
Implemented by hierarchies to control the delete (destructive) or remove (non-destructive) options for hierarchy items. Call Query Interface on the IVsHierarchyDeleteHandler interface from the IVsHierarchy interface. |
|
Provides the implementation option of having the object that supports the IVsCfgProvider2 interface on a different COM identity than the project object that implements the IVsHierarchy interface. |
|
Optional interface implemented to make your project extensible by other developers. The IVsProjectStartupServices interface enables a third-party VSPackage to register a GUID that you persist into your project file so that every time your project loads, you load the third-party service GUID into your project file and call QueryService for that GUID. |
|
Implemented by source hierarchies in a UIHierarchy window to coordinate clipboard operations such as cut, copy, and paste. Use the AdviseClipboardHelperEvents interface to register clipboard events. |
|
Provides information about a dragged item relative to its data source during a drag-and-drop operation in a UI hierarchy window. Called from the IVsHierarchy interface. |
|
Provides information about a dragged item relative to its drop target during a drag-and-drop operation in a UI hierarchy window. Called from the IVsHierarchy interface. |
Configuration object
Interfaces |
Comments |
|---|---|
Provides information about a configuration. |
|
Enables projects to manage configuration information. |
|
Enables a project to be run under the control of the debugger. |
|
Implemented by deployment projects that perform deployment operations for other projects. |
Configuration Builder object
Interfaces |
Comments |
|---|---|
Manages a project configuration's build operation. |
Additional Project objects
Interfaces |
Comments |
|---|---|
IDispatch |
Displays item properties in the Properties window. |
Displays outputs for deployment. |
The following table presents brief descriptions of the services identified in the project model.
Services
Service |
Comments |
|---|---|
Used by VSPackages that implement project types to register that their project factory exists with the IDE. Your VSPackage must call QueryService for this service and register its project factory when IVsPackage::SetSite method is called. If the SetSite method is not called, your project is not instantiated. |
|
Provides access to the IDE's internal, built-in notion of the current solution, such as the ability to enumerate projects, create new projects, take notice of project changes, and so on. |
|
Called by projects that wish to participate in source control. |
|
Maintains a table of open documents to determine whether one or more of your project items are already opened. |
|
Contains the interfaces and methods called to actually open a project item using the standard editor or a specific editor. |
|
Required to be called by all projects when they add, remove or rename their items. |
|
Manages changes to a file or directory and notifies clients when selected files have been changed on disk. |
|
Required to be called by all projects and editors before they dirty items or save them. |
|
Manages the order of build and deployment operations for project configurations. |
|
Provides access to low-level debugger services used for most debugging controls. |
|
Enables VSPackages access to information about current selections and enables communication with the Properties window. |
|
Provides basic UI-related IDE functionality, such as the ability to create and enumerate tool windows or document windows or to report an error to the user. |
|
Provides access to the IDE's status bar. |
|
Used to implement the automation model. In your project model, you will return a properties object that lets you creates an instance of that object. |
|
Used to implement clipboard events on the project object in the hierarchy. SVsUIHierWinClipboardHelper lets you correctly handle cut, copy, and paste operations. |
See Also
Reference
Concepts
Checklist: Creating New Project Types
Supporting Symbol-Browsing Tools