IOleInPlaceComponentUIManager Interface

Enables the menus, toolbars, and commands of existing VSPackage objects to be integrated into and managed by the environment's SOleComponentUIManager service.

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

Syntax

'Declaration
<GuidAttribute("5EFC7973-14BC-11CF-9B2B-00AA00573819")> _
<InterfaceTypeAttribute()> _
Public Interface IOleInPlaceComponentUIManager
[GuidAttribute("5EFC7973-14BC-11CF-9B2B-00AA00573819")]
[InterfaceTypeAttribute()]
public interface IOleInPlaceComponentUIManager
[GuidAttribute(L"5EFC7973-14BC-11CF-9B2B-00AA00573819")]
[InterfaceTypeAttribute()]
public interface class IOleInPlaceComponentUIManager
[<GuidAttribute("5EFC7973-14BC-11CF-9B2B-00AA00573819")>]
[<InterfaceTypeAttribute()>]
type IOleInPlaceComponentUIManager =  interface end
public interface IOleInPlaceComponentUIManager

The IOleInPlaceComponentUIManager type exposes the following members.

Methods

  Name Description
Public method FContinueIdle Queries the environment to determine if an in-place active object can continue idle time processing.
Public method FOnUIComponentExitState Queries the environment to determine if an in-place VSPackage object remains in a particular state.
Public method FUIComponentInState Queries the environment to determine if a particular state is still in effect.
Public method OnUIComponentEnterState Informs the environment that an in-place VSPackage object has entered a new state.
Public method SetActiveUI Allows a UI active VSPackage object to change the menus, toolbars, or commands that are displayed on its behalf by the environment.
Public method UIActivateForMe Requests that the SOleComponentUIManager service participate in the activation or deactivation of an in-place VSPackage object.
Public method UpdateUI Informs the environment that the state of an in-place VSPackage object's visible user interface has changed.

Top

Remarks

IOleInPlaceComponentUIManager is one of two interfaces provided by this service; the other is IOleComponentUIManager. Enables the menus, toolbars, and commands of existing VSPackage objects to be integrated into and managed by the environment's SOleComponentUIManager service. IOleInPlaceComponentUIManager is one of two interfaces provided by this service; the other is IOleComponentUIManager.

In-place VSPackage objects typically access IOleInPlaceComponentUIManager by calling QueryService and requesting SIID_SOleComponentUIManager on their in-place site. Subcomponents typically delegate this call to the IServiceProvider implementation on their site.

See illustrations of the implementation and/or calling of this interface in the samples Basic Edit Sampleand Solution Extender.

Notes to Implementers

The environment implements IOleInPlaceComponentUIManager as part of its SOleComponentUIManager service.

Notes to Callers

In-place VSPackage objects call the methods of IOleInPlaceComponentUIManager to request the use of the SOleComponentUIManager service and to communicate state information.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace