This documentation is archived and is not being maintained.

IVsSolutionEvents3 Interface

Listening interface that monitors any notifications of changes to the solution.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

[InterfaceTypeAttribute()]
[GuidAttribute("F1DE2D75-3B95-4510-9B2B-565BC0E38877")]
public interface IVsSolutionEvents3 : IVsSolutionEvents2

The IVsSolutionEvents3 type exposes the following members.

  NameDescription
Public methodOnAfterCloseSolutionNotifies listening clients that a solution has been closed.
Public methodOnAfterClosingChildrenFired after closing all nested projects owned by a parent hierarchy.
Public methodOnAfterLoadProjectNotifies listening clients that the project has been loaded.
Public methodOnAfterMergeSolutionNotifies listening clients that all projects have been merged into the open solution.
Public methodOnAfterOpeningChildrenFired after opening all nested projects owned by a parent hierarchy.
Public methodOnAfterOpenProjectNotifies listening clients that the project has been opened.
Public methodOnAfterOpenSolutionNotifies listening clients that the solution has been opened.
Public methodOnBeforeCloseProjectNotifies listening clients that the project is about to be closed.
Public methodOnBeforeCloseSolutionNotifies listening clients that the solution is about to be closed.
Public methodOnBeforeClosingChildrenFired before closing all nested projects owned by a parent hierarchy.
Public methodOnBeforeOpeningChildrenFired before opening all nested projects owned by a parent hierarchy.
Public methodOnBeforeUnloadProjectNotifies listening clients that the project is about to be unloaded.
Public methodOnQueryCloseProjectQueries listening clients as to whether the project can be closed.
Public methodOnQueryCloseSolutionQueries listening clients as to whether the solution can be closed.
Public methodOnQueryUnloadProjectQueries listening clients as to whether the project can be unloaded.
Top

This interface is implemented to track the opening, closing, loading, and unloading of a solution or project of a solution. There are fundamental differences between opening and closing and loading and unloading solutions or projects. For example, when a project is added to the solution, it is both "open" and "loaded" and it is available for all users to access. However, a user can "unload" the project, which then removes it from the solution only for that user. Another user can open the same solution and have that project "loaded." In other words, loading and unloading are user-specific and unloading a project does not remove it from the solution.

If the project cited in this example is "closed" by a user, then that project is effectively removed from the solution altogether, rendering it unavailable to subsequent users of the solution. This same example can be applied at the solution level.

IVsSolutionEvents3 contains methods that are implemented by parent projects containing children (nested) projects. It is implemented in conjunction with IVsParentProject.

You can also query SVsSolution for IVsSolution, Then call AdviseSolutionEvents to get a pointer to IVsSolutionEvents3 if you have a project that needs to listen to solution events.

Notes to Implementers

VSPackages implement this interface to receive notification of events affecting solution status.

Show: