IOleInPlaceSite interface

Manages the interaction between the container and the object's in-place client site. Recall that the client site is the display site for embedded objects, and provides position and conceptual information about the object.

This interface provides methods that manage in-place objects. With IOleInPlaceSite, you can determine if an object can be activated and manage its activation and deactivation. You can notify the container when one of its objects is being activated and inform the container that a composite menu will replace the container's regular menu. It provides methods that make it possible for the in-place object to retrieve the window object hierarchy, and the position in the parent window where the object should place its in-place activation window. Finally, it determines how the container scrolls the object, manages the object undo state, and notifies the object when its borders have changed.

When to implement

You must implement this interface if you are writing a container application that will participate in in-place activation.

When to use

This interface is not supported for use across computer boundaries.

Use this interface to allow your object to control in-place activation from within the container.

The IOleInPlaceSite interface pointer is obtained by calling IUnknown::QueryInterface on the object's IOleClientSite interface.

Members

The IOleInPlaceSite interface inherits from IOleWindow. IOleInPlaceSite also has these types of members:

Methods

The IOleInPlaceSite interface has these methods.

MethodDescription
CanInPlaceActivate

Determines whether the container can activate the object in place.

DeactivateAndUndo

Deactivates the object, ends the in-place session, and reverts to the container's saved undo state.

DiscardUndoState

Instructs the container to discard its undo state.

GetWindowContext

Enables an in-place object to retrieve the window interfaces that form the window object hierarchy, and the position in the parent window where the object's in-place activation window should be located.

OnInPlaceActivate

Notifies the container that one of its objects is being activated in place.

OnInPlaceDeactivate

Notifies the container that it should reinstall its user interface and take focus, and whether the object has an undoable state.

OnPosRectChange

Notifies the container that the object extents have changed.

OnUIActivate

Notifies the container that the object is about to be activated in place and that the object is going to replace the container's main menu with an in-place composite menu.

OnUIDeactivate

Notifies the container to reinstall its user interface and take focus.

Scroll

Instructs the container to scroll the view of the object by the specified number of pixels.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleIdl.h

IDL

OleIdl.Idl

IID

IID_IOleInPlaceSite is defined as 00000119-0000-0000-C000-000000000046

See also

IOleClientSite
IOleWindow

 

 

Community Additions

ADD
Show:
© 2014 Microsoft