This documentation is archived and is not being maintained.

IOleInPlaceComponent Interface

Allows in-place VSPackage objects to operate as a fully integrated component of the environment by using the SOleComponentUIManager service.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

[GuidAttribute("5EFC7970-14BC-11CF-9B2B-00AA00573819")] 
[InterfaceTypeAttribute(1)] 
public interface IOleInPlaceComponent
/** @attribute GuidAttribute("5EFC7970-14BC-11CF-9B2B-00AA00573819") */ 
/** @attribute InterfaceTypeAttribute(1) */ 
public interface IOleInPlaceComponent
GuidAttribute("5EFC7970-14BC-11CF-9B2B-00AA00573819") 
InterfaceTypeAttribute(1) 
public interface IOleInPlaceComponent

The SOleComponentUIManager service is an alternative to the traditional OLE in-place activation. Rather than require the in-place object to participate in menu merging, this service integrates the menus, toolbars, and commands of the object into the environment and issues notifications of state changes. Allows in-place VSPackage objects to operate as a fully integrated component of the environment by using the SOleComponentUIManager service. The T:Microsoft.VisualStudio.Shell.Interop.SOleComponentUIManager service is an alternative to the traditional OLE in-place activation. Rather than require the in-place object to participate in menu merging, this service integrates the menus, toolbars, and commands of the object into the environment and issues notifications of state changes.

See illustrations of the implementation and/or calling of this interface in the sample Basic Edit Overview.

Notes to Implementers VSPackages implement IOleInPlaceComponent if they support an in-place object with UI elements that should be integrated into the environment's user interface. IOleInPlaceComponent is also implemented if the VSPackage wants to participate in handling the in-place object's commands when it activates. In-place VSPackage objects that implement IOleInPlaceComponent also implement IOleInPlaceObject, IOleInPlaceActiveObject and IOleCommandTarget. To initiate use of the SOleComponentUIManager services, an in-place object calls IOleInPlaceActiveObject when it activates.

Notes to Callers The environment's SOleComponentUIManager service makes calls to an in-place VSPackage object's IOleInPlaceComponent interface to communicate state changes and allow the object to handle commands. The environment calls an in-place object's QueryInterface method using the IOleInPlaceObject interface to receive an IOleInPlaceComponent pointer.

Show: