IVsSolutionEvents2 Interface
TOC
Collapse the table of content
Expand the table of content

IVsSolutionEvents2 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(1)]
[GuidAttribute("A711DF67-B00A-4E82-A990-51B2B450EA0F")]
public interface IVsSolutionEvents2 : IVsSolutionEvents

NameDescription
System_CAPS_pubmethodOnAfterCloseSolution(Object)

Notifies listening clients that a solution has been closed.

System_CAPS_pubmethodOnAfterLoadProject(IVsHierarchy, IVsHierarchy)

Notifies listening clients that the project has been loaded.

System_CAPS_pubmethodOnAfterMergeSolution(Object)

Notifies listening clients that all projects have been merged into the open solution.

System_CAPS_pubmethodOnAfterOpenProject(IVsHierarchy, Int32)

Notifies listening clients that the project has been opened.

System_CAPS_pubmethodOnAfterOpenSolution(Object, Int32)

Notifies listening clients that the solution has been opened.

System_CAPS_pubmethodOnBeforeCloseProject(IVsHierarchy, Int32)

Notifies listening clients that the project is about to be closed.

System_CAPS_pubmethodOnBeforeCloseSolution(Object)

Notifies listening clients that the solution is about to be closed.

System_CAPS_pubmethodOnBeforeUnloadProject(IVsHierarchy, IVsHierarchy)

Notifies listening clients that the project is about to be unloaded.

System_CAPS_pubmethodOnQueryCloseProject(IVsHierarchy, Int32, Int32)

Queries listening clients as to whether the project can be closed.

System_CAPS_pubmethodOnQueryCloseSolution(Object, Int32)

Queries listening clients as to whether the solution can be closed.

System_CAPS_pubmethodOnQueryUnloadProject(IVsHierarchy, Int32)

Queries listening clients as to whether the project can be unloaded.

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.

IVsSolutionEvents2 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 IVsSolutionEvents2 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.

Return to top
Show:
© 2016 Microsoft